• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 应用文件访问
2
3应用需要对应用文件目录下的应用文件进行查看、创建、读写、删除、移动、复制、获取属性等访问操作，下文介绍具体方法。
4
5## 接口说明
6
7开发者通过基础文件操作接口（[ohos.file.fs](../reference/apis/js-apis-file-fs.md)）实现应用文件访问能力，主要功能如下表所示。
8
9**表1** 基础文件操作接口功能
10
11| 接口名 | 功能 | 接口类型 | 支持同步 | 支持异步 |
12| -------- | -------- | -------- | -------- | -------- |
13| access | 检查文件是否存在 | 方法 | √ | √ |
14| close | 关闭文件 | 方法 | √ | √ |
15| copyFile | 复制文件 | 方法 | √ | √ |
16| createStream | 基于文件路径打开文件流 | 方法 | √ | √ |
17| listFile | 列出文件夹下所有文件名 | 方法 | √ | √ |
18| mkdir | 创建目录 | 方法 | √ | √ |
19| moveFile | 移动文件 | 方法 | √ | √ |
20| open | 打开文件 | 方法 | √ | √ |
21| read | 从文件读取数据 | 方法 | √ | √ |
22| rename | 重命名文件或文件夹 | 方法 | √ | √ |
23| rmdir | 删除整个目录 | 方法 | √ | √ |
24| stat | 获取文件详细属性信息 | 方法 | √ | √ |
25| unlink | 删除单个文件 | 方法 | √ | √ |
26| write | 将数据写入文件 | 方法 | √ | √ |
27| Stream.close | 关闭文件流 | 方法 | √ | √ |
28| Stream.flush | 刷新文件流 | 方法 | √ | √ |
29| Stream.write | 将数据写入流文件 | 方法 | √ | √ |
30| Stream.read | 从流文件读取数据 | 方法 | √ | √ |
31| File.fd | 获取文件描述符 | 属性 | √ | × |
32| OpenMode | 设置文件打开标签 | 属性 | √ | × |
33| Filter | 设置文件过滤配置项 | 类型 | × | × |
34
35## 开发示例
36
37在对应用文件开始访问前，开发者需要[获取应用文件路径](../application-models/application-context-stage.md#获取应用开发路径)。以从UIAbilityContext获取HAP级别的文件路径为例进行说明，UIAbilityContext的获取方式请参见[获取UIAbility的上下文信息](../application-models/uiability-usage.md#获取uiability的上下文信息)。
38
39下面介绍几种常用操作示例。
40
41### 新建并读写一个文件
42
43以下示例代码演示了如何新建一个文件并对其读写。
44
45```ts
46// pages/xxx.ets
47import fs from '@ohos.file.fs';
48import common from '@ohos.app.ability.common';
49
50function createFile() {
51  // 获取应用文件路径
52  let context = getContext(this) as common.UIAbilityContext;
53  let filesDir = context.filesDir;
54
55  // 新建并打开文件
56  let file = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
57  // 写入一段内容至文件
58  let writeLen = fs.writeSync(file.fd, "Try to write str.");
59  console.info("The length of str is: " + writeLen);
60  // 从文件读取一段内容
61  let buf = new ArrayBuffer(1024);
62  let readLen = fs.readSync(file.fd, buf, { offset: 0 });
63  console.info("the content of file: " + String.fromCharCode.apply(null, new Uint8Array(buf.slice(0, readLen))));
64  // 关闭文件
65  fs.closeSync(file);
66}
67```
68
69### 读取文件内容并写入到另一个文件
70
71  以下示例代码演示了如何从一个文件读写内容到另一个文件。
72
73```ts
74// pages/xxx.ets
75import fs from '@ohos.file.fs';
76import common from '@ohos.app.ability.common';
77
78function readWriteFile() {
79  // 获取应用文件路径
80  let context = getContext(this) as common.UIAbilityContext;
81  let filesDir = context.filesDir;
82
83  // 打开文件
84  let srcFile = fs.openSync(filesDir + '/test.txt', fs.OpenMode.READ_WRITE);
85  let destFile = fs.openSync(filesDir + '/destFile.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
86  // 读取源文件内容并写入至目的文件
87  let bufSize = 4096;
88  let readSize = 0;
89  let buf = new ArrayBuffer(bufSize);
90  let readLen = fs.readSync(srcFile.fd, buf, { offset: readSize });
91  while (readLen > 0) {
92    readSize += readLen;
93    fs.writeSync(destFile.fd, buf);
94    readLen = fs.readSync(srcFile.fd, buf, { offset: readSize });
95  }
96  // 关闭文件
97  fs.closeSync(srcFile);
98  fs.closeSync(destFile);
99}
100```
101
102> **说明：**
103>
104> 使用读写接口时，需注意可选项参数offset的设置。对于已存在且读写过的文件，文件偏移指针默认在上次读写操作的终止位置。
105
106### 以流的形式读写文件
107
108以下示例代码演示了如何使用流接口进行文件读写：
109
110```ts
111// pages/xxx.ets
112import fs from '@ohos.file.fs';
113import common from '@ohos.app.ability.common';
114
115async function readWriteFileWithStream() {
116  // 获取应用文件路径
117  let context = getContext(this) as common.UIAbilityContext;
118  let filesDir = context.filesDir;
119
120  // 打开文件流
121  let inputStream = fs.createStreamSync(filesDir + '/test.txt', 'r+');
122  let outputStream = fs.createStreamSync(filesDir + '/destFile.txt', "w+");
123  // 以流的形式读取源文件内容并写入目的文件
124  let bufSize = 4096;
125  let readSize = 0;
126  let buf = new ArrayBuffer(bufSize);
127  let readLen = await inputStream.read(buf, { offset: readSize });
128  readSize += readLen;
129  while (readLen > 0) {
130    await outputStream.write(buf);
131    readLen = await inputStream.read(buf, { offset: readSize });
132    readSize += readLen;
133  }
134  // 关闭文件流
135  inputStream.closeSync();
136  outputStream.closeSync();
137}
138```
139
140> **说明：**
141>
142> 使用流接口时，需注意流的及时关闭。同时流的异步接口应严格遵循异步接口使用规范，避免同步、异步接口混用。流接口不支持并发读写。
143
144### 查看文件列表
145
146以下示例代码演示了如何查看文件列表：
147
148```ts
149// 查看文件列表
150import fs from '@ohos.file.fs';
151import common from '@ohos.app.ability.common';
152
153// 获取应用文件路径
154let context = getContext(this) as common.UIAbilityContext;
155let filesDir = context.filesDir;
156
157// 查看文件列表
158let options = {
159  recursion: false,
160  listNum: 0,
161  filter: {
162    suffix: ['.png', '.jpg', '.txt'],          // 匹配文件后缀名为'.png','.jpg','.txt'
163    displayName: ['test%'],                    // 匹配文件全名以'test'开头
164    fileSizeOver: 0,                           // 匹配文件大小大于等于0
165    lastModifiedAfter: new Date(0).getTime(),  // 匹配文件最近修改时间在1970年1月1日之后
166  },
167}
168let files = fs.listFileSync(filesDir, options);
169for (let i = 0; i < files.length; i++) {
170  console.info(`The name of file: ${files[i]}`);
171}
172```
173