鸿蒙三方库 | harmony-utils之FileUtil应用目录路径获取详解

SansanDoris

54人浏览 · 2026-07-17 17:35:18

SansanDoris · 2026-07-17 17:35:18 发布

前言

应用文件管理的基础是获取各种目录路径，如缓存目录、文件目录、临时目录等。@pura/harmony-utils 的 FileUtil 封装了应用目录路径获取方法，开发者无需了解复杂的路径规则，即可获取所需目录。本文将从API说明、代码实战、进阶用法、常见问题等多个维度进行全面讲解，帮助开发者快速掌握并应用到实际项目中。

在这里插入图片描述

一、FileUtil路径核心API

FileUtil 提供了以下应用目录路径获取方法：

方法	说明	返回类型	使用场景
`getCacheDir()`	获取缓存目录	string	缓存文件存储
`getFilesDir()`	获取文件目录	string	持久化文件存储
`getTempDir()`	获取临时目录	string	临时文件存储
`getDistributedFilesDir()`	获取分布式文件目录	string	分布式文件同步
`getPreferencesDir()`	获取首选项目录	string	偏好设置存储

1.1 核心特性

简洁易用：封装复杂API为一行调用，降低使用门槛
类型安全：完整的TypeScript类型定义，编译期即可发现错误
异常处理：内置异常捕获机制，避免运行时崩溃
路径全面：覆盖应用所有常用目录

1.2 目录用途对照

目录	用途	数据持久性	系统清理
缓存目录	临时缓存文件	可被系统清理	是
文件目录	应用私有文件	持久保存	否
临时目录	临时处理文件	可被系统清理	是
分布式目录	跨设备同步文件	持久保存	否
首选项目录	偏好设置数据	持久保存	否

二、完整使用步骤

2.1 安装依赖

ohpm install @pura/harmony-utils

2.2 获取应用目录

import { FileUtil } from '@pura/harmony-utils';

Button('获取缓存目录')
  .width('100%')
  .onClick(() => {
    try {
      let cacheDir = FileUtil.getCacheDir();
      this.result = `缓存目录:\n${cacheDir}`;
    } catch (e) {
      this.result = '异常: ' + e;
    }
  })

Button('获取文件目录')
  .width('100%')
  .onClick(() => {
    try {
      let filesDir = FileUtil.getFilesDir();
      this.result = `文件目录:\n${filesDir}`;
    } catch (e) {
      this.result = '异常: ' + e;
    }
  })

2.3 获取全部目录

Button('获取全部目录')
  .width('100%')
  .onClick(() => {
    try {
      let cache = FileUtil.getCacheDir();
      let files = FileUtil.getFilesDir();
      let temp = FileUtil.getTempDir();
      let dist = FileUtil.getDistributedFilesDir();
      let pref = FileUtil.getPreferencesDir();
      this.result = `缓存: ${cache}\n文件: ${files}\n临时: ${temp}\n分布式: ${dist}\n偏好: ${pref}`;
    } catch (e) {
      this.result = '异常: ' + e;
    }
  })

在这里插入图片描述

三、完整页面示例

import { FileUtil } from '@pura/harmony-utils';

@Entry
@Component
struct FilePathDemo {
  @State result: string = '';

  build() {
    Column({ space: 12 }) {
      Button('获取全部目录').width('100%').onClick(() => {
        try {
          let cache = FileUtil.getCacheDir();
          let files = FileUtil.getFilesDir();
          let temp = FileUtil.getTempDir();
          this.result = `缓存: ${cache}\n文件: ${files}\n临时: ${temp}`;
        } catch (e) { this.result = '异常: ' + e; }
      });
      Text(this.result).fontSize(14).fontColor('#333333')
    }
    .padding(16)
  }
}

四、进阶用法

4.1 目录路径拼接

import { FileUtil } from '@pura/harmony-utils';

function getDataFilePath(filename: string): string {
  return FileUtil.getFilesDir() + '/' + filename;
}

function getCacheFilePath(filename: string): string {
  return FileUtil.getCacheDir() + '/' + filename;
}

4.2 存储空间管理

function getStorageInfo(): Record<string, string> {
  return {
    cacheDir: FileUtil.getCacheDir(),
    filesDir: FileUtil.getFilesDir(),
    tempDir: FileUtil.getTempDir()
  };
}