1# 通过DataShareExtensionAbility实现数据共享 2 3 4## 场景介绍 5 6跨应用访问数据时，可以通过DataShareExtensionAbility拉起数据提供方的应用以实现对数据的访问。 7 8此种方式支持跨应用拉起数据提供方的DataShareExtension，数据提供方的开发者可以在回调中实现灵活的业务逻辑。用于跨应用复杂业务场景。 9 10 11## 运作机制 12 13数据共享可分为数据的提供方和访问方两部分。 14 15- 数据提供方：[DataShareExtensionAbility](../reference/apis-arkdata/js-apis-application-dataShareExtensionAbility-sys.md)，可以选择性实现数据的增、删、改、查，以及文件打开等功能，并对外共享这些数据。 16 17- 数据访问方：由[createDataShareHelper()](../reference/apis-arkdata/js-apis-data-dataShare-sys.md#datasharecreatedatasharehelper)方法所创建的工具类，利用工具类便可以访问提供方提供的这些数据。 18 19**图1** 数据共享运作机制 20 21 22- DataShareExtensionAbility模块为数据提供方，实现跨应用数据共享的相关业务。 23 24- DataShareHelper模块为数据访问方，提供各种访问数据的接口，包括增删改查等。 25 26- 数据访问方与提供方通过IPC进行通信，数据提供方可以通过数据库实现，也可以通过其他数据存储方式实现。 27 28- ResultSet模块通过共享内存实现，用于存储查询数据得到的结果集，并提供了遍历结果集的方法。 29 30 31## 实现说明 32 33 34### 数据提供方应用的开发（仅限系统应用） 35 36[DataShareExtensionAbility](../reference/apis-arkdata/js-apis-application-dataShareExtensionAbility-sys.md)提供以下API，根据需要重写对应回调方法。 37 38- **onCreate**：DataShare客户端连接DataShareExtensionAbility服务端时，服务端需要在此回调中实现初始化业务逻辑，该方法可以选择性重写。 39- **insert**：业务函数，客户端请求插入数据时回调此接口，服务端需要在此回调中实现插入数据功能，该方法可以选择性重写。 40- **update**：业务函数，客户端请求更新数据时回调此接口，服务端需要在此回调中实现更新数据功能，该方法可以选择性重写。 41- **batchUpdate**：业务函数，客户端请求批量更新数据时回调此接口，服务端需要在此回调中实现批量更新数据功能，该方法可以选择性重写。 42- **delete**：业务函数，客户端请求删除数据时回调此接口，服务端需要在此回调中实现删除数据功能，该方法可以选择性重写。 43- **query**：业务函数，客户端请求查询数据时回调此接口，服务端需要在此回调中实现查询数据功能，该方法可以选择性重写。 44- **batchInsert**：业务函数，客户端请求批量插入数据时回调此接口，服务端需要在此回调中实现批量插入数据的功能，该方法可以选择性重写。 45- **normalizeUri**：业务函数，客户端给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。 46- **denormalizeUri**：业务函数，服务端使用的URI转换为客户端传入的初始URI时服务端回调此接口，该方法可以选择性重写。 47 48开发者在实现一个数据共享服务时，需要在DevEco Studio工程中手动新建一个DataShareExtensionAbility，具体步骤如下。 49 501. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为DataShareExtAbility。 51 522. 在DataShareAbility目录，右键选择“New > ArkTS File”，新建一个文件并命名为DataShareExtAbility.ets。 53 543. 在DataShareExtAbility.ets文件中，导入DataShareExtensionAbility模块，开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供插入、删除和查询服务，则可只重写这些接口，并导入对应的基础依赖模块；如果需要增加权限校验，可以在重写的回调方法中使用IPC提供的[getCallingPid](../reference/apis-ipc-kit/js-apis-rpc.md#getcallingpid)、[getCallingUid](../reference/apis-ipc-kit/js-apis-rpc.md#getcallinguid)、[getCallingTokenId](../reference/apis-ipc-kit/js-apis-rpc.md#getcallingtokenid8)方法获取访问者信息来进行权限校验。 55 56 ```ts 57 import { DataShareExtensionAbility, dataShare, dataSharePredicates, relationalStore, DataShareResultSet } from '@kit.ArkData'; 58 import { Want } from '@kit.AbilityKit'; 59 import { BusinessError } from '@kit.BasicServicesKit' 60 ``` 61 624. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。 63 64 ```ts 65 const DB_NAME = 'DB00.db'; 66 const TBL_NAME = 'TBL00'; 67 const DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS " 68 + TBL_NAME 69 + ' (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, isStudent BOOLEAN, Binary BINARY)'; 70 71 let rdbStore: relationalStore.RdbStore; 72 let result: string; 73 74 export default class DataShareExtAbility extends DataShareExtensionAbility { 75 // 重写onCreate接口 76 onCreate(want: Want, callback: Function) { 77 result = this.context.cacheDir + '/datashare.txt'; 78 // 业务实现使用RDB 79 relationalStore.getRdbStore(this.context, { 80 name: DB_NAME, 81 securityLevel: relationalStore.SecurityLevel.S3 82 }, (err:BusinessError, data:relationalStore.RdbStore) => { 83 rdbStore = data; 84 rdbStore.executeSql(DDL_TBL_CREATE, [], (err) => { 85 console.info(`DataShareExtAbility onCreate, executeSql done err:${err}`); 86 }); 87 if (callback) { 88 callback(); 89 } 90 }); 91 } 92 93 // 重写query接口 94 query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: Function) { 95 if (predicates === null || predicates === undefined) { 96 console.info('invalid predicates'); 97 } 98 try { 99 rdbStore.query(TBL_NAME, predicates, columns, (err:BusinessError, resultSet:relationalStore.ResultSet) => { 100 if (resultSet !== undefined) { 101 console.info(`resultSet.rowCount:${resultSet.rowCount}`); 102 } 103 if (callback !== undefined) { 104 callback(err, resultSet); 105 } 106 }); 107 } catch (err) { 108 let code = (err as BusinessError).code; 109 let message = (err as BusinessError).message 110 console.error(`Failed to query. Code:${code},message:${message}`); 111 } 112 } 113 // 重写batchUpdate接口 114 batchUpdate(operations:Record<string, Array<dataShare.UpdateOperation>>, callback:Function) { 115 let recordOps : Record<string, Array<dataShare.UpdateOperation>> = operations; 116 let results : Record<string, Array<number>> = {}; 117 let a = Object.entries(recordOps); 118 for (let i = 0; i < a.length; i++) { 119 let key = a[i][0]; 120 let values = a[i][1]; 121 let result : number[] = []; 122 for (const value of values) { 123 rdbStore.update(TBL_NAME, value.values, value.predicates).then(async (rows) => { 124 console.info('Update row count is ' + rows); 125 result.push(rows); 126 }).catch((err:BusinessError) => { 127 console.info('Update failed, err is ' + JSON.stringify(err)); 128 result.push(-1) 129 }) 130 } 131 results[key] = result; 132 } 133 callback(null, results); 134 } 135 // 可根据应用需求，选择性重写各个接口 136 }; 137 ``` 138 1395. 在module.json5中定义DataShareExtensionAbility。 140 141 **表1** module.json5对应属性字段 142 143 | 属性名称 | 备注说明 | 必填 | 144 | -------- | -------- | -------- | 145 | name | Ability名称，对应Ability派生的ExtensionAbility类名。 | 是 | 146 | type | Ability类型，DataShare对应的Ability类型为“dataShare”，表示基于datashare模板开发的。 | 是 | 147 | uri | 通信使用的URI，是客户端链接服务端的唯一标识。 | 是 | 148 | exported | 对其他应用是否可见，设置为true时，才能与其他应用进行通信传输数据。 | 是 | 149 | readPermission | 访问数据时需要的权限，不配置默认不进行读权限校验。 | 否 | 150 | writePermission | 修改数据时需要的权限，不配置默认不进行写权限校验。 | 否 | 151 | metadata | 增加静默访问所需的额外配置项，包含name和resource字段。<br /> name类型固定为"ohos.extension.dataShare"，是配置的唯一标识。 <br /> resource类型固定为"$profile:data_share_config"，表示配置文件的名称为data_share_config.json。 | 若Ability启动模式为"singleton"，则metadata必填，Ability启动模式可见[abilities对象的内部结构-launchType](../quick-start/module-structure.md#abilities对象的内部结构)；其他情况下无需填写。 | 152 153 **module.json5配置样例：** 154 155 ```json 156 "extensionAbilities": [ 157 { 158 "srcEntry": "./ets/DataShareExtAbility/DataShareExtAbility.ets", 159 "name": "DataShareExtAbility", 160 "icon": "$media:icon", 161 "description": "$string:description_datashareextability", 162 "type": "dataShare", 163 "uri": "datashare://com.samples.datasharetest.DataShare", 164 "exported": true, 165 "metadata": [{"name": "ohos.extension.dataShare", "resource": "$profile:data_share_config"}] 166 } 167 ] 168 ``` 169 170 **表2** data_share_config.json对应属性字段 171 172 | 属性名称 | 备注说明 | 必填 | 173 | ------------------- | ------------------------------------------------------------ | ---- | 174 | tableConfig | 配置标签。包括uri和crossUserMode。<br>**-uri：** 指定配置生效的范围，uri支持以下三种格式，优先级为**表配置>库配置>\***，如果同时配置，高优先级会覆盖低优先级 。<br /> 1. "*" : 所有的数据库和表。<br /> 2. "datashare:///{bundleName}/{moduleName}/{storeName}" : 指定数据库。<br /> 3. "datashare:///{bundleName}/{moduleName}/{storeName}/{tableName}" : 指定表<br>**-crossUserMode：** 标识数据是否为多用户共享，配置为1则多用户数据共享，配置为2则多用户数据隔离。 | 是 | 175 | isSilentProxyEnable | 标识该ExtensionAbility是否关闭静默访问。<br />false：代表关闭静默访问。<br />true：代表打开静默访问。<br />不填写默认为true，即默认开启静默访问。<br />如果该应用下存在多个ExtensionAbility，其中一个配置了该属性为false，代表应用关闭静默访问。<br />如果数据提供方调用过enableSilentProxy和disableSilentProxy接口，则按照接口的设置结果来开启或关闭静默访问。否则会读取该配置来开启或关闭静默访问。 | 否 | 176 | launchInfos | 包括storeId和tableNames。<br>该配置中表粒度的数据变更时，通过所属extensionAbilities中的uri拉起extension。若业务方需要在非主动数据变更时做处理，则配置此项，拉起extension即时处理；若不需要，则可以不配置。<br>**-storeId：** 数据库名。该配置需要去掉数据库名后缀，如：数据库名为test.db时，配置信息填入test即可。<br>**-tableNames：** 数据库表名集合。集合内单个表数据变更就会拉起extension。 | 否 | 177 178 **data_share_config.json配置样例** 179 180 ```json 181 { 182 "tableConfig":[ 183 { 184 "uri":"*", 185 "crossUserMode":1 186 }, 187 { 188 "uri":"datashare:///com.acts.datasharetest/entry/DB00", 189 "crossUserMode":1 190 }, 191 { 192 "uri":"datashare:///com.acts.datasharetest/entry/DB00/TBL00", 193 "crossUserMode":2 194 } 195 ], 196 "isSilentProxyEnable":true, 197 "launchInfos":[ 198 { 199 "storeId": "test", 200 "tableNames":["test1", "test2"] 201 } 202 ] 203 } 204 ``` 205 206 207### 数据访问方应用的开发 208 2091. 导入基础依赖包。 210 211 ```ts 212 import { UIAbility } from '@kit.AbilityKit'; 213 import { dataShare, dataSharePredicates, DataShareResultSet, ValuesBucket } from '@kit.ArkData'; 214 import { window } from '@kit.ArkUI'; 215 import { BusinessError } from '@kit.BasicServicesKit'; 216 ``` 217 2182. 定义与数据提供方通信的URI字符串。 219 220 ```ts 221 // 作为参数传递的URI，与module.json5中定义的URI的区别是多了一个"/"，是因为作为参数传递的URI中，在第二个与第三个"/"中间，存在一个DeviceID的参数 222 let dseUri = ('datashare:///com.samples.datasharetest.DataShare'); 223 ``` 224 2253. 创建工具接口类对象。 226 227 ```ts 228 let dsHelper: dataShare.DataShareHelper | undefined = undefined; 229 let abilityContext: Context; 230 231 export default class EntryAbility extends UIAbility { 232 onWindowStageCreate(windowStage: window.WindowStage) { 233 abilityContext = this.context; 234 dataShare.createDataShareHelper(abilityContext, dseUri, (err, data) => { 235 dsHelper = data; 236 }); 237 } 238 } 239 ``` 240 2414. 获取到接口类对象后，便可利用其提供的接口访问提供方提供的服务，如进行数据的增删改查等。 242 243 ```ts 244 // 构建一条数据 245 let key1 = 'name'; 246 let key2 = 'age'; 247 let key3 = 'isStudent'; 248 let key4 = 'Binary'; 249 let valueName1 = 'ZhangSan'; 250 let valueName2 = 'LiSi'; 251 let valueAge1 = 21; 252 let valueAge2 = 18; 253 let valueIsStudent1 = false; 254 let valueIsStudent2 = true; 255 let valueBinary = new Uint8Array([1, 2, 3]); 256 let valuesBucket: ValuesBucket = { key1: valueName1, key2: valueAge1, key3: valueIsStudent1, key4: valueBinary }; 257 let updateBucket: ValuesBucket = { key1: valueName2, key2: valueAge2, key3: valueIsStudent2, key4: valueBinary }; 258 let predicates = new dataSharePredicates.DataSharePredicates(); 259 let valArray = ['*']; 260 261 let record: Record<string, Array<dataShare.UpdateOperation>> = {}; 262 let operations1: Array<dataShare.UpdateOperation> = []; 263 let operations2: Array<dataShare.UpdateOperation> = []; 264 let operation1: dataShare.UpdateOperation = { 265 values: valuesBucket, 266 predicates: predicates 267 } 268 operations1.push(operation1); 269 let operation2: dataShare.UpdateOperation = { 270 values: updateBucket, 271 predicates: predicates 272 } 273 operations2.push(operation2); 274 record["uri1"] = operations1; 275 record["uri2"] = operations2; 276 277 if (dsHelper != undefined) { 278 // 插入一条数据 279 (dsHelper as dataShare.DataShareHelper).insert(dseUri, valuesBucket, (err:BusinessError, data:number) => { 280 console.info(`dsHelper insert result:${data}`); 281 }); 282 // 更新数据 283 (dsHelper as dataShare.DataShareHelper).update(dseUri, predicates, updateBucket, (err:BusinessError, data:number) => { 284 console.info(`dsHelper update result:${data}`); 285 }); 286 // 查询数据 287 (dsHelper as dataShare.DataShareHelper).query(dseUri, predicates, valArray, (err:BusinessError, data:DataShareResultSet) => { 288 console.info(`dsHelper query result:${data}`); 289 }); 290 // 删除指定的数据 291 (dsHelper as dataShare.DataShareHelper).delete(dseUri, predicates, (err:BusinessError, data:number) => { 292 console.info(`dsHelper delete result:${data}`); 293 }); 294 // 批量更新数据 295 (dsHelper as dataShare.DataShareHelper).batchUpdate(record).then((data: Record<string, Array<number>>) => { 296 // 遍历data获取每条数据的更新结果， value为更新成功的数据记录数，若小于0，说明该次更新失败 297 let a = Object.entries(data); 298 for (let i = 0; i < a.length; i++) { 299 let key = a[i][0]; 300 let values = a[i][1] 301 console.info(`Update uri:${key}`); 302 for (const value of values) { 303 console.info(`Update result:${value}`); 304 } 305 } 306 }); 307 // 关闭DataShareHelper实例 308 (dsHelper as dataShare.DataShareHelper).close(); 309 } 310 ``` 311 312## 相关实例 313 314针对数据共享开发，有以下相关实例可供参考： 315 316- [系统应用跨应用数据共享（ArkTS）（Full SDK）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SystemFeature/DataManagement/CrossAppDataShare)
