DataAbility开发指导

场景介绍

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

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

接口说明

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

开发步骤

创建Data

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

   创建Data的代码示例如下：

    import featureAbility from '@ohos.ability.featureAbility'
    import dataAbility from '@ohos.data.dataAbility'
    import dataRdb from '@ohos.data.rdb'
   
    const TABLE_NAME = 'book'
    const STORE_CONFIG = { name: 'book.db' }
    const SQL_CREATE_TABLE = 'CREATE TABLE IF NOT EXISTS book(id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, introduction TEXT NOT NULL)'
    let rdbStore: dataRdb.RdbStore = undefined
   
    export default {
    onInitialized(abilityInfo) {
        console.info('DataAbility onInitialized, abilityInfo:' + abilityInfo.bundleName)
        let context = featureAbility.getContext()
        dataRdb.getRdbStore(context, 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], (err: any, 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)
    }
    };
   

2. 子模块配置

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接口开发指导

1. 创建工具接口类对象。

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

   // 作为参数传递的URI,与config中定义的URI的区别是多了一个"/",是因为作为参数传递的URI中,在第二个与第三个"/"中间,存在一个DeviceID的参数
   import featureAbility from '@ohos.ability.featureAbility'
   import ohos_data_ability from '@ohos.data.dataAbility'
   import ohos_data_rdb from '@ohos.data.rdb'
   
   var urivar = "dataability:///com.ix.DataAbility"
   var DAHelper = featureAbility.acquireDataAbilityHelper(
    urivar
   );
   

2. 构建数据库相关的RDB数据。

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

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

   // callback方式调用:
   DAHelper.insert(
    urivar,
    valuesBucket,
    (error, data) => {
        console.log("DAHelper insert result: " + data)
    }
   );
   

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

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

   // callback方式调用:
   DAHelper.delete(
    urivar,
    da,
    (error, data) => {
        console.log("DAHelper delete result: " + data)
    }
   );
   

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

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

   // callback方式调用:
   DAHelper.update(
    urivar
    valuesBucket,
    da,
    (error, data) => {
        console.log("DAHelper update result: " + data)
    }
   );
   

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

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

   // callback方式调用:
   DAHelper.query(
    urivar,
    valArray,
    da,
    (error, data) => {
        console.log("DAHelper query result: " + data)
    }
   );
   

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

7. 调用batchInsert方法向指定的数据子模块批量插入数据。

   // callback方式调用:
   DAHelper.batchInsert(
    urivar,
    cars,
    (error, data) => {
        console.log("DAHelper batchInsert result: " + data)
    }
   );
   

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

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

   // callback方式调用:
   DAHelper.executeBatch(
    urivar,
    [
        {
            uri: urivar,
            type: featureAbility.DataAbilityOperationType.TYPE_INSERT,
            valuesBucket: {"executeBatch" : "value1",},
            predicates: da,
            expectedCount:0,
            predicatesBackReferences: null,
            interrupted:true,
        }
    ],
    (error, data) => {
        console.log("DAHelper executeBatch result: " + data)
    }
   );
   

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

相关实例

针对DataAbility开发，有以下相关实例可供参考：

• DataAbility：DataAbility的创建与访问（eTS）（API8）