• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 应用文件分享
2
3应用文件分享是应用之间通过分享URI（Uniform Resource Identifier）或文件描述符FD（File Descriptor）的方式，进行文件共享的过程。由于FD分享的文件关闭FD后，无法再打开分享文件，因此不推荐使用，本文重点介绍URI分享方式。
4
5- 基于URI分享方式，应用可分享单个文件，通过[ohos.app.ability.wantConstant](../reference/apis/js-apis-app-ability-wantConstant.md#wantconstantflags)的wantConstant.Flags接口以只读或读写权限授权给其他应用。应用可通过[ohos.file.fs](../reference/apis/js-apis-file-fs.md#fsopen)的open()接口打开URI，并进行读写操作。当前OpenHarmony API 9仅支持临时授权，分享给其他应用的文件在被分享应用退出时权限被收回。
6
7- 基于FD分享方式，应用可分享单个文件，通过ohos.file.fs的open接口以指定权限授权给其他应用。应用从Want中解析拿到FD后可通过ohos.file.fs的读写接口对文件进行读写。
8
9开发者可以使用相关接口，[分享文件给其他应用](#分享文件给其他应用)或[使用其他应用分享的文件](#使用其他应用分享的文件)。
10
11## 文件URI规范
12
13文件URI的格式为：
14
15  格式为file://<bundleName>/<path>
16
17- file：文件URI的标志。
18
19- bundleName：该文件资源的属主。
20
21- path：文件资源在应用沙箱中的路径。
22
23## 分享文件给其他应用
24
25在分享文件给其他应用前，开发者需要先[获取应用文件路径](../application-models/application-context-stage.md#获取应用开发路径)。
26
271. 获取文件在应用沙箱中的路径，并转换为文件URI。
28
29   ```ts
30   import UIAbility from '@ohos.app.ability.UIAbility';
31   import fileuri from '@ohos.file.fileuri';
32   import window from '@ohos.window';
33
34   export default class EntryAbility extends UIAbility {
35     onWindowStageCreate(windowStage: window.WindowStage) {
36       // 获取文件的沙箱路径
37       let pathInSandbox = this.context.filesDir + "/test.txt";
38       // 将沙箱路径转换为uri
39       let uri = fileuri.getUriFromPath(pathInSandbox);
40       // 获取的uri为"file://com.example.demo/data/storage/el2/base/files/test.txt"
41     }
42   }
43   ```
44
452. 设置获取文件的权限以及选择要分享的应用。
46   分享文件给其他应用需要使用[startAbility()](../reference/apis/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)接口，将获取到的URI填充在want的参数uri中，标注URI的文件类型，type字段可参考[Want属性](../reference/apis/js-apis-app-ability-want.md#属性)，并通过设置want的flag来设置对应的读写权限，action字段配置为"ohos.want.action.sendData"表示进行应用文件分享，开发示例如下。
47
48   > **说明：**
49   >
50   > 写权限分享时，同时授予读权限。
51
52   ```ts
53   import fileuri from '@ohos.file.fileuri';
54   import window from '@ohos.window';
55   import wantConstant from '@ohos.app.ability.wantConstant';
56   import UIAbility from '@ohos.app.ability.UIAbility';
57
58   export default class EntryAbility extends UIAbility {
59     onWindowStageCreate(windowStage: window.WindowStage) {
60       // 获取文件沙箱路径
61       let filePath = this.context.filesDir + '/test.txt';
62       // 将沙箱路径转换为uri
63       let uri = fileuri.getUriFromPath(filePath);
64       let want = {
65         // 配置被分享文件的读写权限，例如对被分享应用进行读写授权
66         flags: wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION | wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
67         // 配置分享应用的隐式拉起规则
68         action: 'ohos.want.action.sendData',
69         uri: uri,
70         type: 'text/plain'
71       }
72       this.context.startAbility(want)
73         .then(() => {
74           console.info('Invoke getCurrentBundleStats succeeded.');
75         })
76         .catch((err) => {
77           console.error(`Invoke startAbility failed, code is ${err.code}, message is ${err.message}`);
78         });
79     }
80
81     ...
82   }
83   ```
84
85## 使用其他应用分享的文件
86
87被分享应用需要在[module.json5配置文件](../quick-start/module-configuration-file.md)的actions标签的值配置为"ohos.want.action.sendData"，表示接收应用分享文件，配置uris字段，表示接收URI的类型，即只接收其他应用分享该类型的URI，如下表示本应用只接收scheme为file，类型为txt的文件，示例如下。
88
89```json
90{
91  "module": {
92    ...
93    "abilities": [
94      {
95        ...
96        "skills": [
97          {
98            ...
99            "actions": [
100              "ohos.want.action.sendData"
101            ],
102            "uris": [
103              {
104                "scheme": "file",
105                "type": "text/plain"
106              }
107           ]
108          }
109        ]
110      }
111    ]
112  }
113}
114```
115
116被分享方的UIAbility被启动后，可以在其[onCreate()](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityoncreate)或者[onNewWant()](../reference/apis/js-apis-app-ability-uiAbility.md#uiabilityonnewwant)回调中获取传入的Want参数信息。
117
118通过接口want的参数获取分享文件的URI，获取文件URI后通过fs.open()接口打开文件，获取对应的file对象后，可对文件进行读写操作。
119
120```ts
121// xxx.ets
122import fs from '@ohos.file.fs';
123
124function getShareFile() {
125  try {
126    let want = ...; // 获取分享方传递过来的want信息
127
128    // 从want信息中获取uri字段
129    let uri = want.uri;
130    if (uri == null || uri == undefined) {
131      console.info('uri is invalid');
132      return;
133    }
134    try {
135      // 根据需要对被分享文件的URI进行相应操作。例如读写的方式打开URI获取file对象
136      let file = fs.openSync(uri, fs.OpenMode.READ_WRITE);
137      console.info('open file successfully!');
138    } catch (error) {
139      console.error(`Invoke openSync failed, code is ${error.code}, message is ${error.message}`);
140    }
141  } catch (error) {
142    console.error(`Invoke openSync failed, code is ${error.code}, message is ${error.message}`);
143  }
144}
145```
146