基于ArkTS语言的OpenHarmony APP应用开发：文件操作原创

福州市凌睿智捷电子有限公司

发布于 2024-9-20 16:52

浏览

1收藏

1、程序介绍

本示例主要展示了文件操作相关的功能，实现了打开文件、关闭文件、写入和读取、压缩和解压文件等功能。

本案例已在OpenHarmony凌蒙派-RK3568开发板验证通过，具体代码可参考：https://gitee.com/Lockzhiner-Electronics/lockzhiner-rk3568-openharmony/tree/master/samples/d10_FileOperator#ui

API版本：9

2、知识准备

2.1、fs模块

该模块为基础文件操作API，提供基础文件操作能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。

注意：该模块从API Version 9开始支持。

2.1.1、导入模块

import fs from '@ohos.file.fs';
1.

2.1.2、fs.open

// 打开文件，使用Promise异步回调。支持使用URI打开文件。
open(path: string, mode?: number): Promise<File>
// 打开文件，使用callback异步回调。支持使用URI打开文件。
open(path: string, mode?: number, callback: AsyncCallback<File>): void
// 以同步方法打开文件。支持使用URI打开文件。
openSync(path: string, mode?: number): File
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
path	string	是	文件的应用沙箱路径或文件URI
mode	number	否	打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开： - OpenMode.READ_ONLY(0o0)：只读打开。 - OpenMode.WRITE_ONLY(0o1)：只写打开。 - OpenMode.READ_WRITE(0o2)：读写打开。给定如下功能选项，以按位或的方式追加，默认不给定任何额外选项： - OpenMode.CREATE(0o100)：若文件不存在，则创建文件。 - OpenMode.TRUNC(0o1000)：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。 - OpenMode.APPEND(0o2000)：以追加方式打开，后续写将追加到文件末尾。 - OpenMode.NONBLOCK(0o4000)：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。 - OpenMode.DIR(0o200000)：如果path不指向目录，则出错。 - OpenMode.NOFOLLOW(0o400000)：如果path指向符号链接，则出错。 - OpenMode.SYNC(0o4010000)：以同步IO的方式打开文件。

其中，返回值定义如下：

类型	说明
Promise<File>	Promise对象。返回File对象。
File	打开的File对象。

2.1.3、fs.close

// 关闭文件，使用Promise异步回调。
close(file: File|number): Promise<void>
// 关闭文件，使用callback异步回调。
close(file: File|number, callback: AsyncCallback<void>): void
// 以同步方法关闭文件。
closeSync(file: File|number): void
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
file	File \| number	是	已打开的File对象或已打开的文件描述符fd。
callback	AsyncCallback<void>	是	异步关闭文件之后的回调。

2.1.4、fs.write

// 将数据写入文件，使用Promise异步回调。
write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): Promise<number>
// 将数据写入文件，使用callback异步回调。
write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback<number>): void
// 以同步方法将数据写入文件。
writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): number
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
fd	number	是	已打开的文件描述符fd。
buffer	ArrayBuffer \| string	是	待写入文件的数据，可来自缓冲区或字符串。
options	Object	否	支持如下选项： - offset，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。 - length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度。 - encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认 ‘utf-8’。当前仅支持 ‘utf-8’。
callback	AsyncCallback<number>	是	异步将数据写入完成后执行的回调函数。

其中，返回值定义如下：

类型	说明
Promise<number>	Promise对象。返回实际写入的长度。
number	实际写入的长度

2.1.5、fs.read

// 从文件读取数据，使用Promise异步回调。
read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Promise<number>
// 从文件读取数据，使用callback异步回调。
read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }, callback: AsyncCallback<number>): void
// 以同步方法从文件读取数据。
readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): number
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
fd	number	是	已打开的文件描述符。
buffer	ArrayBuffer	是	用于保存读取到的文件数据的缓冲区。
options	Object	否	支持如下选项： - offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。 - length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度。

其中，返回值定义如下：

类型	说明
Promise<number>	Promise对象。返回读取的结果。
number	实际读取的长度

2.1.6、fs.close

// 关闭文件，使用Promise异步回调。
close(file: File|number): Promise<void>
// 关闭文件，使用callback异步回调。
close(file: File|number, callback: AsyncCallback<void>): void
// 以同步方法关闭文件。
closeSync(file: File|number): void
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
file	File\|number	是	已打开的File对象或已打开的文件描述符fd。
callback	AsyncCallback<void>	是	异步关闭文件之后的回调。

其中，返回值定义如下：

