devbox
凡人多烦事01
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

鸿蒙开发-基础开发Data Ability（六）_鸿蒙 dataability权限控制配置

作者：凡人多烦事01 | 2024-03-14 19:27:30

赞

踩

鸿蒙 dataability权限控制配置

一、基本概念

使用Data模板的Ability（以下简称“Data”）有助于应用管理其自身和其他应用存储数据的访问，并提供与其他应用共享数据的方法。Data既可用于同设备不同应用的数据共享，也支持跨设备不同应用的数据共享。

数据的存放形式多样，可以是数据库，也可以是磁盘上的文件。Data对外提供对数据的增、删、改、查，以及打开文件等接口，这些接口的具体实现由开发者提供。

URI介绍

Data的提供方和使用方都通过URI（Uniform Resource Identifier）来标识一个具体的数据，例如数据库中的某个表或磁盘上的某个文件。HarmonyOS的URI仍基于URI通用标准，格式如下：

  • scheme：协议方案名，固定为“dataability”，代表Data Ability所使用的协议类型。
  • authority：设备ID。如果为跨设备场景，则为目标设备的ID；如果为本地设备场景，则不需要填写。
  • 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对应的方法。

下面介绍DataAbilityHelper具体的使用步骤。

声明使用权限

如果待访问的Data声明了访问需要权限，则访问此Data需要在配置文件中声明需要此权限。声明请参考权限申请字段说明。

  1. "reqPermissions": [
  2. {
  3. "name": "com.example.myapplication5.DataAbility.DATA"
  4. }
  5. ]

创建DataAbilityHelper

DataAbilityHelper为开发者提供了creator()方法来创建DataAbilityHelper实例。该方法为静态方法，有多个重载。最常见的方法是通过传入一个context对象来创建DataAbilityHelper对象。

获取helper对象示例：

 
  1. DataAbilityHelper helper = DataAbilityHelper.creator(this);

访问Data Ability

