未验证 提交 655cd798 编写于 作者: 葛亚芳 提交者: Gitee

update zh-cn/application-dev/database/database-datashare-guidelines.md.

Signed-off-by: N葛亚芳 <geyafang@huawei.com>
上级 59ae2046
...@@ -38,7 +38,50 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -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 ```ts
import Extension from '@ohos.application.DataShareExtensionAbility'; import Extension from '@ohos.application.DataShareExtensionAbility';
...@@ -47,9 +90,9 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -47,9 +90,9 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
import dataSharePredicates from '@ohos.data.dataSharePredicates'; import dataSharePredicates from '@ohos.data.dataSharePredicates';
``` ```
2. 数据提供方(也称服务端)继承于DataShareExtensionAbility,开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供查询服务,则可只重写查询接口。 5. 数据提供方(也称服务端)继承于DataShareExtensionAbility,开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供查询服务,则可只重写查询接口。
3. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。 6. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。
```ts ```ts
const DB_NAME = "DB00.db"; const DB_NAME = "DB00.db";
...@@ -57,29 +100,31 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -57,29 +100,31 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
const DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS " const DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS "
+ TBL_NAME + TBL_NAME
+ " (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, isStudent BOOLEAN, Binary BINARY)"; + " (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, isStudent BOOLEAN, Binary BINARY)";
let rdbStore; let rdbStore;
let result; let result;
export default class DataShareExtAbility extends Extension { export default class DataShareExtAbility extends Extension {
private rdbStore_; private rdbStore_;
// 重写onCreate接口 // 重写onCreate接口
onCreate(want, callback) { onCreate(want, callback) {
result = this.context.cacheDir + '/datashare.txt' result = this.context.cacheDir + '/datashare.txt';
// 业务实现使用RDB // 业务实现使用RDB
rdb.getRdbStore(this.context, { rdb.getRdbStore(this.context, {
name: DB_NAME, name: DB_NAME,
securityLevel: rdb.SecurityLevel.S1 securityLevel: rdb.SecurityLevel.S1
}, function (err, data) { }, function (err, data) {
rdbStore = data; rdbStore = data;
rdbStore.executeSql(DDL_TBL_CREATE, [], function (err) { rdbStore.executeSql(DDL_TBL_CREATE, [], function (err) {
console.log('DataShareExtAbility onCreate, executeSql done err:' + JSON.stringify(err)); console.log('DataShareExtAbility onCreate, executeSql done err:' + JSON.stringify(err));
}); });
callback(); if (callback) {
callback();
}
}); });
} }
// 重写query接口 // 重写query接口
query(uri, predicates, columns, callback) { query(uri, predicates, columns, callback) {
if (predicates == null || predicates == undefined) { if (predicates == null || predicates == undefined) {
...@@ -103,7 +148,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -103,7 +148,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
}; };
``` ```
4. 在module.json5中定义DataShareExtensionAbility。 7. 在module.json5中定义DataShareExtensionAbility。
| Json重要字段 | 备注说明 | | Json重要字段 | 备注说明 |
| ------------ | ------------------------------------------------------------ | | ------------ | ------------------------------------------------------------ |
...@@ -137,20 +182,20 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -137,20 +182,20 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
import dataShare from '@ohos.data.dataShare'; import dataShare from '@ohos.data.dataShare';
import dataSharePredicates from '@ohos.data.dataSharePredicates'; import dataSharePredicates from '@ohos.data.dataSharePredicates';
``` ```
2. 定义与数据提供方通信的URI字符串。 2. 定义与数据提供方通信的URI字符串。
```ts ```ts
// 作为参数传递的URI,与module.json5中定义的URI的区别是多了一个"/",是因为作为参数传递的URI中,在第二个与第三个"/"中间,存在一个DeviceID的参数 // 作为参数传递的URI,与module.json5中定义的URI的区别是多了一个"/",是因为作为参数传递的URI中,在第二个与第三个"/"中间,存在一个DeviceID的参数
let dseUri = ("datashare:///com.samples.datasharetest.DataShare"); let dseUri = ("datashare:///com.samples.datasharetest.DataShare");
``` ```
3. 创建工具接口类对象。 3. 创建工具接口类对象。
```ts ```ts
let dsHelper; let dsHelper;
let abilityContext; let abilityContext;
export default class EntryAbility extends UIAbility { export default class EntryAbility extends UIAbility {
onWindowStageCreate(windowStage) { onWindowStageCreate(windowStage) {
abilityContext = this.context; abilityContext = this.context;
...@@ -160,7 +205,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -160,7 +205,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
} }
} }
``` ```
4. 获取到接口类对象后,便可利用其提供的接口访问提供方提供的服务,如进行数据的增删改查等。 4. 获取到接口类对象后,便可利用其提供的接口访问提供方提供的服务,如进行数据的增删改查等。
```ts ```ts
...@@ -168,7 +213,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -168,7 +213,7 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
let valuesBucket = { "name": "ZhangSan", "age": 21, "isStudent": false, "Binary": new Uint8Array([1, 2, 3]) }; let valuesBucket = { "name": "ZhangSan", "age": 21, "isStudent": false, "Binary": new Uint8Array([1, 2, 3]) };
let updateBucket = { "name": "LiSi", "age": 18, "isStudent": true, "Binary": new Uint8Array([1, 2, 3]) }; let updateBucket = { "name": "LiSi", "age": 18, "isStudent": true, "Binary": new Uint8Array([1, 2, 3]) };
let predicates = new dataSharePredicates.DataSharePredicates(); let predicates = new dataSharePredicates.DataSharePredicates();
let valArray = new Array("*"); let valArray = ['*'];
// 插入一条数据 // 插入一条数据
dsHelper.insert(dseUri, valuesBucket, (err, data) => { dsHelper.insert(dseUri, valuesBucket, (err, data) => {
console.log("dsHelper insert result: " + data); console.log("dsHelper insert result: " + data);
...@@ -183,7 +228,12 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其 ...@@ -183,7 +228,12 @@ DataShare即数据共享模块,提供了向其他应用共享以及管理其
}); });
// 删除指定的数据 // 删除指定的数据
dsHelper.delete(dseUri, predicates, (err, data) => { 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)
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册