HarmonyOS 应用开发之通过DataShareExtensionAbility实现数据共享

场景介绍

跨应用访问数据时，可以通过DataShareExtensionAbility拉起数据提供方的应用以实现对数据的访问。

此种方式支持跨应用拉起数据提供方的DataShareExtension，数据提供方的开发者可以在回调中实现灵活的业务逻辑。用于跨应用复杂业务场景。

运作机制

数据共享可分为数据的提供方和访问方两部分。

• 数据提供方： DataShareExtensionAbility ，可以选择性实现数据的增、删、改、查，以及文件打开等功能，并对外共享这些数据。

• 数据访问方：由 createDataShareHelper() 方法所创建的工具类，利用工具类，便可以访问提供方提供的这些数据。

图1 数据共享运作机制

• DataShareExtensionAbility模块为数据提供方，实现跨应用数据共享的相关业务。

• DataShareHelper模块为数据访问方，提供各种访问数据的接口，包括增删改查等。

• 数据访问方与提供方通过IPC进行通信，数据提供方可以通过数据库实现，也可以通过其他数据存储方式实现。

• ResultSet模块通过共享内存实现，用于存储查询数据得到的结果集，并提供了遍历结果集的方法。

实现说明

数据提供方应用的开发（仅限系统应用）

DataShareExtensionAbility 提供以下API，根据需要重写对应回调方法。

• onCreate：DataShare客户端连接DataShareExtensionAbility服务端时，服务端需要在此回调中实现初始化业务逻辑，该方法可以选择性重写。
• insert：业务函数，客户端请求插入数据时回调此接口，服务端需要在此回调中实现插入数据功能，该方法可以选择性重写。
• update：业务函数，客户端请求更新数据时回调此接口，服务端需要在此回调中实现更新数据功能，该方法可以选择性重写。
• batchUpdate：业务函数，客户端请求批量更新数据时回调此接口，服务端需要在此回调中实现批量更新数据功能，该方法可以选择性重写。
• delete：业务函数，客户端请求删除数据时回调此接口，服务端需要在此回调中实现删除数据功能，该方法可以选择性重写。
• query：业务函数，客户端请求查询数据时回调此接口，服务端需要在此回调中实现查询数据功能，该方法可以选择性重写。
• batchInsert：业务函数，客户端请求批量插入数据时回调此接口，服务端需要在此回调中实现批量插入数据的功能，该方法可以选择性重写。
• normalizeUri：业务函数，客户端给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。
• denormalizeUri：业务函数，服务端使用的URI转换为客户端传入的初始URI时服务端回调此接口，该方法可以选择性重写。

开发者在实现一个数据共享服务时，需要在DevEco Studio工程中手动新建一个DataShareExtensionAbility，具体步骤如下。

1. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为DataShareExtAbility。

2. 在DataShareAbility目录，右键选择“New > ArkTS File”，新建一个文件并命名为DataShareExtAbility.ets。

3. 在DataShareExtAbility.ets文件中，导入
   @ohos.application.DataShareExtensionAbility模块，开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供插入、删除和查询服务，则可只重写这些接口，并导入对应的基础依赖模块；如果需要增加权限校验，可以在重写的回调方法中使用IPC提供的 getCallingPid 、 getCallingUid 、 getCallingTokenId 方法获取访问者信息来进行权限校验。

   import Extension from '@ohos.application.DataShareExtensionAbility';
   import {
         UpdateOperation } from '@ohos.application.DataShareExtensionAbility';
   import dataSharePredicates from '@ohos.data.dataSharePredicates';
   import relationalStore from '@ohos.data.relationalStore';
   import Want from '@ohos.app.ability.Want';
   import {
         BusinessError } from '@ohos.base'
   

4. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。

   const DB_NAME = 'DB00.db';
   const TBL_NAME = 'TBL00';
   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: relationalStore.RdbStore;
   let result: string;
   
   export default class DataShareExtAbility extends Extension {
        
     // 重写onCreate接口
     onCreate(want: Want, callback: Function) {
        
       result = this.context.cacheDir + '/datashare.txt';
       // 业务实现使用RDB
       relationalStore.getRdbStore(this.context, {
        
         name: DB_NAME,
         securityLevel: relationalStore.SecurityLevel.S1
       }, (err, data) => {
        
         rdbStore = data;
         rdbStore.executeSql(DDL_TBL_CREATE, [], (err) => {
        
           console.info(`DataShareExtAbility onCreate, executeSql done err:${
          err}`);
         });
         if (callback) {
        
           callback();
         }
       });
     }
   
     // 重写query接口
     query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: Function)