核心应用组件系列：数据共享

类似于Android四大组件中的ContentProvider

type
status
date
slug
summary
tags
category
icon
password
跨应用访问数据时，可以通过DataShareExtensionAbility拉起数据提供方的应用以实现对数据的访问。
此种方式支持跨应用拉起数据提供方的DataShareExtension，数据提供方的开发者可以在回调中实现灵活的业务逻辑。用于跨应用复杂业务场景。

运作机制

数据共享可分为数据的提供方和访问方两部分。
  • 数据提供方：DataShareExtensionAbility，可以选择性实现数据的增、删、改、查，以及文件打开等功能，并对外共享这些数据。
  • 数据访问方：由createDataShareHelper()方法所创建的工具类，利用工具类，便可以访问提供方提供的这些数据。
图1 数据共享运作机制
notion image
  • DataShareExtensionAbility模块为数据提供方，实现跨应用数据共享的相关业务。
  • DataShareHelper模块为数据访问方，提供各种访问数据的接口，包括增删改查等。
  • 数据访问方与提供方通过IPC进行通信，数据提供方可以通过数据库实现，也可以通过其他数据存储方式实现。
  • ResultSet模块通过共享内存实现，用于存储查询数据得到的结果集，并提供了遍历结果集的方法。

实现说明

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

DataShareExtensionAbility提供以下API，根据需要重写对应回调方法。
  • onCreate：DataShare客户端连接DataShareExtensionAbility服务端时，服务端需要在此回调中实现初始化业务逻辑，该方法可以选择性重写。
  • insert：业务函数，客户端请求插入数据时回调此接口，服务端需要在此回调中实现插入数据功能，该方法可以选择性重写。
  • update：业务函数，客户端请求更新数据时回调此接口，服务端需要在此回调中实现更新数据功能，该方法可以选择性重写。
  • delete：业务函数，客户端请求删除数据时回调此接口，服务端需要在此回调中实现删除数据功能，该方法可以选择性重写。
  • query：业务函数，客户端请求查询数据时回调此接口，服务端需要在此回调中实现查询数据功能，该方法可以选择性重写。
  • batchInsert：业务函数，客户端请求批量插入数据时回调此接口，服务端需要在此回调中实现批量插入数据的功能，该方法可以选择性重写。
  • normalizeUri：业务函数，客户端给定的URI转换为服务端使用的URI时回调此接口，该方法可以选择性重写。
  • denormalizeUri：业务函数，服务端使用的URI转换为客户端传入的初始URI时服务端回调此接口，该方法可以选择性重写。
开发者在实现一个数据共享服务时，需要在DevEco Studio工程中手动新建一个DataShareExtensionAbility，具体步骤如下。
  1. 在工程Module对应的ets目录下，右键选择“New > Directory”，新建一个目录并命名为DataShareExtAbility。
  1. 在DataShareAbility目录，右键选择“New > TypeScript File”，新建一个TypeScript文件并命名为DataShareExtAbility.ts。
  1. 在DataShareExtAbility.ts文件中，导入
      2. @ohos.application.DataShareExtensionAbility模块，开发者可根据应用需求选择性重写其业务实现。例如数据提供方只提供插入、删除和查询服务，则可只重写这些接口，并导入对应的基础依赖模块。
  1. 数据提供方的业务实现由开发者自定义。例如可以通过数据库、读写文件或访问网络等各方式实现数据提供方的数据存储。
    1. 在module.json5中定义DataShareExtensionAbility。
        2. 表1 module.json5对应属性字段
        属性名称
        备注说明
        必填
        name
        Ability名称，对应Ability派生的ExtensionAbility类名。
        是
        type
        Ability类型，DataShare对应的Ability类型为“dataShare”，表示基于datashare模板开发的。
        是
        uri
        通信使用的URI，是客户端链接服务端的唯一标识。
        是
        exported
        对其他应用是否可见，设置为true时，才能与其他应用进行通信传输数据。
        是
        readPermission
        访问数据时需要的权限，不配置默认不进行读权限校验。
        否
        writePermission
        修改数据时需要的权限，不配置默认不进行写权限校验。
        否
        metadata
        增加静默访问所需的额外配置项，包含name和resource字段。 name类型固定为"ohos.extension.dataShare"，是配置的唯一标识。 resource类型固定为"$profile:data_share_config"，表示配置文件的名称为data_share_config.json。
        若Ability启动模式为"singleton"，则metadata必填，Ability启动模式可见abilities对象的内部结构-launchType；其他情况下无需填写。
        module.json5配置样例：
        表2 data_share_config.json对应属性字段
        属性名称
        备注说明
        必填
        tableConfig
        配置标签。
        是
        uri
        指定配置生效的范围，uri支持以下三种格式，优先级为表配置>库配置>*，如果同时配置，高优先级会覆盖低优先级 。 1. "*" : 所有的数据库和表。 2. "datashare:///{bundleName}/{moduleName}/{storeName}" : 指定数据库。 3. "datashare:///{bundleName}/{moduleName}/{storeName}/{tableName}" : 指定表。
        是
        crossUserMode
        标识数据是否为多用户共享，配置为1则多用户数据共享，配置为2则多用户数据隔离。
        是
        data_share_config.json配置样例
    数据访问方应用的开发 1. 导入基础依赖包。
    2. 定义与数据提供方通信的URI字符串。
    3. 创建工具接口类对象。
    4. 获取到接口类对象后，便可利用其提供的接口访问提供方提供的服务，如进行数据的增删改查等。