鸿蒙中 @ohos.file.fs 和 @ohos.fileio 模块使用

本文同步发表于我的微信公众号，微信搜索 程语新视界 即可关注，每个工作日都有文章更新

一、核心API与功能

1. 文件路径获取

• UIAbilityContext 获取沙箱路径 通过应用上下文获取不同用途的沙箱路径（如缓存文件存储等）：

import common from '@ohos.app.ability.common';

// 获取应用文件目录路径
let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir;       // /data/storage/el2/base/files
let cacheDir = context.cacheDir;       // /data/storage/el2/base/cache
let tempDir = context.tempDir;         // /data/storage/el2/base/temp

• 路径类型：
  • bundleCodeDir：应用安装包路径（只读）。
  • databaseDir：数据库文件路径。
  • distributedFilesDir：分布式文件路径 。

2. 基础文件操作

API	功能	同步/异步	示例场景
accessSync	检查文件是否存在	同步	判断文件是否可读写
openSync	打开文件	同步	创建或读写文件
readSync	读取文件内容	同步	读取文本或二进制数据
writeSync	写入文件内容	同步	保存用户数据
closeSync	关闭文件	同步	释放文件描述符
statSync	获取文件属性（大小时间）	同步	显示文件信息
unlinkSync	删除文件	同步	清理临时文件
mkdirSync	创建目录	同步	建立分类存储目录

二、完整示例代码

1. 创建并读写文件

import fileIo from '@ohos.fileio';
import buffer from '@ohos.buffer';

// 写入文件
let filePath = `${filesDir}/test.txt`;
let fd = fileIo.openSync(filePath, fileIo.OpenMode.CREATE | fileIo.OpenMode.READ_WRITE);
fileIo.writeSync(fd, buffer.from('Hello HarmonyOS').buffer);  // 写入Buffer数据
fileIo.closeSync(fd);

// 读取文件
let readBuffer = new ArrayBuffer(1024);
let readLen = fileIo.readSync(fd, readBuffer, { offset: 0 });
console.log('文件内容:', buffer.from(readBuffer, 0, readLen).toString());

 2. 处理GBK编码文件

import util from '@ohos.util';

// GBK编码转换
let gbkEncoder = new util.TextEncoder('gbk');
let gbkData = gbkEncoder.encodeInto('中文内容');
fileIo.writeSync(fd, gbkData.buffer);  // 写入GBK格式

3. 文件属性与目录操作

// 获取文件属性
let fileStat = fileIo.statSync(filePath);
console.log('文件大小:', fileStat.size);
console.log('修改时间:', new Date(fileStat.mtime * 1000));

// 创建多级目录
let dirPath = `${filesDir}/docs/images`;
fileIo.mkdirSync(dirPath, { recursive: true });  // recursive支持多级创建

三、高级功能

1. 异步文件操作

使用Promise封装异步读写：

async function asyncWriteFile(path: string, data: string) {
  let fd = await fileIo.open(path, fileIo.OpenMode.CREATE | fileIo.OpenMode.READ_WRITE);
  await fileIo.write(fd, buffer.from(data).buffer);
  await fileIo.close(fd);
}

2. 文件选择器

通过系统弹窗选择文件：

import picker from '@ohos.file.picker';

let documentPicker = new picker.DocumentViewPicker();
documentPicker.select().then((uriList) => {
  console.log('选中文件URI:', uriList[0]);
});

四注意事项

1. 权限配置： 在module.json5中声明所需权限：

   {
     "requestPermissions": [
       { "name": "ohos.permission.READ_USER_STORAGE" },
       { "name": "ohos.permission.WRITE_USER_STORAGE" }
     ]
   }

2. 沙箱隔离： 应用只能访问自身沙箱目录，跨应用需使用FilePicker或分布式文件接口 。
3. 性能优化：
   • 大文件操作建议使用流式读写（如createStream）。
   • 频繁读写时复用文件描述符。

五、错误处理

try {
  fileIo.accessSync('/invalid/path');
} catch (err) {
  console.error('文件访问错误:', err.code);  // 错误码如ENOENT（文件不存在）
}