1# 通过DataShareExtensionAbility实现数据共享 2 3 4## 场景介绍 5 6跨应用访问数据时，可以通过DataShareExtensionAbility拉起数据提供方的应用以实现对数据的访问。 7 8此种方式支持跨应用拉起数据提供方的DataShareExtension，数据提供方的开发者可以在回调中实现灵活的业务逻辑。用于跨应用复杂业务场景。 9 10 11## 运作机制 12 13数据共享可分为数据的提供方和访问方两部分。 14 15- 数据提供方：[DataShareExtensionAbility](../reference/apis/js-apis-application-dataShareExtensionAbility.md)，可以选择性实现数据的增、删、改、查，以及文件打开等功能，并对外共享这些数据。 16 17- 数据访问方：由[createDataShareHelper()](../reference/apis/js-apis-data-dataShare.md#datasharecreatedatasharehelper)方法所创建的工具类，利用工具类，便可以访问提供方提供的这些数据。 18 19**图1** 数据共享运作机制 20 21 22 23- DataShareExtensionAbility模块为数据提供方，实现跨应用数据共享的相关业务。 24 25- DataShareHelper模块为数据访问方，提供各种访问数据的接口，包括增删改查等。 26 27- 数据访问方与提供方通过IPC进行通信，数据提供方可以通过数据库实现，也可以通过其他数据存储方式实现。 28 29- ResultSet模块通过共享内存实现，用于存储查询数据得到的结果集，并提供了遍历结果集的方法。 30 31 32## 实现说明 33 34 35### 数据提供方应用的开发（仅限系统应用） 36 37[DataShareExtensionAbility](../reference/apis/js-apis-application-dataShareExtensionAbility.md)提供以下API，根据需要重写对应回调方法。 38 39- **onCreate**：DataShare客户端连接DataShareExtensionAbility服务端时，服务端需要在此回调中实现初始化业务逻辑，该方法可以选择性重写。 40 41- **insert**：业务函数，客户端请求插入数据时回调此接口，服务端需要在此回调中实现插入数据功能，该方法可以选择性重写。 42 43- **update**：业务函数，客户端请求更新数据时回调此接口，服务端需要在此回调中实现更新数据功能，该方法可以选择性重写。 44 45- **delete**：业务函数，客户端请求删除数据时回调此接口，服务端需要在此回调中实现删除数据功能，该方法可以选择性重写。 46 47- **query**：业务函数，客户端请求查询数据时回调此接口，服务端需要在此回调中实现查询数据功能，该方法可以选择性重写。 48 49- **batchInsert**：业务函数，客户端请求批量插入数据时回调此接口，服务端需要在此回调中实现批量插入数据的功能，该方法可以选择性重写。 50 51- **normalizeUri**：业务函数，客户端给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。 52 53- **denormalizeUri**：业务函数，服务端使用的URI转换为客户端传入的初始URI时服务端回调此接口，该方法可以选择性重写。 54 55开发者在实现一个数据共享服务时，需要在DevEco Studio工程中手动新建一个DataShareExtensionAbility，具体步骤如下。 56 571. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为DataShareExtAbility。 58 592. 在DataShareAbility目录，右键选择“New > TypeScript File”，新建一个TypeScript文件并命名为DataShareExtAbility.ts。 60 613. 在DataShareExtAbility.ts文件中，导入 62`@ohos.application.DataShareExtensionAbility`模块，开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供插入、删除和查询服务，则可只重写这些接口，并导入对应的基础依赖模块。 63 64 ```js 65 import Extension from '@ohos.application.DataShareExtensionAbility'; 66 import rdb from '@ohos.data.relationalStore'; 67 import dataSharePredicates from '@ohos.data.dataSharePredicates'; 68 ``` 69 704. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。 71 72 ```js 73 const DB_NAME = 'DB00.db'; 74 const TBL_NAME = 'TBL00'; 75 const DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS " 76 + TBL_NAME 77 + ' (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, isStudent BOOLEAN, Binary BINARY)'; 78 79 let rdbStore; 80 let result; 81 82 export default class DataShareExtAbility extends Extension { 83 private rdbStore_; 84 85 // 重写onCreate接口 86 onCreate(want, callback) { 87 result = this.context.cacheDir + '/datashare.txt'; 88 // 业务实现使用RDB 89 rdb.getRdbStore(this.context, { 90 name: DB_NAME, 91 securityLevel: rdb.SecurityLevel.S1 92 }, function (err, data) { 93 rdbStore = data; 94 rdbStore.executeSql(DDL_TBL_CREATE, [], (err) => { 95 console.info(`DataShareExtAbility onCreate, executeSql done err:${err}`); 96 }); 97 if (callback) { 98 callback(); 99 } 100 }); 101 } 102 103 // 重写query接口 104 query(uri, predicates, columns, callback) { 105 if (predicates === null || predicates === undefined) { 106 console.info('invalid predicates'); 107 } 108 try { 109 rdbStore.query(TBL_NAME, predicates, columns, (err, resultSet) => { 110 if (resultSet !== undefined) { 111 console.info(`resultSet.rowCount:${resultSet.rowCount}`); 112 } 113 if (callback !== undefined) { 114 callback(err, resultSet); 115 } 116 }); 117 } catch (err) { 118 console.error(`Failed to query. Code:${err.code},message:${err.message}`); 119 } 120 } 121 // 可根据应用需求，选择性重写各个接口 122 }; 123 ``` 124 1255. 在module.json5中定义DataShareExtensionAbility。 126 127 **表1** module.json5对应属性字段 128 129 | 属性名称 | 备注说明 | 必填 | 130 | -------- | -------- | -------- | 131 | name | Ability名称，对应Ability派生的ExtensionAbility类名。 | 是 | 132 | type | Ability类型，DataShare对应的Ability类型为“dataShare”，表示基于datashare模板开发的。 | 是 | 133 | uri | 通信使用的URI，是客户端链接服务端的唯一标识。 | 是 | 134 | exported | 对其他应用是否可见，设置为true时，才能与其他应用进行通信传输数据。 | 是 | 135 | readPermission | 访问数据时需要的权限，不配置默认不进行读权限校验。 | 否 | 136 | writePermission | 修改数据时需要的权限，不配置默认不进行写权限校验。 | 否 | 137 138 **module.json5配置样例：** 139 140 141 ```json 142 "extensionAbilities": [ 143 { 144 "srcEnty": "./ets/DataShareExtAbility/DataShareExtAbility.ts", 145 "name": "DataShareExtAbility", 146 "icon": "$media:icon", 147 "description": "$string:description_datashareextability", 148 "type": "dataShare", 149 "uri": "datashare://com.samples.datasharetest.DataShare", 150 "exported": true 151 } 152 ] 153 ``` 154 155 156### 数据访问方应用的开发 157 1581. 导入基础依赖包。 159 160 ```js 161 import UIAbility from '@ohos.app.ability.UIAbility'; 162 import dataShare from '@ohos.data.dataShare'; 163 import dataSharePredicates from '@ohos.data.dataSharePredicates'; 164 ``` 165 1662. 定义与数据提供方通信的URI字符串。 167 168 ```js 169 // 作为参数传递的URI，与module.json5中定义的URI的区别是多了一个"/"，是因为作为参数传递的URI中，在第二个与第三个"/"中间，存在一个DeviceID的参数 170 let dseUri = ('datashare:///com.samples.datasharetest.DataShare'); 171 ``` 172 1733. 创建工具接口类对象。 174 175 ```js 176 let dsHelper; 177 let abilityContext; 178 179 export default class EntryAbility extends UIAbility { 180 onWindowStageCreate(windowStage) { 181 abilityContext = this.context; 182 dataShare.createDataShareHelper(abilityContext, dseUri, (err, data) => { 183 dsHelper = data; 184 }); 185 } 186 } 187 ``` 188 1894. 获取到接口类对象后，便可利用其提供的接口访问提供方提供的服务，如进行数据的增删改查等。 190 191 ```js 192 // 构建一条数据 193 let valuesBucket = { 'name': 'ZhangSan', 'age': 21, 'isStudent': false, 'Binary': new Uint8Array([1, 2, 3]) }; 194 let updateBucket = { 'name': 'LiSi', 'age': 18, 'isStudent': true, 'Binary': new Uint8Array([1, 2, 3]) }; 195 let predicates = new dataSharePredicates.DataSharePredicates(); 196 let valArray = ['*']; 197 // 插入一条数据 198 dsHelper.insert(dseUri, valuesBucket, (err, data) => { 199 console.info(`dsHelper insert result:${data}`); 200 }); 201 // 更新数据 202 dsHelper.update(dseUri, predicates, updateBucket, (err, data) => { 203 console.info(`dsHelper update result:${data}`); 204 }); 205 // 查询数据 206 dsHelper.query(dseUri, predicates, valArray, (err, data) => { 207 console.info(`dsHelper query result:${data}`); 208 }); 209 // 删除指定的数据 210 dsHelper.delete(dseUri, predicates, (err, data) => { 211 console.info(`dsHelper delete result:${data}`); 212 }); 213 ``` 214
