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