DataAbilityHelper为开发者提供了一系列的接口来访问不同类型的数据（文件、数据库等）。

  • 访问文件

    DataAbilityHelper为开发者提供了FileDescriptor openFile​(Uri uri, String mode)方法来操作文件。此方法需要传入两个参数，其中uri用来确定目标资源路径，mode用来指定打开文件的方式，可选方式包含“r”(读), “w”(写), “rw”(读写)，“wt”(覆盖写)，“wa”(追加写)，“rwt”(覆盖写且可读)。

    该方法返回一个目标文件的FD（文件描述符），把文件描述符封装成流，开发者就可以对文件流进行自定义处理。

    访问文件示例：

     
    1. // 读取文件描述符
    2. FileDescriptor fd = helper.openFile(uri, "r");
    3. FileInputStream fis = new FileInputStream(fd);
  • 访问数据库DataAbilityHelper为开发者提供了增、删、改、查以及批量处理等方法来操作数据库。

    方法

    描述

    ResultSet query​(Uri uri, String[] columns, DataAbilityPredicates predicates)

    查询数据库

    int insert​(Uri uri, ValuesBucket value)

    向数据库中插入单条数据

    int batchInsert​(Uri uri, ValuesBucket[] values)

    向数据库中插入多条数据

    int delete​(Uri uri, DataAbilityPredicates predicates)

    删除一条或多条数据

    int update​(Uri uri, ValuesBucket value, DataAbilityPredicates predicates)

    更新数据库

    DataAbilityResult[] executeBatch​(ArrayList<DataAbilityOperation> operations)

    批量操作数据库

    这些方法的使用说明如下：
    • query()

      查询方法，其中uri为目标资源路径，columns为想要查询的字段。开发者的查询条件可以通过DataAbilityPredicates来构建。查询用户表中id在101-103之间的用户，并把结果打印出来，代码示例如下：

  1. DataAbilityHelper helper = DataAbilityHelper.creator(this);
  2.  
  3. // 构造查询条件
  4. DataAbilityPredicates predicates = new DataAbilityPredicates();
  5. predicates.between("userId", 101, 103);
  6.  
  7. // 进行查询
  8. ResultSet resultSet = helper.query(uri,columns,predicates);
  9.  
  10. // 处理结果
  11. resultSet.goToFirstRow();
  12. do{
  13. // 在此处理ResultSet中的记录;
  14. }while(resultSet.goToNextRow());
    • insert()

      新增方法，其中uri为目标资源路径，ValuesBucket为要新增的对象。插入一条用户信息的代码示例如下：

  1. DataAbilityHelper helper = DataAbilityHelper.creator(this);
  2.  
  3. // 构造插入数据
  4. ValuesBucket valuesBucket = new ValuesBucket();
  5. valuesBucket.putString("name", "Tom");
  6. valuesBucket.putInteger("age", 12);
  7. helper.insert(uri, valuesBucket);
    • batchInsert(）

      批量插入方法，和insert()类似。批量插入用户信息的代码示例如下：

      1. DataAbilityHelper helper = DataAbilityHelper.creator(this);
      2.  
      3. // 构造插入数据
      4. ValuesBucket[] values = new ValuesBucket[2];
      5. value[0] = new ValuesBucket();
      6. value[0].putString("name", "Tom");
      7. value[0].putInteger("age", 12);
      8. value[1] = new ValuesBucket();
      9. value[1].putString("name", "Tom1");
      10. value[1].putInteger("age", 16);
      11. helper.batchInsert(uri, values);

       

    • delete()

      删除方法，其中删除条件可以通过DataAbilityPredicates来构建。删除用户表中id在101-103之间的用户，代码示例如下：

       
      1. DataAbilityHelper helper = DataAbilityHelper.creator(this);
      2.  
      3. // 构造删除条件
      4. DataAbilityPredicates predicates = new DataAbilityPredicates();
      5. predicates.between("userId", 101,103);
      6. helper.delete(uri,predicates);

       

    • update()

      更新方法，更新数据由ValuesBucket传入，更新条件由DataAbilityPredicates来构建。更新id为102的用户，代码示例如下：

       
      1. DataAbilityHelper helper = DataAbilityHelper.creator(this);
      2.  
      3. // 构造更新条件
      4. DataAbilityPredicates predicates = new DataAbilityPredicates();
      5. predicates.equalTo("userId",102);
      6.  
      7. // 构造更新数据
      8. ValuesBucket valuesBucket = new ValuesBucket();
      9. valuesBucket.putString("name", "Tom");
      10. valuesBucket.putInteger("age", 12);
      11. helper.update(uri, valuesBucket, predicates);

       

    • executeBatch()

      此方法用来执行批量操作。DataAbilityOperation中提供了设置操作类型、数据和操作条件的方法，开发者可自行设置自己要执行的数据库操作。插入多条数据的代码示例如下：

三、创建Data

使用Data模板的Ability形式仍然是Ability，因此，开发者需要为应用添加一个或多个Ability的子类，来提供程序与其他应用之间的接口。Data为结构化数据和文件提供了不同API接口供用户使用，因此，开发者需要首先确定好使用何种类型的数据。本章节主要讲述了创建Data的基本步骤和需要使用的接口。

确定数据存储方式

确定数据的存储方式，Data支持以下两种数据形式：

  • 文件数据：如文本、图片、音乐等。
  • 结构化数据：如数据库等。

实现UserDataAbility

UserDataAbility接收其他应用发送的请求，提供外部程序访问的入口，从而实现应用间的数据访问。Data提供了文件存储和数据库存储两组接口供用户使用。

文件存储

开发者需要在Data中重写FileDescriptor openFile​(Uri uri, String mode)方法来操作文件：uri为客户端传入的请求目标路径；mode为开发者对文件的操作选项，可选方式包含“r”(读), “w”(写), “rw”(读写)等。

MessageParcel类提供了一个静态方法，用于获取MessageParcel实例。通过dupFileDescriptor()函数复制待操作文件流的文件描述符，并将其返回，供远端应用使用。

示例：根据传入的uri打开对应的文件

  1. // 创建messageParcel
  2. MessageParcel messageParcel = MessageParcel.obtain();
  3. File file = new File(uri.getDecodedPathList().get(1));
  4. if (mode == null || !"rw".equals(mode)) {
  5. file.setReadOnly();
  6. }
  7. FileInputStream fileIs = new FileInputStream(file);
  8. FileDescriptor fd = fileIs.getFD();
  9.  
  10. // 绑定文件描述符
  11. return messageParcel.dupFileDescriptor(fd);

数据库存储

  1. 初始化数据库连接。

    系统会在应用启动时调用onStart()方法创建Data实例。在此方法中，开发者应该创建数据库连接，并获取连接对象，以便后续和数据库进行操作。为了避免影响应用启动速度，开发者应当尽可能将非必要的耗时任务推迟到使用时执行，而不是在此方法中执行所有初始化。

    示例：初始化的时候连接数据库

     
    1. private static final String DATABASE_NAME ="UserDataAbility.db";
    2. private static final String DATABASE_NAME_ALIAS = "UserDataAbility";
    3. private OrmContext ormContext = null;
    4.  
    5. @Override
    6. public void onStart(Intent intent) {
    7. super.onStart(intent);
    8. DatabaseHelper manager = new DatabaseHelper(this);
    9. ormContext = manager.getOrmContext(DATABASE_NAME_ALIAS, DATABASE_NAME, BookStore.class);
    10. }

     

  2. 编写数据库操作方法。Ability定义了6个方法供用户处理对数据库表数据的增删改查。这6个方法在Ability中已默认实现，开发者可按需重写。

    方法

    描述

    ResultSet query​(Uri uri, String[] columns, DataAbilityPredicates predicates)

    查询数据库

    int insert​(Uri uri, ValuesBucket value)

    向数据库中插入单条数据

    int batchInsert​(Uri uri, ValuesBucket[] values)

    向数据库中插入多条数据

    int delete​(Uri uri, DataAbilityPredicates predicates)

    删除一条或多条数据

    int update​(Uri uri, ValuesBucket value, DataAbilityPredicates predicates)

    更新数据库

    DataAbilityResult[] executeBatch​(ArrayList<DataAbilityOperation> operations)

    批量操作数据库

    这些方法的使用说明如下：
    • query()

      该方法接收三个参数，分别是查询的目标路径，查询的列名，以及查询条件，查询条件由类DataAbilityPredicates构建。根据传入的列名和查询条件查询用户表的代码示例如下：

      1. public ResultSet query(Uri uri, String[] columns, DataAbilityPredicates predicates) {
      2. if (ormContext == null) {
      3. HiLog.error(this.getClass().getSimpleName(), "failed to query, ormContext is null");
      4. return null;
      5. }
      6.  
      7. // 查询数据库
      8. OrmPredicates ormPredicates = DataAbilityUtils.createOrmPredicates(predicates,User.class);
      9. ResultSet resultSet = ormContext.query(ormPredicates, columns);
      10. if (resultSet == null) {
      11. HiLog.info(this.getClass(), "resultSet is null");
      12. }
      13.  
      14. // 返回结果
      15. return resultSet;
      16. }

       

    • insert()

      该方法接收两个参数，分别是插入的目标路径和插入的数据值。其中，插入的数据由ValuesBucket封装，服务端可以从该参数中解析出对应的属性，然后插入到数据库中。此方法返回一个int类型的值用于标识结果。接收到传过来的用户信息并把它保存到数据库中的代码示例如下：

       
      1. public int insert(Uri uri, ValuesBucket value) {
      2. // 参数校验
      3. if (ormContext == null) {
      4. HiLog.error(this.getClass().getSimpleName(), "failed to insert, ormContext is null");
      5. return -1;
      6. }
      7. String path = uri.getPath();
      8.  
      9. if (buildPathMatcher().getPathId(path) != PathId) {
      10. HiLog.info(this.getClass(), "UserDataAbility insert path is not matched");
      11. return -1;
      12. }
      13.  
      14. // 构造插入数据
      15. User user = new User();
      16. user.setUserId(value.getInteger("userId"));
      17. user.setFirstName(value.getString("firstName"));
      18. user.setLastName(value.getString("lastName"));
      19. user.setAge(value.getInteger("age"));
      20. user.setBalance(value.getDouble("balance"));
      21.  
      22. // 插入数据库
      23. boolean isSuccessed = true;
      24. try {
      25. isSuccessed = ormContext.insert(user);
      26. } catch (DataAbilityRemoteException e) {
      27. HiLog.error(TAG, "insert fail: " + e.getMessage());
      28. throw new RuntimeException(e);
      29. }
      30. if (!isSuccessed) {
      31. HiLog.error(this.getClass().getSimpleName(), "failed to insert");
      32. return -1;
      33. }
      34. isSuccessed = ormContext.flush();
      35. if (!isSuccessed) {
      36. HiLog.error(this.getClass().getSimpleName(), "failed to insert flush");
      37. return -1;
      38. }
      39. DataAbilityHelper.creator(this, uri).notifyChange(uri);
      40. int id = Math.toIntExact(user.getRowId());
      41. return id;
      42. }

       

    • batchInsert()

      该方法为批量插入方法，接收一个ValuesBucket数组用于单次插入一组对象。它的作用是提高插入多条重复数据的效率。该方法系统已实现，开发者可以直接调用。

    • delete()

      该方法用来执行删除操作。删除条件由类DataAbilityPredicates构建，服务端在接收到该参数之后可以从中解析出要删除的数据，然后到数据库中执行。根据传入的条件删除用户表数据的代码示例如下：

       
      1. public int delete(Uri uri, DataAbilityPredicates predicates) {
      2. if (ormContext == null) {
      3. HiLog.error(this.getClass().getSimpleName(), "failed to delete, ormContext is null");
      4. return -1;
      5. }
      6.  
      7. OrmPredicates ormPredicates = DataAbilityUtils.createOrmPredicates(predicates,User.class);
      8. int value = ormContext.delete(ormPredicates);
      9. DataAbilityHelper.creator(this, uri).notifyChange(uri);
      10. return value;
      11. }

       

    • update()

      此方法用来执行更新操作。用户可以在ValuesBucket参数中指定要更新的数据，在DataAbilityPredicates中构建更新的条件等。更新用户表的数据的代码示例如下：

       
      1. public int update(Uri uri, ValuesBucket value, DataAbilityPredicates predicates) {
      2. if (ormContext == null) {
      3. HiLog.error(this.getClass().getSimpleName(), "failed to update, ormContext is null");
      4. return -1;
      5. }
      6.  
      7. OrmPredicates ormPredicates = DataAbilityUtils.createOrmPredicates(predicates,User.class);
      8. int index = ormContext.update(ormPredicates, value);
      9. HiLog.info(this.getClass(), "UserDataAbility update value:" + index);
      10. DataAbilityHelper.creator(this, uri).notifyChange(uri);
      11. return index;
      12. }

       

    • executeBatch()

      此方法用来批量执行操作。DataAbilityOperation中提供了设置操作类型、数据和操作条件的方法，用户可自行设置自己要执行的数据库操作。该方法系统已实现，开发者可以直接调用。

注册UserDataAbility

和Service类似，开发者必须在配置配置文件中注册Data。并且配置以下属性：

  • type: 类型设置为data
  • uri: 对外提供的访问路径，全局唯一
  • permissions: 访问该data ability时需要申请的访问权限
  1. {
  2. "name": ".UserDataAbility",
  3. "type": "data",
  4. "visible": true,
  5. "uri": "dataability://com.example.myapplication5.DataAbilityTest",
  6. "permissions": [
  7. "com.example.myapplication5.DataAbility.DATA"
  8. ]
  9. }

 

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/凡人多烦事01/article/detail/236865
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号