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 40- **insert**：业务函数，客户端请求插入数据时回调此接口，服务端需要在此回调中实现插入数据功能，该方法可以选择性重写。 41 42- **update**：业务函数，客户端请求更新数据时回调此接口，服务端需要在此回调中实现更新数据功能，该方法可以选择性重写。 43 44- **delete**：业务函数，客户端请求删除数据时回调此接口，服务端需要在此回调中实现删除数据功能，该方法可以选择性重写。 45 46- **query**：业务函数，客户端请求查询数据时回调此接口，服务端需要在此回调中实现查询数据功能，该方法可以选择性重写。 47 48- **batchInsert**：业务函数，客户端请求批量插入数据时回调此接口，服务端需要在此回调中实现批量插入数据的功能，该方法可以选择性重写。 49 50- **normalizeUri**：业务函数，客户端给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。 51 52- **denormalizeUri**：业务函数，服务端使用的URI转换为客户端传入的初始URI时服务端回调此接口，该方法可以选择性重写。 53 54开发者在实现一个数据共享服务时，需要在DevEco Studio工程中手动新建一个DataShareExtensionAbility，具体步骤如下。 55 561. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为DataShareExtAbility。 57 582. 在DataShareAbility目录，右键选择“New > ArkTS File”，新建一个文件并命名为DataShareExtAbility.ets。 59 603. 在DataShareExtAbility.ets文件中，导入 61`@ohos.application.DataShareExtensionAbility`模块，开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供插入、删除和查询服务，则可只重写这些接口，并导入对应的基础依赖模块。 62 63 ```ts 64 import Extension from '@ohos.application.DataShareExtensionAbility'; 65 import dataSharePredicates from '@ohos.data.dataSharePredicates'; 66 import relationalStore from '@ohos.data.relationalStore'; 67 import Want from '@ohos.app.ability.Want'; 68 import { BusinessError } from '@ohos.base' 69 ``` 70 714. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。 72 73 ```ts 74 const DB_NAME = 'DB00.db'; 75 const TBL_NAME = 'TBL00'; 76 const DDL_TBL_CREATE = "CREATE TABLE IF NOT EXISTS " 77 + TBL_NAME 78 + ' (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT, age INTEGER, isStudent BOOLEAN, Binary BINARY)'; 79 80 let rdbStore: relationalStore.RdbStore; 81 let result: string; 82 83 export default class DataShareExtAbility extends Extension { 84 // 重写onCreate接口 85 onCreate(want: Want, callback: Function) { 86 result = this.context.cacheDir + '/datashare.txt'; 87 // 业务实现使用RDB 88 relationalStore.getRdbStore(this.context, { 89 name: DB_NAME, 90 securityLevel: relationalStore.SecurityLevel.S1 91 }, (err, data) => { 92 rdbStore = data; 93 rdbStore.executeSql(DDL_TBL_CREATE, [], (err) => { 94 console.info(`DataShareExtAbility onCreate, executeSql done err:${err}`); 95 }); 96 if (callback) { 97 callback(); 98 } 99 }); 100 } 101 102 // 重写query接口 103 query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: Function) { 104 if (predicates === null || predicates === undefined) { 105 console.info('invalid predicates'); 106 } 107 try { 108 rdbStore.query(TBL_NAME, predicates, columns, (err, resultSet) => { 109 if (resultSet !== undefined) { 110 console.info(`resultSet.rowCount:${resultSet.rowCount}`); 111 } 112 if (callback !== undefined) { 113 callback(err, resultSet); 114 } 115 }); 116 } catch (err) { 117 let code = (err as BusinessError).code; 118 let message = (err as BusinessError).message 119 console.error(`Failed to query. Code:${code},message:${message}`); 120 } 121 } 122 // 可根据应用需求，选择性重写各个接口 123 }; 124 ``` 125 1265. 在module.json5中定义DataShareExtensionAbility。 127 128 **表1** module.json5对应属性字段 129 130 | 属性名称 | 备注说明 | 必填 | 131 | -------- | -------- | -------- | 132 | name | Ability名称，对应Ability派生的ExtensionAbility类名。 | 是 | 133 | type | Ability类型，DataShare对应的Ability类型为“dataShare”，表示基于datashare模板开发的。 | 是 | 134 | uri | 通信使用的URI，是客户端链接服务端的唯一标识。 | 是 | 135 | exported | 对其他应用是否可见，设置为true时，才能与其他应用进行通信传输数据。 | 是 | 136 | readPermission | 访问数据时需要的权限，不配置默认不进行读权限校验。 | 否 | 137 | writePermission | 修改数据时需要的权限，不配置默认不进行写权限校验。 | 否 | 138 | 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对象的内部结构)；其他情况下无需填写。 | 139 140 **module.json5配置样例：** 141 142 ```json 143 "extensionAbilities": [ 144 { 145 "srcEntry": "./ets/DataShareExtAbility/DataShareExtAbility.ets", 146 "name": "DataShareExtAbility", 147 "icon": "$media:icon", 148 "description": "$string:description_datashareextability", 149 "type": "dataShare", 150 "uri": "datashare://com.samples.datasharetest.DataShare", 151 "exported": true, 152 "metadata": [{"name": "ohos.extension.dataShare", "resource": "$profile:data_share_config"}] 153 } 154 ] 155 ``` 156 157 **表2** data_share_config.json对应属性字段 158 159 | 属性名称 | 备注说明 | 必填 | 160 | ------------------- | ------------------------------------------------------------ | ---- | 161 | tableConfig | 配置标签。 | 是 | 162 | uri | 指定配置生效的范围，uri支持以下三种格式，优先级为**表配置>库配置>\***，如果同时配置，高优先级会覆盖低优先级 。<br /> 1. "*" : 所有的数据库和表。<br /> 2. "datashare:///{bundleName}/{moduleName}/{storeName}" : 指定数据库。<br /> 3. "datashare:///{bundleName}/{moduleName}/{storeName}/{tableName}" : 指定表。 | 是 | 163 | crossUserMode | 标识数据是否为多用户共享，配置为1则多用户数据共享，配置为2则多用户数据隔离。 | 是 | 164 | isSilentProxyEnable | 标识该ExtensionAbility是否关闭静默访问。<br />false：代表关闭静默访问。<br />true：代表打开静默访问。<br />不填写默认为true，即默认开启静默访问。<br />如果该应用下存在多个ExtensionAbility，其中一个配置了该属性为false，代表应用关闭静默访问。<br />如果数据提供方调用过enableSilentProxy和disableSilentProxy接口，则按照接口的设置结果来开启或关闭静默访问。否则会读取该配置来开启或关闭静默访问。 | 否 | 165 166 **data_share_config.json配置样例** 167 168 ```json 169 { 170 "tableConfig":[ 171 { 172 "uri":"*", 173 "crossUserMode":1 174 }, 175 { 176 "uri":"datashare:///com.acts.datasharetest/entry/DB00", 177 "crossUserMode":1 178 }, 179 { 180 "uri":"datashare:///com.acts.datasharetest/entry/DB00/TBL00", 181 "crossUserMode":2 182 } 183 ], 184 "isSilentProxyEnable":true 185 } 186 ``` 187 188 189### 数据访问方应用的开发 190 1911. 导入基础依赖包。 192 193 ```ts 194 import UIAbility from '@ohos.app.ability.UIAbility'; 195 import dataShare from '@ohos.data.dataShare'; 196 import dataSharePredicates from '@ohos.data.dataSharePredicates'; 197 import { ValuesBucket } from '@ohos.data.ValuesBucket' 198 import window from '@ohos.window'; 199 ``` 200 2012. 定义与数据提供方通信的URI字符串。 202 203 ```ts 204 // 作为参数传递的URI，与module.json5中定义的URI的区别是多了一个"/"，是因为作为参数传递的URI中，在第二个与第三个"/"中间，存在一个DeviceID的参数 205 let dseUri = ('datashare:///com.samples.datasharetest.DataShare'); 206 ``` 207 2083. 创建工具接口类对象。 209 210 ```ts 211 let dsHelper: dataShare.DataShareHelper | undefined = undefined; 212 let abilityContext: Context; 213 214 export default class EntryAbility extends UIAbility { 215 onWindowStageCreate(windowStage: window.WindowStage) { 216 abilityContext = this.context; 217 dataShare.createDataShareHelper(abilityContext, dseUri, (err, data) => { 218 dsHelper = data; 219 }); 220 } 221 } 222 ``` 223 2244. 获取到接口类对象后，便可利用其提供的接口访问提供方提供的服务，如进行数据的增删改查等。 225 226 ```ts 227 // 构建一条数据 228 let key1 = 'name'; 229 let key2 = 'age'; 230 let key3 = 'isStudent'; 231 let key4 = 'Binary'; 232 let valueName1 = 'ZhangSan'; 233 let valueName2 = 'LiSi'; 234 let valueAge1 = 21; 235 let valueAge2 = 18; 236 let valueIsStudent1 = false; 237 let valueIsStudent2 = true; 238 let valueBinary = new Uint8Array([1, 2, 3]); 239 let valuesBucket: ValuesBucket = { key1: valueName1, key2: valueAge1, key3: valueIsStudent1, key4: valueBinary }; 240 let updateBucket: ValuesBucket = { key1: valueName2, key2: valueAge2, key3: valueIsStudent2, key4: valueBinary }; 241 let predicates = new dataSharePredicates.DataSharePredicates(); 242 let valArray = ['*']; 243 if (dsHelper != undefined) { 244 // 插入一条数据 245 (dsHelper as dataShare.DataShareHelper).insert(dseUri, valuesBucket, (err, data) => { 246 console.info(`dsHelper insert result:${data}`); 247 }); 248 // 更新数据 249 (dsHelper as dataShare.DataShareHelper).update(dseUri, predicates, updateBucket, (err, data) => { 250 console.info(`dsHelper update result:${data}`); 251 }); 252 // 查询数据 253 (dsHelper as dataShare.DataShareHelper).query(dseUri, predicates, valArray, (err, data) => { 254 console.info(`dsHelper query result:${data}`); 255 }); 256 // 删除指定的数据 257 (dsHelper as dataShare.DataShareHelper).delete(dseUri, predicates, (err, data) => { 258 console.info(`dsHelper delete result:${data}`); 259 }); 260 } 261 ``` 262 263## 相关实例 264 265针对数据共享开发，有以下相关实例可供参考： 266 267- [系统应用跨应用数据共享（ArkTS）（Full SDK）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/SystemFeature/DataManagement/CrossAppDataShare)