2.1.7、fs.stat

// 获取文件详细属性信息，使用Promise异步回调。
stat(file: string|number): Promise<Stat>
// 获取文件详细属性信息，使用callback异步回调。
stat(file: string|number, callback: AsyncCallback<Stat>): void
// 以同步方法获取文件详细属性信息。
statSync(file: string|number): Stat
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
file	string\|number	是	文件应用沙箱路径path或已打开的文件描述符fd。
callback	AsyncCallback<Stat>	是	异步获取文件的信息之后的回调。

其中，返回值定义如下：

类型	说明
Promise<Stat>	Promise对象。返回文件的具体信息。
Stat	表示文件的具体信息。

2.1.8、fs.unlink

// 删除单个文件，使用Promise异步回调。
unlink(path: string): Promise<void>
// 删除文件，使用callback异步回调。
unlink(path: string, callback: AsyncCallback<void>): void
// 以同步方法删除文件。
unlinkSync(path: string): void
1.
2.
3.
4.
5.
6.

系统能力：SystemCapability.FileManagement.File.FileIO

其中，参数定义如下：

参数名	类型	必填	说明
path	string	是	文件的应用沙箱路径。
callback	AsyncCallback<void>	是	异步删除文件之后的回调。

2.2、zlib模块

本模块提供压缩解压缩文件的能力。

本模块首批接口从API version 7开始支持。

2.2.1、导入模块

import zlib from '@ohos.zlib';
1.

2.2.2、zlib.zipFile

// 压缩接口（Promise形式）。
zipFile(inFile: string, outFile: string, options: Options): Promise<void>
1.
2.

系统能力： SystemCapability.BundleManager.Zlib

其中，参数定义如下：

参数名	类型	必填	说明
inFile	string	是	指定压缩的文件夹路径或者文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取。
outFile	string	是	指定压缩结果的文件路径（文件的扩展名zip）。
options	Options	是	压缩的可选参数。

其中，返回值定义如下：

类型	说明
Promise<void>	ERROR_CODE_OK：压缩成功； ERROR_CODE_ERRNO：压缩失败。

2.2.3、zlib.unzipFile

// 解压文件，解压完成返回执行结果（Promise形式）。
unzipFile(inFile:string, outFile:string, options: Options): Promise<void>
1.
2.

系统能力： SystemCapability.BundleManager.Zlib

其中，参数定义如下：

参数名	类型	必填	说明
inFile	string	是	指定的待解压缩文件的文件路径，路径必须为沙箱路径，沙箱路径可以通过context获取。
outFile	string	是	指定的解压文件路径。
options	Options	是	解压的可选参数。

其中，返回值定义如下：

类型	说明
Promise<void>	ERROR_CODE_OK：解压成功； ERROR_CODE_ERRNO：解压失败返回执行结果。

3、程序解析

3.1、获取APP文件存储路径

使用getContext().filesDir获取APP文件存储路径，使用getContext().cacheDir获取缓存存储路径。具体代码如下：

Button('获取根目录')
  .onClick(() => {
    // 获取APP应用程序的根目录
    this.rootDir = getContext().filesDir
    // getContext().filesDir获取文件存储路径
    console.log("files dir: " + getContext().filesDir)
    // getContext().cacheDir获取缓存存储路径
    console.log("cache dir: " + getContext().cacheDir)
  })
1.
2.
3.
4.
5.
6.
7.
8.
9.

3.2、文件操作

