HarmonyOS 应用开发之通过数据管理服务实现数据共享静默访问

场景介绍

典型跨应用访问数据的用户场景下，数据提供方会存在多次被拉起的情况。

为了降低数据提供方拉起次数，提高访问速度，OpenHarmony提供了一种不拉起数据提供方直接访问数据库的方式，即静默数据访问。

静默数据访问通过数据管理服务进行数据的访问和修改，无需拉起数据提供方。

数据管理服务仅支持数据库的基本访问或数据托管，如果有业务处理，需要将业务处理封装成接口，给数据访问方调用。

如果业务过于复杂，无法放到数据访问方，建议通过DataShareExtensionAbility 拉起数据提供方实现功能。

运作机制

可以通过数据管理服务进行代理访问的数据分为以下三种：

持久化数据：归属于数据提供方的数据库，这类数据存储于数据提供方的沙箱，可以在数据提供方中通过声明的方式进行共享，按表为粒度配置为可以被其他应用访问的数据表。
过程数据：托管在数据管理服务上的过程数据，这类数据存储于数据管理服务的沙箱，格式为json或byte数据，无人订阅10天后自动删除。
动态数据：托管在设备上的动态数据，这类数据存储于内存中，设备重启之后自动删除。只限于调用enableSilentProxy和disableSilentProxy接口设置的数据。

数据类型	存储位置	数据格式	有效期	适用场景
持久化数据	数据提供方的沙箱	数据库中的数据表	永久存储	适用于数据格式类似关系型数据库的相关场景，如日程，会议等
过程数据	数据管理服务的沙箱	json或byte数据	无人订阅10天后自动删除	适用于数据有时效性且数据格式较简单的相关场景，如步数，天气，心率等
动态数据	数据管理服务的内存	key-value数据	设备重启之后自动删除	适用于动态关闭/打开静默访问通道的场景。例如：升级过程中为了保证数据正确性可以动态关闭静默访问，升级结束后再调用相关接口打开静默访问。调用接口生成的开启关闭状态，设备重启之后会清除。只限于调用enableSilentProxy和disableSilentProxy接口设置的数据

图1 静默数据访问视图

和跨应用数据共享方式不同的是，静默数据访问借助数据管理服务通过目录映射方式直接读取数据提供方的配置，按规则进行预处理后，并访问数据库。
数据访问方如果使用静默数据访问方式，URI需严格按照如下格式：
datashareproxy://{bundleName}/{dataPath}

数据管理服务会读取对应bundleName作为数据提供方应用，读取配置，进行权限校验并访问对应数据。

dataPath为数据标识，可以自行定义，在同一个数据提供方应用中需要保持唯一。

约束与限制

目前持久化数据中仅关系型数据库支持静默数据访问方式。
整个系统最多同时并发16路查询，有多出来的查询请求需要排队处理。
持久化数据不支持代理创建数据库，如果需要创建数据库，需要拉起数据提供方。
数据提供方如果是normal级别签名的应用，配置的数据读写权限必须为system_basic及以上权限。

接口说明

以下是静默数据访问的相关接口，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以callback形式为例，更多接口及使用方式请见数据共享。

通用接口

接口名称	描述
createDataShareHelper(context: Context, uri: string, options: DataShareHelperOptions, callback: AsyncCallback<DataShareHelper>): void	创建DataShareHelper实例。

持久化数据

接口名称	描述
insert(uri: string, value: ValuesBucket, callback: AsyncCallback<number>): void	向目标表中插入一行数据。
delete(uri: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>): void	从数据库中删除一条或多条数据记录。
query(uri: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<DataShareResultSet>): void	查询数据库中的数据。
update(uri: string, predicates: dataSharePredicates.DataSharePredicates, value: ValuesBucket, callback: AsyncCallback<number>): void	更新数据库中的数据记录。
addTemplate(uri: string, subscriberId: string, template: Template): void	添加一个指定订阅者的数据模板。
on(type: ‘rdbDataChange’, uris: Array<string>, templateId: TemplateId, callback: AsyncCallback<RdbDataChangeNode>): Array<OperationResult	订阅指定URI和模板对应的数据变更事件。

过程数据

接口名称	描述
publish(data: Array<PublishedItem>, bundleName: string, version: number, callback: AsyncCallback<Array<OperationResult>>): void	发布数据，将数据托管至数据管理服务。
on(type: ‘publishedDataChange’, uris: Array<string>, subscriberId: string, callback: AsyncCallback<PublishedDataChangeNode>): Array<OperationResult>	订阅已发布数据的数据变更通知。

动态数据

接口名称	描述
enableSilentProxy(context: Context, uri?: string): Promise<void>	数据提供方动态开启静默访问。当访问方通过静默访问调用DataShare相关接口的时候，校验静默访问的开关状态。如果静默访问的是开启的，DataShare相关接口会执行原逻辑。
disableSilentProxy(context: Context, uri?: string): Promise<void>	数据提供方来动态关闭静默访问。当访问方通过静默访问调用DataShare相关接口的时候，校验静默访问的开关状态。如果静默访问的是关闭的，DataShare相关接口接口将会直接返回。

