1# 应用文件分享
2
3应用文件分享是应用之间通过分享URI(Uniform Resource Identifier)或文件描述符FD(File Descriptor)的方式,进行文件共享的过程。
4
5- 基于URI分享方式,应用可分享单个文件,通过[ohos.app.ability.wantConstantwantConstant.Flags接口](../reference/apis-ability-kit/js-apis-app-ability-wantConstant.md#flags)以只读或读写权限授权给其他应用。应用可通过[ohos.file.fsfs.open](../reference/apis-core-file-kit/js-apis-file-fs.md#fsopen)打开URI,并进行读写操作。当前仅支持临时授权,分享给其他应用的文件在被分享应用退出时权限被收回。
6
7- 基于FD分享方式,应用可分享单个文件,通过ohos.file.fs的open接口以指定权限授权给其他应用。应用从want中解析拿到FD后可通过[ohos.file.fs](../reference/apis-core-file-kit/js-apis-file-fs.md)的读写接口对文件进行读写。
8由于FD分享的文件关闭FD后,无法再打开分享文件,因此不推荐使用,本文重点介绍基于URI[分享文件给其他应用](#分享文件给其他应用)或[使用其他应用分享的文件](#使用其他应用分享的文件)。
9
10## 应用可分享目录
11
12| 沙箱路径                             | 物理路径                                                                             | 说明              |
13| -------                              | -------                                                                             | ---- |
14| /data/storage/el1/base               | /data/app/el1/\<currentUserId\>/base/\<PackageName\>                                | 应用el1级别加密数据目录 |
15| /data/storage/el2/base               | /data/app/el2/\<currentUserId\>/base/\<PackageName\>                                | 应用el2级别加密数据目录 |
16| /data/storage/el2/distributedfiles   | /mnt/hmdfs/\<currentUserId\>/account/device_view/\<networkId\>/data/\<PackageName\> | 应用el2加密级别有账号分布式数据融合目录 |
17
18## 文件URI规范
19
20文件URI的格式为:
21
22  格式为file://&lt;bundleName&gt;/&lt;path&gt;
23
24- file:文件URI的标志。
25
26- bundleName:该文件资源的属主。
27
28- path:文件资源在应用沙箱中的路径。
29
30## 分享文件给其他应用
31
32在分享文件给其他应用前,开发者需要先[获取应用文件路径](../application-models/application-context-stage.md#获取应用文件路径)。
33
341. 获取文件在应用沙箱中的路径,并转换为文件URI。
35
36   ```ts
37   import { UIAbility } from '@kit.AbilityKit';
38   import { fileUri } from '@kit.CoreFileKit';
39   import { window } from '@kit.ArkUI';
40
41   export default class EntryAbility extends UIAbility {
42     onWindowStageCreate(windowStage: window.WindowStage) {
43       // 获取文件的沙箱路径
44       let pathInSandbox = this.context.filesDir + "/test1.txt";
45       // 将沙箱路径转换为uri
46       let uri = fileUri.getUriFromPath(pathInSandbox);
47       // 获取的uri为"file://com.example.demo/data/storage/el2/base/files/test1.txt"
48     }
49   }
50   ```
51
522. 设置获取文件的权限以及选择要分享的应用。
53   分享文件给其他应用需要使用[startAbility](../reference/apis-ability-kit/js-apis-inner-application-uiAbilityContext.md#uiabilitycontextstartability)接口,将获取到的URI填充在want的参数URI中,标注URI的文件类型,type字段可参考[want属性](../reference/apis-ability-kit/js-apis-app-ability-want.md#属性),并通过设置want的flag来设置对应的读写权限,action字段配置为"ohos.want.action.sendData"表示进行应用文件分享,开发示例如下。
54
55   > **说明:**
56   >
57   > 写权限分享时,同时授予读权限。
58
59   ```ts
60   import { fileUri } from '@kit.CoreFileKit';
61   import { window } from '@kit.ArkUI';
62   import { wantConstant } from '@kit.AbilityKit';
63   import { UIAbility } from '@kit.AbilityKit';
64   import { Want } from '@kit.AbilityKit';
65   import { BusinessError } from '@kit.BasicServicesKit';
66
67   export default class EntryAbility extends UIAbility {
68     onWindowStageCreate(windowStage: window.WindowStage) {
69       // 获取文件沙箱路径
70       let filePath = this.context.filesDir + '/test1.txt';
71       // 将沙箱路径转换为uri
72       let uri = fileUri.getUriFromPath(filePath);
73       let want: Want  = {
74         // 配置被分享文件的读写权限,例如对被分享应用进行读写授权
75         flags: wantConstant.Flags.FLAG_AUTH_WRITE_URI_PERMISSION | wantConstant.Flags.FLAG_AUTH_READ_URI_PERMISSION,
76         // 配置分享应用的隐式拉起规则
77         action: 'ohos.want.action.sendData',
78         uri: uri,
79         type: 'text/plain'
80       }
81       this.context.startAbility(want)
82         .then(() => {
83           console.info('Invoke getCurrentBundleStats succeeded.');
84         })
85         .catch((err: BusinessError) => {
86           console.error(`Invoke startAbility failed, code is ${err.code}, message is ${err.message}`);
87         });
88     }
89     // ...
90   }
91   ```
92**图1** 效果示意图:<br/>
93![share-app-file](figures/share-app-file.png)
94
95## 使用其他应用分享的文件
96
97被分享应用需要在[module.json5配置文件](../quick-start/module-configuration-file.md)的actions标签的值配置为"ohos.want.action.sendData",表示接收应用分享文件,配置uris字段,表示接收URI的类型,即只接收其他应用分享该类型的URI,如下表示本应用只接收scheme为file,类型为txt的文件,示例如下。
98
99```json
100{
101  "module": {
102    ...
103    "abilities": [
104      {
105        ...
106        "skills": [
107          {
108            ...
109            "actions": [
110              "ohos.want.action.sendData"
111            ],
112            "uris": [
113              {
114                "scheme": "file",
115                "type": "text/plain"
116              }
117           ]
118          }
119        ]
120      }
121    ]
122  }
123}
124```
125
126被分享方的UIAbility被启动后,可以在其[onCreate()](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityoncreate)或者[onNewWant](../reference/apis-ability-kit/js-apis-app-ability-uiAbility.md#uiabilityonnewwant)回调中获取传入的want参数信息。
127
128通过接口want的参数获取分享文件的URI,获取文件URI后通过fs.open接口打开文件,获取对应的file对象后,可对文件进行读写操作。
129
130```ts
131// xxx.ets
132import { fileIo as fs } from '@kit.CoreFileKit';
133import { Want } from '@kit.AbilityKit';
134import { BusinessError } from '@kit.BasicServicesKit';
135
136function getShareFile() {
137  try {
138    let want: Want = {}; // 此处实际使用时应该修改为获取到的分享方传递过来的want信息
139
140    // 从want信息中获取uri字段
141    let uri = want.uri;
142    if (uri == null || uri == undefined) {
143      console.info('uri is invalid');
144      return;
145    }
146    try {
147      // 根据需要对被分享文件的URI进行相应操作。例如读写的方式打开URI获取file对象
148      let file = fs.openSync(uri, fs.OpenMode.READ_WRITE);
149      console.info('open file successfully!');
150    } catch (err) {
151      let error: BusinessError = err as BusinessError;
152      console.error(`Invoke openSync failed, code is ${error.code}, message is ${error.message}`);
153    }
154  } catch (error) {
155    let err: BusinessError = error as BusinessError;
156    console.error(`Invoke openSync failed, code is ${err.code}, message is ${err.message}`);
157  }
158}
159```
160
161## 相关实例
162
163针对应用文件分享,有以下相关实例可供参考:
164
165- [文件分享与访问(ArkTS)(API9)](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/FileManagement/FileShare/SandboxShare)