HarmonyOS：应用文件访问(ArkTS)

一、概述

应用需要对应用文件目录下的应用文件进行查看、创建、读写、删除、移动、复制、获取属性等访问操作，下文介绍具体方法。

二、接口说明

开发者通过基础文件操作接口（ohos.file.fs）实现应用文件访问能力，主要功能如下表所示。

表1 基础文件操作接口功能，其中“√”表示支持，“-”表示不区分同步和异步。

接口名	功能	接口类型	支持同步	支持异步
access	检查文件是否存在	方法	√	√
close	关闭文件	方法	√	√
copyFile	复制文件	方法	√	√
createStream	基于文件路径打开文件流	方法	√	√
listFile	列出文件夹下所有文件名	方法	√	√
mkdir	创建目录	方法	√	√
moveFile	移动文件	方法	√	√
open	打开文件	方法	√	√
read	从文件读取数据	方法	√	√
rename	重命名文件或文件夹	方法	√	√
rmdir	删除整个目录	方法	√	√
stat	获取文件详细属性信息	方法	√	√
unlink	删除单个文件	方法	√	√
write	将数据写入文件	方法	√	√
Stream.close	关闭文件流	方法	√	√
Stream.flush	刷新文件流	方法	√	√
Stream.write	将数据写入流文件	方法	√	√
Stream.read	从流文件读取数据	方法	√	√
File.fd	获取文件描述符	属性	-	-
OpenMode	设置文件打开标签	属性	-	-
Filter	设置文件过滤配置项	类型	-	-

注意
使用基础文件操作接口时，耗时较长的操作，例如：read、write等，建议使用异步接口，避免应用崩溃。

三、开发示例

在对应用文件开始访问前，开发者需要获取应用文件路径。以从UIAbilityContext获取HAP级别的文件路径为例进行说明。

3.1 新建并读写一个文件

示例效果图

示例代码

import {
   
    fileIo as fs, ReadOptions } from '@kit.CoreFileKit';
import {
   
    common } from '@kit.AbilityKit';
import {
   
    buffer } from '@kit.ArkTS';


// 获取应用文件路径
let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir;

function createFile(): void {
   
   
  console.log("filesDir 路径：", filesDir)
  // 文件不存在时创建并打开文件，文件存在时打开文件
  let file = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
  // 写入一段内容至文件
  let writeLen = fs.writeSync(file.fd, "应用文件访问(ArkTS)");
  console.info("内容长度: " + writeLen);
  // 创建一个大小为1024字节的ArrayBuffer对象，用于存储从文件中读取的数据
  let arrayBuffer = new ArrayBuffer(1024);
  // 设置读取的偏移量和长度
  let readOptions: ReadOptions = {
   
   
    offset: 0,
    length: arrayBuffer.byteLength
  };
  // 读取文件内容到ArrayBuffer对象中，并返回实际读取的字节数
  let readLen = fs.readSync(file.fd, arrayBuffer, readOptions);
  // 将ArrayBuffer对象转换为Buffer对象，并转换为字符串输出
  let buf = buffer.from(arrayBuffer, 0, readLen);
  console.info(`从 ${
   
   file.name} 文件读取的内容是：${
   
   buf.toString()}`);
  // 关闭文件
  fs.closeSync(file);
}

3.2 读取文件内容并写入到另一个文件

示例效果图

示例代码

import {
   
    fileIo as fs, ReadOptions, WriteOptions } from '@kit.CoreFileKit';
import {
   
    common } from '@kit.AbilityKit';
import {
   
    buffer } from '@kit.ArkTS';


// 获取应用文件路径
let context = getContext(this) as common.UIAbilityContext;
let filesDir = context.filesDir;

function readWriteFile(): void {
   
   
  // 打开文件
  let srcFile = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
  let destFile = fs.openSync(filesDir + '/destFile.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
  // 读取源文件内容并写入至目的文件
  let bufSize = 4096;
  let readSize = 0;
  let buf = new ArrayBuffer(bufSize);
  let readOptions: ReadOptions = {
   
   
    offset: readSize,
    length: bufSize
  };
  let readLen = fs.readSync(srcFile.fd, buf, readOptions);
  while (readLen > 0) {
   
   
    readSize += readLen;
    let writeOptions: WriteOptions = {
   
   
      length: readLen
    };
    fs.writeSync(destFile.fd, buf, writeOptions);
    readOptions.offset = readSize;
    readLen = fs.readSync(srcFile.fd, buf, readOptions);
    console.log("读取文件内容并写入到另一个文件 结束")
  }
  // 关闭文件
  fs.closeSync(srcFile);