持久化数据实现说明

首先，以共享一个关系型数据库为例，说明开发步骤。

数据提供方应用的开发

数据提供方需要在module.json5中的proxyData节点定义要共享的表的标识，读写权限和基本信息，配置方法可考参考配置文件。

表1 module.json5中proxyData节点对应的属性字段

属性名称	备注说明	必填
uri	数据使用的URI，是跨应用数据访问的唯一标识。	是
requiredReadPermission	标识从该数据代理读取数据时所需要的权限，不配置默认不允许其他APP访问数据。支持权限可参考权限列表。	否
requiredWritePermission	标识从该数据代理修改数据时所需要的权限，不配置默认不允许其他APP修改数据。支持权限可参考权限列表。	否
metadata	数据源的信息，包含name和resource字段。 name类型固定为"dataProperties"，是配置的唯一标识。 resource类型固定为"$profile:{fileName}"，表示配置文件的名称为{fileName}.json。	是

module.json5配置样例：

"proxyData":[
  {
    "uri": "datashareproxy://com.acts.ohos.data.datasharetest/test",
    "requiredReadPermission": "ohos.permission.GET_BUNDLE_INFO",
    "requiredWritePermission": "ohos.permission.KEEP_BACKGROUND_RUNNING",
    "metadata": {
      "name": "dataProperties",
      "resource": "$profile:my_config"
    }
  }
]

表2 my_config.json对应属性字段

属性名称	备注说明	必填
path	指定数据源路径，目前支持关系型数据库，配置为库名/表名	是
type	标识数据库类型，目前支持配置为rdb，表示关系型数据库。	是
scope	数据库所在范围。 1.module表示数据库位于本模块下； 2.application表示数据库位于本应用下。	否

my_config.json配置样例

{
  "path": "DB00/TBL00",
  "type": "rdb",
  "scope": "application"
}

数据访问方应用的开发

导入基础依赖包。

import dataShare from '@ohos.data.dataShare';
import dataSharePredicates from '@ohos.data.dataSharePredicates';
import UIAbility from '@ohos.app.ability.UIAbility';
import { ValuesBucket } from '@ohos.data.ValuesBucket';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

定义与数据提供方通信的URI字符串。

let dseUri = ('datashareproxy://com.acts.ohos.data.datasharetest/test');

创建工具接口类对象。

let dsHelper: dataShare.DataShareHelper | undefined = undefined;
let abilityContext: Context;

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    abilityContext = this.context;
    dataShare.createDataShareHelper(abilityContext, dseUri, {
      isProxy: true
    }, (err, data) => {
      dsHelper = data;
    });
  }
}

获取到接口类对象后，便可利用其提供的接口访问提供方提供的服务，如进行数据的增、删、改、查等。

// 构建一条数据
let key1 = 'name';
let key2 = 'age';
let key3 = 'isStudent';
let key4 = 'Binary';
let valueName1 = 'ZhangSan';
let valueName2 = 'LiSi';
let valueAge1 = 21;
let valueAge2 = 18;
let valueIsStudent1 = false;
let valueIsStudent2 = true;
let valueBinary = new Uint8Array([1, 2, 3]);
let valuesBucket: ValuesBucket = { key1: valueName1, key2: valueAge1, key3: valueIsStudent1, key4: valueBinary };
let updateBucket: ValuesBucket = { key1: valueName2, key2: valueAge2, key3: valueIsStudent2, key4: valueBinary };
let predicates = new dataSharePredicates.DataSharePredicates();
let valArray = ['*'];
if (dsHelper != undefined) {
  // 插入一条数据
  (dsHelper as dataShare.DataShareHelper).insert(dseUri, valuesBucket, (err, data) => {
    console.info(`dsHelper insert result:${data}`);
  });
  // 更新数据
  (dsHelper as dataShare.DataShareHelper).update(dseUri, predicates, updateBucket, (err, data) => {
    console.info(`dsHelper update result:${data}`);
  });
  // 查询数据
  (dsHelper as dataShare.DataShareHelper).query(dseUri, predicates, valArray, (err, data) => {
    console.info(`dsHelper query result:${data}`);
  });
  // 删除指定的数据
  (dsHelper as dataShare.DataShareHelper).delete(dseUri, predicates, (err, data) => {
    console.info(`dsHelper delete result:${data}`);
  });
}

对指定的数据进行订阅。

function onCallback(err: BusinessError, node: dataShare.RdbDataChangeNode) {
  console.info("uri " + JSON.stringify(node.uri));
  console.info("templateId " + JSON.stringify(node.templateId));
  console.info("data length " + node.data.length);
  for (let i = 0; i < node.data.length; i++) {
    console.info("data " + node.data[i]);
  }
}

