• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 应用文件上传下载
2
3应用可以将应用文件上传到网络服务器，也可以从网络服务器下载网络资源文件到本地应用文件目录。
4
5## 上传应用文件
6
7开发者可以使用上传下载模块（[ohos.request](../../reference/apis-basic-services-kit/js-apis-request.md)）的上传接口将本地文件上传。文件上传过程使用系统服务代理完成，在api12中request.agent.create接口增加了设置代理地址参数，支持用户设置自定义代理地址。
8
9> **说明：**
10>
11> 当前上传应用文件功能，仅支持上传应用缓存文件路径（cacheDir）下的文件。
12>
13> 使用上传下载模块，需[声明权限](../../security/AccessToken/declare-permissions.md)：ohos.permission.INTERNET。
14
15以下示例代码演示两种将应用缓存文件路径下的文件上传至网络服务器的方式:
16
17```ts
18// 方式一:request.uploadFile
19// pages/xxx.ets
20import { common } from '@kit.AbilityKit';
21import fs from '@ohos.file.fs';
22import { BusinessError, request } from '@kit.BasicServicesKit';
23
24// 获取应用文件路径
25let context = getContext(this) as common.UIAbilityContext;
26let cacheDir = context.cacheDir;
27
28// 新建一个本地应用文件
29let file = fs.openSync(cacheDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
30fs.writeSync(file.fd, 'upload file test');
31fs.closeSync(file);
32
33// 上传任务配置项
34let header = new Map<Object, string>();
35header.set('key1', 'value1');
36header.set('key2', 'value2');
37let files: Array<request.File> = [
38//uri前缀internal://cache 对应cacheDir目录
39  { filename: 'test.txt', name: 'test', uri: 'internal://cache/test.txt', type: 'txt' }
40]
41let data: Array<request.RequestData> = [{ name: 'name', value: 'value' }];
42let uploadConfig: request.UploadConfig = {
43  url: 'https://xxx',
44  header: header,
45  method: 'POST',
46  files: files,
47  data: data
48}
49
50// 将本地应用文件上传至网络服务器
51try {
52  request.uploadFile(context, uploadConfig)
53    .then((uploadTask: request.UploadTask) => {
54      uploadTask.on('complete', (taskStates: Array<request.TaskState>) => {
55        for (let i = 0; i < taskStates.length; i++) {
56          console.info(`upload complete taskState: ${JSON.stringify(taskStates[i])}`);
57        }
58      });
59    })
60    .catch((err: BusinessError) => {
61      console.error(`Invoke uploadFile failed, code is ${err.code}, message is ${err.message}`);
62    })
63} catch (error) {
64  let err: BusinessError = error as BusinessError;
65  console.error(`Invoke uploadFile failed, code is ${err.code}, message is ${err.message}`);
66}
67```
68
69```ts
70// 方式二:request.agent
71// pages/xxx.ets
72import { common } from '@kit.AbilityKit';
73import fs from '@ohos.file.fs';
74import { BusinessError, request } from '@kit.BasicServicesKit';
75// 获取应用文件路径
76let context = getContext(this) as common.UIAbilityContext;
77let cacheDir = context.cacheDir;
78
79// 新建一个本地应用文件
80let file = fs.openSync(cacheDir + '/test.txt', fs.OpenMode.READ_WRITE | fs.OpenMode.CREATE);
81fs.writeSync(file.fd, 'upload file test');
82fs.closeSync(file);
83let attachments: Array<request.agent.FormItem> = [{
84  name: "test",
85  value: [
86    {
87      filename: "test.txt",
88      path: "./test.txt",
89    },
90  ]
91}];
92let config: request.agent.Config = {
93  action: request.agent.Action.UPLOAD,
94  url: 'http://xxx',
95  mode: request.agent.Mode.FOREGROUND,
96  overwrite: true,
97  method: "POST",
98  data: attachments,
99  saveas: "./"
100};
101request.agent.create(getContext(), config).then((task: request.agent.Task) => {
102  task.start((err: BusinessError) => {
103    if (err) {
104      console.error(`Failed to start the upload task, Code: ${err.code}  message: ${err.message}`);
105      return;
106    }
107  });
108  task.on('progress', async(progress) => {
109    console.warn(`/Request upload status ${progress.state}, uploaded ${progress.processed}`);
110  })
111  task.on('completed', async() => {
112    console.warn(`/Request upload completed`);
113  })
114}).catch((err: BusinessError) => {
115  console.error(`Failed to create a upload task, Code: ${err.code}, message: ${err.message}`);
116});
117```
118
119## 下载网络资源文件至应用文件目录
120
121开发者可以使用上传下载模块（[ohos.request](../../reference/apis-basic-services-kit/js-apis-request.md)）的下载接口将网络资源文件下载到应用文件目录。对已下载的网络资源文件，开发者可以使用基础文件IO接口（[ohos.file.fs](../../reference/apis-core-file-kit/js-apis-file-fs.md)）对其进行访问，使用方式与[应用文件访问](../../file-management/app-file-access.md)一致。文件下载过程使用系统服务代理完成，在api12中request.agent.create接口增加了设置代理地址参数，支持用户设置自定义代理地址。
122
123> **说明：**
124>
125> 当前网络资源文件仅支持下载至应用文件目录。
126>
127> 使用上传下载模块，需[声明权限](../../security/AccessToken/declare-permissions.md)：ohos.permission.INTERNET。
128
129以下示例代码演示两种将网络资源文件下载到应用文件目录的方式：
130
131```ts
132// 方式一:request.downloadFile
133// pages/xxx.ets
134// 将网络资源文件下载到应用文件目录并读取一段内容
135import { common } from '@kit.AbilityKit';
136import fs from '@ohos.file.fs';
137import { BusinessError, request } from '@kit.BasicServicesKit';
138import { buffer } from '@kit.ArkTS';
139
140// 获取应用文件路径
141let context = getContext(this) as common.UIAbilityContext;
142let filesDir = context.filesDir;
143
144try {
145  request.downloadFile(context, {
146    url: 'https://xxxx/xxxx.txt',
147    filePath: filesDir + '/xxxx.txt'
148  }).then((downloadTask: request.DownloadTask) => {
149    downloadTask.on('complete', () => {
150      console.info('download complete');
151      let file = fs.openSync(filesDir + '/xxxx.txt', fs.OpenMode.READ_WRITE);
152      let arrayBuffer = new ArrayBuffer(1024);
153      let readLen = fs.readSync(file.fd, arrayBuffer);
154      let buf = buffer.from(arrayBuffer, 0, readLen);
155      console.info(`The content of file: ${buf.toString()}`);
156      fs.closeSync(file);
157    })
158  }).catch((err: BusinessError) => {
159    console.error(`Invoke downloadTask failed, code is ${err.code}, message is ${err.message}`);
160  });
161} catch (error) {
162  let err: BusinessError = error as BusinessError;
163  console.error(`Invoke downloadFile failed, code is ${err.code}, message is ${err.message}`);
164}
165```
166```ts
167// 方式二:request.agent
168// pages/xxx.ets
169// 将网络资源文件下载到应用文件目录并读取一段内容
170import { BusinessError, request } from '@kit.BasicServicesKit';
171
172let config: request.agent.Config = {
173  action: request.agent.Action.DOWNLOAD,
174  url: 'https://xxxx/test.txt',
175  gauge: true,
176  overwrite: true,
177  network: request.agent.Network.WIFI,
178};
179request.agent.create(getContext(), config).then((task: request.agent.Task) => {
180  task.start((err: BusinessError) => {
181    if (err) {
182      console.error(`Failed to start the upload task, Code: ${err.code}  message: ${err.message}`);
183      return;
184    }
185  });
186  task.on('progress', async(progress) => {
187    console.warn(`/Request download status ${progress.state}, downloaded ${progress.processed}`);
188  })
189  task.on('completed', async() => {
190    console.warn(`/Request download completed`);
191  })
192}).catch((err: BusinessError) => {
193  console.error(`Failed to create a download task, Code: ${err.code}, message: ${err.message}`);
194});
195```
196