提交 1c9e6029 编写于 作者: W wangxiyue

Add DataShareExtensionAbility Guide

Signed-off-by: Nwangxiyue <wangxiyue8@huawei.com>
上级 1dad82b7
......@@ -38,7 +38,50 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
### 数据提供方应用的开发(仅限系统应用)
1. 导入基础依赖包。
[DataShareExtensionAbility](../reference/apis/js-apis-application-dataShareExtensionAbility.md)提供以下API,根据需要重写对应回调方法。
- **onCreate**
DataShare客户端连接DataShareExtensionAbility服务端时,服务端回调此接口,执行初始化业务逻辑操作。该方法可以选择性重写。
- **insert**
业务函数,客户端请求插入数据时回调此接口,服务端需要在此回调中实现插入数据功能,该方法可以选择性重写。
- **update**
业务函数,客户端请求插入数据时回调此接口,服务端需要在此回调中实现更新数据功能,该方法可以选择性重写。
- **delete**
业务函数,客户端请求插入数据时回调此接口,服务端需要在此回调中实现删除数据功能,该方法可以选择性重写。
- **query**
业务函数,客户端请求插入数据时回调此接口,服务端需要在此回调中实现查询数据功能,该方法可以选择性重写。
- **batchInsert**
业务函数,客户端请求插入数据时回调此接口,服务端需要在此回调中实现批量插入数据数据功能,该方法可以选择性重写。
- **normalizeUri**
业务函数,客户端给定的URI转换为服务端使用的URI时回调此接口,该方法可以选择性重写。
- **denormalizeUri**
业务函数,服务端使用的URI转换为客户端传入的初始URI时服务端回调此接口,该方法可以选择性重写。
开发者在实现一个数据共享服务时,需要在DevEco Studio工程中手动新建一个DataShareExtensionAbility,具体步骤如下。
1. 在工程Module对应的ets目录下,右键选择“New &gt; Directory”,新建一个目录并命名为DataShareAbility。
2. 在DataShareAbility目录,右键选择“New &gt; TypeScript File”,新建一个TypeScript文件并命名为DataShareAbility.ts。
3. 在DataShareAbility.ts文件中,增加导入DataShareExtensionAbility的依赖包,开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供插入、删除和查询服务,则可只重写这些接口。
4. 导入基础依赖包。
```ts
import Extension from '@ohos.application.DataShareExtensionAbility';
......@@ -47,9 +90,9 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
import dataSharePredicates from '@ohos.data.dataSharePredicates';
```
2. 数据提供方(也称服务端)继承于DataShareExtensionAbility,开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供查询服务,则可只重写查询接口。
5. 数据提供方(也称服务端)继承于DataShareExtensionAbility,开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供查询服务,则可只重写查询接口。
3. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。
6. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。
```ts
const DB_NAME = "DB00.db";
......@@ -57,13 +100,13 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
const DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS "
+ TBL_NAME
+ " (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, isStudent BOOLEAN, Binary BINARY)";
let rdbStore;
let result;
export default class DataShareExtAbility extends Extension {
private rdbStore_;
// 重写onCreate接口
onCreate(want, callback) {
result = this.context.cacheDir + '/datashare.txt'
......@@ -78,7 +121,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
callback();
});
}
// 重写query接口
query(uri, predicates, columns, callback) {
if (predicates == null || predicates == undefined) {
......@@ -102,7 +145,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
};
```
4. 在module.json5中定义DataShareExtensionAbility。
7. 在module.json5中定义DataShareExtensionAbility。
| Json重要字段 | 备注说明 |
| ------------ | ------------------------------------------------------------ |
......@@ -136,20 +179,20 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
import dataShare from '@ohos.data.dataShare';
import dataSharePredicates from '@ohos.data.dataSharePredicates';
```
2. 定义与数据提供方通信的URI字符串。
```ts
// 作为参数传递的URI,与module.json5中定义的URI的区别是多了一个"/",是因为作为参数传递的URI中,在第二个与第三个"/"中间,存在一个DeviceID的参数
let dseUri = ("datashare:///com.samples.datasharetest.DataShare");
```
3. 创建工具接口类对象。
```ts
let dsHelper;
let abilityContext;
export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) {
abilityContext = this.context;
......@@ -159,7 +202,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
}
}
```
4. 获取到接口类对象后,便可利用其提供的接口访问提供方提供的服务,如进行数据的增删改查等。
```ts
......@@ -182,6 +225,12 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
});
// 删除指定的数据
dsHelper.delete(dseUri, predicates, (err, data) => {
console.log("dsHelper delete result: " + data);
console.log("dsHelper delete result: " + data);
});
```
## 相关示例
针对DataShareExtensionAbility开发,有以下相关示例可供参考:
[DataShareExtensionAbility:跨应用数据共享(ArkTS)(API9)(Full SDK)](https://gitee.com/openharmony/applications_app_samples/tree/master/data/CrossAppDataShare)
......@@ -4,6 +4,8 @@
DataShare即数据共享模块,用于应用管理其自身数据,也提供了向其他应用共享以及管理其数据的方法。目前仅支持同个设备上应用之间的数据共享。
DataShare需要与[DataShareExtensionAbility](../reference/apis/js-apis-application-dataShareExtensionAbility.md)配合使用。
在许多应用场景中都需要用到数据共享,比如将电话簿、短信、媒体库中的数据共享给其他应用等。当然,不是所有的数据都允许其他应用访问,比如帐号、密码等;有些数据也只允许其他应用查询而不允许其删改,比如短信等。所以对于各种数据共享场景,DataShare这样一个安全、便捷的可以跨应用的数据共享机制是十分必需的。
对于数据提供者来说,无需进行繁琐的封装,可直接使用DataShare框架实现向其他应用共享数据;对于数据访问方来说,因DataShare的访问方式不会因数据提供的方式而不同,所以只需要学习和使用一套接口即可,大大减少了学习时间和开发难度。
......@@ -16,22 +18,22 @@ DataShare即数据共享模块,用于应用管理其自身数据,也提供
- **数据提供方**
提供数据及实现相关业务的应用程序,也称为生产者或服务端
DataShareExtensionAbility,基于Stage模型,选择性实现对数据的增、删、改、查以及文件打开等功能,并对外共享这些数据。实现跨应用数据共享的相关业务
- **数据访问方**
访问数据提供方所提供的数据或业务的应用程序,也称为消费者或客户端
DataShareHelper,由[createDataShareHelper()](../reference/apis/js-apis-data-dataShare.md#datasharecreatedatasharehelper)方法所创建的工具类,数据访问方利用工具类,便可访问数据提供方提供的数据
- **数据集**
用户要插入的数据集合,可以是一条或多条数据。数据集以键值对的形式存在,键为字符串类型,值支持数字、字符串、布尔值、无符号整型数组等多种数据类型。
- **结果集**
用户查询之后的结果集合,其提供了灵活的数据访问方式,以便用户获取各项数据。
- **谓词**
用户访问数据库中的数据所使用的筛选条件,经常被应用在更新数据、删除数据和查询数据等场景。
## 运作机制
......@@ -41,7 +43,7 @@ DataShare即数据共享模块,用于应用管理其自身数据,也提供
![](figures/zh-cn_DataShare.png)
- DataShareExtAbility模块为数据提供方,实现跨应用数据共享的相关业务。
- DataShareExtensionAbility模块为数据提供方,实现跨应用数据共享的相关业务。
- DataShareHelper模块为数据访问方,提供各种访问数据的接口,包括增删改查等。
- 数据访问方与提供方通过IPC进行通信,数据提供方可以通过数据库实现,也可以通过其他数据存储方式实现。
......@@ -51,4 +53,4 @@ DataShare即数据共享模块,用于应用管理其自身数据,也提供
- DataShare受到数据提供方所使用数据库的一些限制。例如支持的数据模型、Key的长度、Value的长度、每个应用程序支持同时打开数据库的最大数量等,都会受到使用的数据库的限制。
- 因DataShare内部实现依赖于IPC通信,所以数据集、谓词、结果集等的载荷受到IPC通信的约束与限制。
\ No newline at end of file
- 因DataShare内部实现依赖于IPC通信,所以数据集、谓词、结果集等的载荷受到IPC通信的约束与限制。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册