unified-data-channels.md 5.3 KB
Newer Older
D
dboy190 已提交
1 2 3 4 5
# 标准化数据通路


## 场景介绍

D
dboy190 已提交
6
UDMF定义了安全、标准化的数据接入与读取通路,为各种业务场景(如跨应用跨设备数据拖拽)提供了跨应用、跨设备的数据接入与读取通路,降低业务跨应用、跨设备数据交互的成本。
D
dboy190 已提交
7 8 9 10


## 接口说明

D
dboy190 已提交
11
以下是UDMF标准化数据通路的相关接口,均为异步接口。异步接口均有callback和Promise两种返回形式,下表均以callback形式为例,更多接口及使用方式请见[统一数据管理框架](../reference/apis/js-apis-data-udmf.md)
D
dboy190 已提交
12

D
dboy190 已提交
13 14 15 16 17 18
| 接口名称                                                                                   | 描述                                          | 
|----------------------------------------------------------------------------------------|---------------------------------------------|
| insertData(options: Options, data: UnifiedData, callback: AsyncCallback<string>): void | 将数据写入UDMF的公共存储中,并生成数据的唯一标识符,使用callback异步回调。 | 
| updateData(options: Options, data: UnifiedData, callback: AsyncCallback<void>): void   | 更新已写入UDMF的公共存储的数据,使用callback异步回调。           | 
| queryData(options: Options, callback: AsyncCallback<Array<UnifiedData>>): void         | 查询UDMF公共存储的数据,使用callback异步回调。               | 
| deleteData(options: Options, callback: AsyncCallback<Array<UnifiedData>>): void        | 删除UDMF公共存储的数据,返回删除的数据集,使用callback异步回调。 |
D
dboy190 已提交
19 20 21 22


## 开发步骤

D
dboy190 已提交
23
以一次统一数据对象的插入、更新、查询和删除为例,说明开发步骤,示例代码均采用Callback形式,Promise形式请见。
D
dboy190 已提交
24 25 26 27 28 29

1. 导入`@ohos.data.UDMF`模块

   ```js
   import UDMF from '@ohos.data.UDMF';
   ```
D
dboy190 已提交
30
2. 创建一个统一数据对象并插入到UDMF的公共存储中。
D
dboy190 已提交
31 32

   ```js
D
dboy190 已提交
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
   let plainText = new UDMF.PlainText();
   plainText.textContent = 'hello world!';
   let unifiedData = new UDMF.UnifiedData(plainText);
   
   let options = {
       intention: UDMF.Intention.SUPER_HUB
   }
   try {
       UDMF.insertData(options, unifiedData, (err, data) => {
           if (err === undefined) {
               console.info(`Succeeded in inserting data. key = ${data}`);
           } else {
               console.error(`Failed to insert data. code is ${err.code},message is ${err.message} `);
           }
       });
   } catch(e) {
       console.error(`Insert data throws an exception. code is ${e.code},message is ${e.message} `);
   }
D
dboy190 已提交
51
   ```
D
dboy190 已提交
52
3. 更新上一步骤插入的统一数据对象。
D
dboy190 已提交
53 54 55

   ```js
   let plainText = new UDMF.PlainText();
D
dboy190 已提交
56 57 58 59 60
   plainText.textContent = 'hello world!';
   let unifiedData = new UDMF.UnifiedData(plainText);
   
   let options = {
       key: 'udmf://SuperHub/com.ohos.test/0123456789'
D
dboy190 已提交
61
   };
D
dboy190 已提交
62 63 64 65 66 67 68 69 70 71 72 73
   
   try {
       UDMF.updateData(options, unifiedData, (err) => {
           if (err === undefined) {
               console.info('Succeeded in updating data.');
           } else {
               console.error('Failed to update data. code is ${err.code},message is ${err.message} `);
           }
       });
   } catch(e) {
       console.error(`Update data throws an exception. code is ${e.code},message is ${e.message} `);
   }
D
dboy190 已提交
74
   ```
D
dboy190 已提交
75
4. 查询存储在UDMF公共存储中的统一数据对象。
D
dboy190 已提交
76 77

   ```js
D
dboy190 已提交
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
   let options = {
    intention: UDMF.Intention.SUPER_HUB
   };
   
   try {
       UDMF.queryData(options, (err, data) => {
           if (err === undefined) {
               console.info(`Succeeded in querying data. size = ${data.length}`);
               for (let i = 0; i < data.length; i++) {
                   let records = data[i].getRecords();
                   for (let j = 0; j < records.length; j++) {
                       if (records[j].getType() === UDMF.UnifiedDataType.PLAIN_TEXT) {
                           let text = <UDMF.PlainText>(records[j]);
                           console.info(`${i + 1}.${text.textContent}`);
                       }
                   }
               }
           } else {
               console.error(`Failed to query data. code is ${err.code},message is ${err.message} `);
           }
       });
   } catch(e) {
       console.error(`Query data throws an exception. code is ${e.code},message is ${e.message} `);
   }
D
dboy190 已提交
102
   ```
D
dboy190 已提交
103
5. 删除存储在UDMF公共存储中的统一数据对象。
D
dboy190 已提交
104 105

   ```js
D
dboy190 已提交
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
   let options = {
    intention: UDMF.Intention.SUPER_HUB
   };
   
   try {
       UDMF.deleteData(options, (err, data) => {
           if (err === undefined) {
               console.info(`Succeeded in deleting data. size = ${data.length}`);
               for (let i = 0; i < data.length; i++) {
                   let records = data[i].getRecords();
                   for (let j = 0; j < records.length; j++) {
                       if (records[j].getType() === UDMF.UnifiedDataType.PLAIN_TEXT) {
                           let text = <UDMF.PlainText>(records[j]);
                           console.info(`${i + 1}.${text.textContent}`);
                       }
                   }
               }
           } else {
               console.error(`Failed to delete data. code is ${err.code},message is ${err.message} `);
           }
       });
   } catch(e) {
       console.error(`Delete data throws an exception. code is ${e.code},message is ${e.message} `);
D
dboy190 已提交
129 130
   }
   ```