通过调用fs模块的相应接口对文件进行读写操作。具体代码如下所示：

  private close(path: string) {
    // 文件绝对路径
    let filePath = path + "/" + this.fileName;
    // 打开文件
    let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
    console.log("close file result: " + file.fd);
    // 关闭文件
    fs.closeSync(file);
  }

  private open(path: string) {
    let filePath = path + "/" + this.fileName;
    let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
    console.log("open file result: " + file.fd);
    fs.closeSync(file);
  }

  private read(path: string) {
    let filePath = path + "/" + this.fileName;
    let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
    let buffer = new ArrayBuffer(4096);
    // 读取文件内容
    let number = fs.readSync(file.fd, buffer);
    console.log("read success, read length: " + number);
    fs.closeSync(file);
  }

  private write(path: string) {
    let filePath = path + "/" + this.fileName;
    let file = fs.openSync(filePath, fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
    // 往文件中写入
    let writeLen = fs.writeSync(file.fd, "Hello OpenHarmony");
    console.log("write success, write length: " + writeLen);
    fs.closeSync(file);
  }

  private stat(path: string) {
    let filePath = path + "/" + this.fileName;
    let stat = fs.statSync(filePath);
    console.info("" + filePath + " get file info success, the size of file is " + stat.size);
  }

  private unlink(path: string) {
    let filePath = path + "/" + this.fileName;
    // 删除文件
    fs.unlinkSync(filePath);
    console.log("unlinkSync success");
  }
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.

3.3、压缩解压操作

通过zlib模块对文件进行压缩解压操作。具体代码如下所示：

private unzip(path: string) {
  let inFile = path + "/test.zip";
  let outFile = path;
  // 解压压缩文件
  zlib.unzipFile(inFile, outFile, {})
    .then((result) => {
      console.log(JSON.stringify(result));
    })
    .catch((error) => {
      console.log(JSON.stringify(error));
    })
}

private zip(path: string) {
  let inFile = path + "/" + this.fileName;
  let outFile = path + "/test.zip";
  // 压缩文件
  zlib.zipFile(inFile, outFile, {})
    .then((result) => {
      console.log(JSON.stringify(result));
    })
    .catch((error) => {
      console.log(JSON.stringify(error));
    })
}
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.

4、项目编译

4.1、打开项目

打开DevEco Studio，再打开自定义通知项目。

4.2、编译程序

点击菜单栏上的“Build” -> “Rebuild Project”。如果出现无法编译，则注意查看Event Log界面。如下所示：
基于ArkTS语言的OpenHarmony APP应用开发：文件操作-鸿蒙开发者社区
点击Run 'npm install'，让DevEco Studio安装相关依赖包。

重新点击菜单栏上的“Build” -> “Rebuild Project”。出现如下错误：

基于ArkTS语言的OpenHarmony APP应用开发：文件操作-鸿蒙开发者社区
点击上图红色框部分，安装相关服务。

重新点击菜单栏上的“Build” -> “Rebuild Project”，编译成功。
基于ArkTS语言的OpenHarmony APP应用开发：文件操作-鸿蒙开发者社区

4.3、安装程序

点击“entry”按钮，将项目程序安装到设备端。如下图所示：
基于ArkTS语言的OpenHarmony APP应用开发：文件操作-鸿蒙开发者社区
如果出现下述报错，表示无法安装。如图所示：

点击上图红色框的蓝色字体，弹出"Project Structure"对话框，点击"Apply"，再点击"OK"。如图所示：

重新点击“entry”按钮，将项目程序安装到设备端。
基于ArkTS语言的OpenHarmony APP应用开发：文件操作-鸿蒙开发者社区

5、运行结果

基于ArkTS语言的OpenHarmony APP应用开发：文件操作-鸿蒙开发者社区

分类

OpenHarmony

HarmonyOS

标签

openHarmony

51CTO

51CTO博客

51CTO学堂

基于ArkTS语言的OpenHarmony APP应用开发：文件操作原创

1、程序介绍

2、知识准备

2.1、fs模块

2.1.1、导入模块

2.1.2、fs.open

2.1.3、fs.close

2.1.4、fs.write

2.1.5、fs.read

2.1.6、fs.close

2.1.7、fs.stat

2.1.8、fs.unlink

2.2、zlib模块

2.2.1、导入模块

2.2.2、zlib.zipFile

2.2.3、zlib.unzipFile

3、程序解析

3.1、获取APP文件存储路径

3.2、文件操作

3.3、压缩解压操作

4、项目编译

4.1、打开项目

4.2、编译程序

4.3、安装程序

5、运行结果

目录

订阅鸿蒙技术特刊，精选内容抢先看

51CTO

51CTO博客

51CTO学堂

基于ArkTS语言的OpenHarmony APP应用开发：文件操作 原创

1、程序介绍

2、知识准备

2.1、fs模块

2.1.1、导入模块

2.1.2、fs.open

2.1.3、fs.close

2.1.4、fs.write

2.1.5、fs.read

2.1.6、fs.close

2.1.7、fs.stat

2.1.8、fs.unlink

2.2、zlib模块

2.2.1、导入模块

2.2.2、zlib.zipFile

2.2.3、zlib.unzipFile

3、程序解析

3.1、获取APP文件存储路径

3.2、文件操作

3.3、压缩解压操作

4、项目编译

4.1、打开项目

4.2、编译程序

4.3、安装程序

5、运行结果

目录

订阅鸿蒙技术特刊，精选内容抢先看

基于ArkTS语言的OpenHarmony APP应用开发：文件操作原创