DataAbility开发指导

场景介绍

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

Data提供方可以自定义数据的增、删、改、查，以及文件打开等功能，并对外提供这些接口。

接口说明

表1 Data中相关生命周期功能介绍

接口名	描述
onInitialized	在Ability初始化调用，通过此回调方法执行rdb等初始化操作。
update	更新数据库中的数据。
query	查询数据库中的数据。
delete	删除一条或多条数据。
normalizeUri	对uri进行规范化。一个规范化的uri可以支持跨设备使用、持久化、备份和还原等，当上下文改变时仍然可以引用到相同的数据项。
batchInsert	向数据库中插入多条数据。
denormalizeUri	将一个由normalizeUri生产的规范化uri转换成非规范化的uri。
insert	向数据中插入一条数据。
openFile	打开一个文件。
getFileTypes	获取文件的MIME类型。
getType	获取uri指定数据相匹配的MIME类型。
executeBatch	批量操作数据库中的数据。
call	自定义方法。

开发步骤

创建Data

需要实现Data中Insert、Query、Update、Delete接口的业务内容。保证能够满足数据库存储业务的基本需求。BatchInsert与ExecuteBatch接口已经在系统中实现遍历逻辑，依赖Insert、Query、Update、Delete接口逻辑，来实现数据的批量处理。

创建Data的代码示例如下：

 export default {
 onInitialized(abilityInfo) {
     console.info('DataAbility onInitialized, abilityInfo:' + abilityInfo.bundleName)
     dataRdb.getRdbStore(STORE_CONFIG, 1, (err, store) => {
         console.info('DataAbility getRdbStore callback')
         store.executeSql(SQL_CREATE_TABLE, [])
         rdbStore = store
     });
 },
 insert(uri, valueBucket, callback) {
     console.info('DataAbility insert start')
     rdbStore.insert(TABLE_NAME, valueBucket, callback)
 },
 batchInsert(uri, valueBuckets, callback) {
     console.info('DataAbility batch insert start')
     for (let i = 0;i < valueBuckets.length; i++) {
         console.info('DataAbility batch insert i=' + i)
         if (i < valueBuckets.length - 1) {
             rdbStore.insert(TABLE_NAME, valueBuckets[i], (num: number) => {
                 console.info('DataAbility batch insert ret=' + num)
             })
         } else {
             rdbStore.insert(TABLE_NAME, valueBuckets[i], callback)
         }
     }
 },
 query(uri, columns, predicates, callback) {
     console.info('DataAbility query start')
     let rdbPredicates = dataAbility.createRdbPredicates(TABLE_NAME, predicates)
     rdbStore.query(rdbPredicates, columns, callback)
 },
 update(uri, valueBucket, predicates, callback) {
     console.info('DataAbilityupdate start')
     let rdbPredicates = dataAbility.createRdbPredicates(TABLE_NAME, predicates)
     rdbStore.update(valueBucket, rdbPredicates, callback)
 },
 delete(uri, predicates, callback) {
     console.info('DataAbilitydelete start')
     let rdbPredicates = dataAbility.createRdbPredicates(TABLE_NAME, predicates)
     rdbStore.delete(rdbPredicates, callback)
 }
 };

子系统配置

Json重要字段	备注说明
"name"	Ability名称，对应Ability派生的Data类名。
"type"	Ability类型，Data对应的Ability类型为”data“。
"uri"	通信使用的URI。
"visible"	对其他应用是否可见，设置为true时，Data才能与其他应用进行通信传输数据。

config.json配置样例

"abilities":[{
 "srcPath": "DataAbility",
 "name": ".DataAbility",
 "icon": "$media:icon",
 "srcLanguage": "ets",
 "description": "$string:description_dataability",
 "type": "data",
 "visible": true,
 "uri": "dataability://ohos.samples.etsdataability.DataAbility"    
}]

访问Data

开发前准备

需导入基础依赖包，以及获取与Data子模块通信的Uri字符串。

其中，基础依赖包包括：

@ohos.ability.featureAbility
@ohos.data.dataability
@ohos.data.rdb

DataAbility接口开发指导

创建工具接口类对象。

工具接口类对象DataAbilityHelper相关接口可参考DataAbilityHelper模块。

// 作为参数传递的Uri,与config中定义的Uri的区别是多了一个"/",是因为作为参数传递的uri中,在第二个与第三个"/"中间,存在一个DeviceID的参数
var urivar = "dataability:///com.ix.DataAbility"
var DAHelper = featureAbility.acquireDataAbilityHelper(
 urivar
);

构建数据库相关的rdb数据。

var valuesBucket = {"name": "gaolu"}
var da = new ohos_data_ability.DataAbilityPredicates()
var valArray =new Array("value1");
var cars = new Array({"batchInsert1" : "value1",});

调用insert方法向指定的Data子模块插入数据。

// callback方式调用:
DAHelper.insert(
 urivar,
 valuesBucket,
 (error, data) => {
     expect(typeof(data)).assertEqual("number")
 }
);

// promise方式调用:
var datainsert = await DAHelper.insert(
 urivar,
 valuesBucket
);

调用delete方法删除Data子模块中指定的数据。

// callback方式调用:
DAHelper.delete(
 urivar,
 da,
 (error, data) => {
     expect(typeof(data)).assertEqual("number")
 }
);

// promise方式调用:
var datadelete = await DAHelper.delete(
 urivar,
 da,
);

调用update方法更新指定Data子模块中的数据。

// callback方式调用:
DAHelper.update(
 urivar
 valuesBucket,
 da,
 (error, data) => {
     expect(typeof(data)).assertEqual("number")
 }
);

// promise方式调用:
var dataupdate = await DAHelper.update(
 urivar,
 valuesBucket,
 da,
);

调用query方法在指定的Data子模块中查找数据。

// callback方式调用:
DAHelper.query(
 urivar,
 valArray,
 da,
 (error, data) => {
     expect(typeof(data)).assertEqual("object")
 }
);

// promise方式调用:
var dataquery = await DAHelper.query(
 urivar,
 valArray,
 da
);

调用batchInsert方法向指定的数据子系统批量插入数据。

// callback方式调用:
DAHelper.batchInsert(
 urivar,
 cars,
 (error, data) => {
     expect(typeof(data)).assertEqual("number")
 }
);

// promise方式调用:
var databatchInsert = await DAHelper.batchInsert(
 urivar,
 cars
);

调用executeBatch方法向指定的Data子模块进行数据的批量处理。

// callbacke方式调用:
DAHelper.executeBatch(
 urivar,
 [
     {
         uri: urivar,
         type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
         valuesBucket: {"executeBatch" : "value1",},
         predicates: da,
         expectedCount:0,
         PredicatesBackReferences: {},
         interrupted:true,
     }
 ],
 (error, data) => {
     expect(typeof(data)).assertEqual("object")
 }
);

// promise方式调用:
var dataexecuteBatch = await DAHelper.executeBatch(
 urivar,
 [
     {
         uri: urivar,
         type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
         valuesBucket:
         {
             "executeBatch" : "value1",
         },
         predicates: da,
         expectedCount:0,
         PredicatesBackReferences: {},
         interrupted:true,
     }
 ]
);