鸿蒙 Ability 讲解(Data Ability讲解)
四、Data Ability讲解
使用 Data 模板的 Ability(以下简称“Data”)有助于应用管理其自身和其他应用存储数据的访问,并提供与其他应用共享数据的方法。Data 既可用于同设备不同应用的数据共享,也支持跨设备不同应用的数据共享。
数据的存放形式多样,可以是数据库,也可以是磁盘上的文件。Data 对外提供对数据的增、删、改、查,以及打开文件等接口,这些接口的具体实现由开发者提供。说起来和Android的ContentProvider有些像。
① URI 介绍
Data 的提供方和使用方都通过 URI(Uniform Resource Identifier)来标识一个具体的数据,例如数据库中的某个表或磁盘上的某个文件。HarmonyOS 的 URI 仍基于 URI 通用标准,格式如下:
- scheme:协议方案名,固定为“dataability”,代表 Data Ability 所使用的协议类型。
- authority:设备 ID,如果为跨设备场景,则为目的设备的 IP 地址;如果为本地设备场景,则不需要填写。
- path:资源的路径信息,代表特定资源的位置信息。
- query:查询参数。
- fragment:可以用于指示要访问的子资源。
URI 示例:
跨设备场景:dataability://device_id/com.huawei.dataability.persondata/person/10
本地设备:dataability:///com.huawei.dataability.persondata/person/10
② 访问 Data和声明使用权限
开发者可以通过 DataAbilityHelper 类来访问当前应用或其他应用提供的共享数据。
DataAbilityHelper 作为客户端,与提供方的 Data 进行通信。Data 接收到请求后,执行相应的处理,并返回结果。DataAbilityHelper 提供了一系列与 Data Ability 对应的方法。reqPermissions 表示应用运行时向系统申请的权限。
说了这么多还是来创建一个Data Ability吧,鼠标右键包名 → New → Ability → Empty Data Ability这个的Visible和Service的Visible是同样的意思,勾选上就是运行其他应用程序访问数据。
然后打开config.json,看创建DataAbility时,自动生成了那些代码。
可以看到type为“data”,另外还自带一个提供给外部数据的权限,已经访问这个DataAbility的uri。
然后看一下DataAbility的代码:
在创建的时候就生成了一些代码,基本的增删改查、打开文件、获取URI类型、获取文件类型、还有一个回调。再加上一个onStart方法,总共是9个,乍一看比较多。下面先来介绍 DataAbilityHelper 具体的使用步骤。
创建 DataAbilityHelper
DataAbilityHelper 为开发者提供了 creator()方法来创建 DataAbilityHelper 实例。该方法为静态方法,有多个重载。最常见的方法是通过传入一个 context 对象来创建DataAbilityHelper 对象。
DataAbilityHelper 为开发者提供了一系列的接口来访问不同类型的数据(文件、数据库等)。
- 访问文件
DataAbilityHelper 为开发者提供了 FileDescriptor openFile(Uri uri, String mode)方法来操作文件。此方法需要传入两个参数,其中 uri 用来确定目标资源路径,mode 用来指定打开文件的方式,可选方式包含“r”(读), “w”(写), “rw”(读写),“wt”(覆盖写),“wa”(追加写),“rwt”(覆盖写且可读)。该方法返回一个目标文件的 FD(文件描述符),把文件描述符封装成流,开发者就可以对文件流进行自定义处理。比如:
- 访问数据库
DataAbilityHelper 为开发者提供了增、删、改、查以及批量处理等方法来操作数据库。
下面代码来说明一下: - query 查询方法,其中 uri 为目标资源路径,columns 为想要查询的字段。开发者的查询条件可以通过 DataAbilityPredicates 来构建。查询用户表中 id 在 1-10 之间的用户的年龄,并把结果打印出来,代码示例如下:
insert 插入方法,其中 uri 为目标资源路径,ValuesBucket 为要新增的对象。插入一条用户信息的代码示例如下:
batchInsert 批量插入方法,和 insert()类似。批量插入用户信息的代码示例如下:
delete 删除方法,其中删除条件可以通过 DataAbilityPredicates 来构建。删除用户表中 id 在 1-10 之间的用户,代码示例如下:
update 更新方法,更新数据由 ValuesBucket 传入,更新条件由 DataAbilityPredicates 来构建。更新 id 为 2 的用户,代码示例如下:
executeBatch 此方法用来执行批量操作。DataAbilityOperation 中提供了设置操作类型、数据和操作条件的方法,开发者可自行设置自己要执行的数据库操作。插入多条数据的代码示例如下:
③ 创建Data
确定数据存储方式
确定数据的存储方式,Data 支持以下两种数据形式:
文件数据:如文本、图片、音乐等。
结构化数据:如数据库等。
下面创建一个UserDataAbility,注意勾选上Visible实现 UserDataAbility
UserDataAbility 接收其他应用发送的请求,提供外部程序访问的入口,从而实现应用间的数据访问。Data 提供了文件存储和数据库存储两组接口供用户使用。
文件存储
开发者需要在 Data 中重写 FileDescriptor openFile(Uri uri, String mode)方法来操作文件:uri 为客户端传入的请求目标路径;mode 为开发者对文件的操作选项,可选方式包含“r”(读), “w”(写), “rw”(读写)等。
MessageParcel 类提供了一个静态方法,用于获取 MessageParcel 实例。通过dupFileDescriptor()函数复制待操作文件流的文件描述符,并将其返回,供远端应用使用。示例,根据传入uri打开对应的文件,在UserDataAbility中写入如下方法
数据库存储
初始化数据库连接。系统会在应用启动时调用 onStart()方法创建 Data 实例。在此方法中,开发者应该创建数据库连接,并获取连接对象,以便后续和数据库进行操作。为了避免影响应用启动速度,开发者应当尽可能将非必要的耗时任务推迟到使用时执行,而不是在此方法中执行所有初始化。示例:
初始化的时候连接数据库。
首先要创建一个数据实体bean
然后在UserDataAbility中如下:上面的代码是官方文档里面的,可以看到这里是有一个地方报错的,因为少了一个参数,然后看一下getOrmContext方法少什么参数。
然后来看一下OrmMigration的源码这是一个抽象类,可以通过继承的方式去实现它里面的方法。
下面我创建一个TestOrmContext1继承OrmMigration,里面的代码如下:
其实这个方法的意思就是在连接数据库的时候查询数据库的版本,决定是否要升级。
因为加了也报错,那么我为什么不加上去呢?你以为加上去就不报错了吗?我是不得其解,也许是我才疏学浅吧.编写数据库操作方法
Ability 定义了 6 个方法供用户处理对数据库表数据的增删改查。
先创建一个用户的实体
query 该方法接收三个参数,分别是查询的目标路径,查询的列名,以及查询条件,查询条件由类DataAbilityPredicates 构建。根据传入的列名和查询条件查询用户表的代码示例如下:可以看到创建Data Ability的时候就会自动生成这个方法,下面的代码就在这个方法里面写:
insert 该方法接收两个参数,分别是插入的目标路径和插入的数据值。其中,插入的数据由ValuesBucket 封装,服务端可以从该参数中解析出对应的属性,然后插入到数据库中。此方法返回一个 int 类型的值用于标识结果。接收到传过来的用户信息并把它保存到数据库中的代码示例如下:
batchInsert 该方法为批量插入方法,接收一个 ValuesBucket 数组用于单次插入一组对象。它的作用是提高插入多条重复数据的效率。该方法系统已实现,开发者可以直接调用。
delete 该方法用来执行删除操作。删除条件由类 DataAbilityPredicates 构建,服务端在接收到该参数之后可以从中解析出要删除的数据,然后到数据库中执行。根据传入的条件删除用户表数据的代码示例如下:
update 此方法用来执行更新操作。用户可以在 ValuesBucket 参数中指定要更新的数据,在DataAbilityPredicates 中构建更新的条件等。更新用户表的数据的代码示例如下:
executeBatch 此方法用来批量执行操作。DataAbilityOperation 中提供了设置操作类型、数据和操作条件的方法,用户可自行设置自己要执行的数据库操作。该方法系统已实现,开发者可以直接调用。
五、结语
说实话写这一篇文章花费了一番功夫,不断的浏览官网上的文档然后结合实际来写,写的不是很好,请勿见怪,另外就是觉得官网的教程只是一部分,更多的需要开发者自行去探索和发现,正所谓师傅领进门,修行在个人,鸿蒙需要成长,我们开发者同样也要成长,也许不会前进的路上会很坎坷,但经历过后就会发现另一番风景,我是初学者,保持初学的态度和动力,感谢您的阅读,山高水长,后会有期!
你的BookStore 好像集成错了,看源码 <T extends OrmDatabase>,应该集成OrmDatabase