let key21: string = "p1";
let value21: string = "select * from TBL00";
let key22: string = "p2";
let value22: string = "select name from TBL00";
let template: dataShare.Template = {
  predicates: {
    key21: value21,
    key22: value22,
  },
  scheduler: ""
}
if(dsHelper != undefined)
{
  (dsHelper as dataShare.DataShareHelper).addTemplate(dseUri, "111", template);
}
let templateId: dataShare.TemplateId = {
  subscriberId: "111",
  bundleNameOfOwner: "com.acts.ohos.data.datasharetestclient"
}
if(dsHelper != undefined) {
  // 使用数据管理服务修改数据时触发onCallback回调，回调内容是template中的规则查到的数据
  let result: Array<dataShare.OperationResult> = (dsHelper as dataShare.DataShareHelper).on("rdbDataChange", [dseUri], templateId, onCallback);
}

过程数据实现说明

以托管一份过程数据为例，说明开发步骤。

数据提供方应用的开发（可选）

数据提供方需要在module.json5中的proxyData节点定义过程数据的标识，读写权限和基本信息，配置方法可考参考配置文件。

注意：

该步骤为可选，可以不对module.json5中的proxyData进行配置。
不配置proxyData时，托管数据不允许其他应用访问。
不配置proxyData时，数据标识可以为简写，发布、订阅、查询数据可以使用简写的数据标识，如weather，可以不用全写为datashareproxy://com.acts.ohos.data.datasharetest/weather

表3 module.json5中proxyData节点对应的属性字段

属性名称	备注说明	必填
uri	数据使用的URI，是跨应用数据访问的唯一标识。	是
requiredReadPermission	标识从该数据代理读取数据时所需要的权限，不配置默认不允许其他APP访问数据。支持权限可参考权限列表。	否
requiredWritePermission	标识从该数据代理修改数据时所需要的权限，不配置默认不允许其他APP访问数据。支持权限可参考权限列表。	否

module.json5配置样例：

"proxyData": [
  {
    "uri": "datashareproxy://com.acts.ohos.data.datasharetest/weather",
    "requiredReadPermission": "ohos.permission.GET_BUNDLE_INFO",
    "requiredWritePermission": "ohos.permission.KEEP_BACKGROUND_RUNNING"
  }
]

数据访问方应用的开发

导入基础依赖包。

import dataShare from '@ohos.data.dataShare';
import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';

定义与数据提供方通信的URI字符串。

let dseUri = ('datashareproxy://com.acts.ohos.data.datasharetest/weather');

创建工具接口类对象。

let dsHelper: dataShare.DataShareHelper | undefined = undefined;
let abilityContext: Context;

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    abilityContext = this.context;
    dataShare.createDataShareHelper(abilityContext, dseUri, {isProxy : true}, (err, data) => {
      dsHelper = data;
    });
  }
}

获取到接口类对象后，便可利用其提供的接口访问提供方提供的服务，如进行数据的增、删、改、查等。

// 构建两条数据，第一条为免配置的数据，仅自己使用
let data : Array<dataShare.PublishedItem> = [
  {key:"city", subscriberId:"11", data:"xian"},
  {key:"datashareproxy://com.acts.ohos.data.datasharetest/weather", subscriberId:"11", data:JSON.stringify("Qing")}];
// 发布数据
if (dsHelper != undefined) {
  let result: Array<dataShare.OperationResult> = await (dsHelper as dataShare.DataShareHelper).publish(data, "com.acts.ohos.data.datasharetestclient");
}

对指定的数据进行订阅。

function onPublishCallback(err: BusinessError, node:dataShare.PublishedDataChangeNode) {
  console.info("onPublishCallback");
}
let uris:Array<string> = ["city", "datashareproxy://com.acts.ohos.data.datasharetest/weather"];
if (dsHelper != undefined) {
  let result: Array<dataShare.OperationResult> = (dsHelper as dataShare.DataShareHelper).on("publishedDataChange", uris, "11", onPublishCallback);
}

动态数据实现说明

动态数据实现静默访问只针对数据提供方。以动态开启静默访问为例，说明开发步骤。

数据提供方应用的开发

数据提供方调用开启动态开启静默访问接口，来开启静默访问功能。此接口是搭配data_share_config.json文件中isSilentProxyEnable字段进行工作的。支持的配置可参考data_share_config.json配置

注意：

该步骤为可选，可以不对data_share_config.json文件中isSilentProxyEnable字段进行配置，默认为true，默认为开启静默访问功能。
校验静默访问是否开启，会优先校验enableSilentProxy/disableSilentProxy接口设置的开关状态，其次会校验data_share_config.json文件中isSilentProxyEnable字段。
不调用enableSilentProxy/disableSilentProxy接口时，优先会校验data_share_config.json文件中isSilentProxyEnable字段。
不调用enableSilentProxy/disableSilentProxy接口，也不配置data_share_config.json文件中isSilentProxyEnable字段时，默认静默访问是开启的。

导入基础依赖包。

import dataShare from '@ohos.data.dataShare';
import UIAbility from '@ohos.app.ability.UIAbility';
import window from '@ohos.window';

定义与数据提供方通信的URI字符串。

let dseUri = ('datashare:///com.acts.datasharetest/entry/DB00/TBL00');

创建工具接口类对象。

let abilityContext: Context;

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    abilityContext = this.context;
    dataShare.enableSilentProxy(abilityContext, dseUri);
  }
}