• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 通过键值型数据库实现数据持久化
2
3
4## 场景介绍
5
6键值型数据库存储键值对形式的数据，当需要存储的数据没有复杂的关系模型，比如存储商品名称及对应价格、员工工号及今日是否已出勤等，由于数据复杂度低，更容易兼容不同数据库版本和设备类型，因此推荐使用键值型数据库持久化此类数据。
7
8
9## 约束限制
10
11- 设备协同数据库，针对每条记录，Key的长度≤896 Byte，Value的长度<4 MB。
12
13- 单版本数据库，针对每条记录，Key的长度≤1 KB，Value的长度<4 MB。
14
15- 每个应用程序最多支持同时打开16个分布式数据库。
16
17- 键值型数据库事件回调方法中不允许进行阻塞操作，例如修改UI组件。
18
19
20## 接口说明
21
22以下是键值型数据库持久化功能的相关接口，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以callback形式为例，更多接口及使用方式请见[分布式键值数据库](../reference/apis/js-apis-distributedKVStore.md)。
23
24| 接口名称 | 描述 |
25| -------- | -------- |
26| createKVManager(config: KVManagerConfig): KVManager | 创建一个KVManager对象实例，用于管理数据库对象。 |
27| getKVStore<T>(storeId: string, options: Options, callback: AsyncCallback<T>): void | 指定Options和storeId，创建并得到指定类型的KVStore数据库。 |
28| put(key: string, value: Uint8Array\|string\|number\|boolean, callback: AsyncCallback<void>): void | 添加指定类型的键值对到数据库。 |
29| get(key: string, callback: AsyncCallback<Uint8Array\|string\|boolean\|number>): void | 获取指定键的值。 |
30| delete(key: string, callback: AsyncCallback<void>): void | 从数据库中删除指定键值的数据。 |
31
32
33## 开发步骤
34
351. 若要使用键值型数据库，首先要获取一个KVManager实例，用于管理数据库对象。示例代码如下所示：
36
37   Stage模型示例：
38
39
40   ```js
41   // 导入模块
42   import distributedKVStore from '@ohos.data.distributedKVStore';
43
44   // Stage模型
45   import UIAbility from '@ohos.app.ability.UIAbility';
46
47   let kvManager;
48
49   export default class EntryAbility extends UIAbility {
50     onCreate() {
51       let context = this.context;
52       const kvManagerConfig = {
53         context: context,
54         bundleName: 'com.example.datamanagertest'
55       };
56       try {
57         // 创建KVManager实例
58         kvManager = distributedKVStore.createKVManager(kvManagerConfig);
59         console.info('Succeeded in creating KVManager.');
60         // 继续创建获取数据库
61       } catch (e) {
62         console.error(`Failed to create KVManager. Code:${e.code},message:${e.message}`);
63       }
64     }
65   }
66   ```
67
68   FA模型示例：
69
70
71   ```js
72   // 导入模块
73   import distributedKVStore from '@ohos.data.distributedKVStore';
74
75   // FA模型
76   import featureAbility from '@ohos.ability.featureAbility';
77
78   let kvManager;
79   let context = featureAbility.getContext(); // 获取context
80   const kvManagerConfig = {
81     context: context,
82     bundleName: 'com.example.datamanagertest'
83   };
84   try {
85     kvManager = distributedKVStore.createKVManager(kvManagerConfig);
86     console.info('Succeeded in creating KVManager.');
87     // 继续创建获取数据库
88   } catch (e) {
89     console.error(`Failed to create KVManager. Code:${e.code},message:${e.message}`);
90   }
91   ```
92
932. 创建并获取键值数据库。示例代码如下所示：
94
95   ```js
96   try {
97     const options = {
98       createIfMissing: true, // 当数据库文件不存在时是否创建数据库，默认创建
99       encrypt: false, // 设置数据库文件是否加密，默认不加密
100       backup: false, // 设置数据库文件是否备份，默认备份
101       autoSync: true, // 设置数据库文件是否自动同步。默认为false，即手动同步；设置为true时，表示自动同步
102       kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION, // 设置要创建的数据库类型，默认为多设备协同数据库
103       securityLevel: distributedKVStore.SecurityLevel.S2 // 设置数据库安全级别
104     };
105     // storeId为数据库唯一标识符
106     kvManager.getKVStore('storeId', options, (err, kvStore) => {
107       if (err) {
108         console.error(`Failed to get KVStore. Code:${err.code},message:${err.message}`);
109         return;
110       }
111       console.info('Succeeded in getting KVStore.');
112       // 进行相关数据操作
113     });
114   } catch (e) {
115     console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);
116   }
117   ```
118
1193. 调用put()方法向键值数据库中插入数据。示例代码如下所示：
120
121   ```js
122   const KEY_TEST_STRING_ELEMENT = 'key_test_string';
123   const VALUE_TEST_STRING_ELEMENT = 'value_test_string';
124   try {
125     kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, (err) => {
126       if (err !== undefined) {
127         console.error(`Failed to put data. Code:${err.code},message:${err.message}`);
128         return;
129       }
130       console.info('Succeeded in putting data.');
131     });
132   } catch (e) {
133     console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);
134   }
135   ```
136
137   > **说明：**
138   >
139   > 当Key值存在时，put()方法会修改其值，否则新增一条数据。
140
1414. 调用get()方法获取指定键的值。示例代码如下所示：
142
143   ```js
144   const KEY_TEST_STRING_ELEMENT = 'key_test_string';
145   const VALUE_TEST_STRING_ELEMENT = 'value_test_string';
146   try {
147     kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, (err) => {
148       if (err !== undefined) {
149         console.error(`Failed to put data. Code:${err.code},message:${err.message}`);
150         return;
151       }
152       console.info('Succeeded in putting data.');
153       kvStore.get(KEY_TEST_STRING_ELEMENT, (err, data) => {
154         if (err !== undefined) {
155           console.error(`Failed to get data. Code:${err.code},message:${err.message}`);
156           return;
157         }
158         console.info(`Succeeded in getting data. data:${data}`);
159       });
160     });
161   } catch (e) {
162     console.error(`Failed to get data. Code:${e.code},message:${e.message}`);
163   }
164   ```
165
1665. 调用delete()方法删除指定键值的数据。示例代码如下所示：
167
168   ```js
169   const KEY_TEST_STRING_ELEMENT = 'key_test_string';
170   const VALUE_TEST_STRING_ELEMENT = 'value_test_string';
171   try {
172     kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, (err) => {
173       if (err !== undefined) {
174         console.error(`Failed to put data. Code:${err.code},message:${err.message}`);
175         return;
176       }
177       console.info('Succeeded in putting data.');
178       kvStore.delete(KEY_TEST_STRING_ELEMENT, (err) => {
179         if (err !== undefined) {
180           console.error(`Failed to delete data. Code:${err.code},message:${err.message}`);
181           return;
182         }
183         console.info('Succeeded in deleting data.');
184       });
185     });
186   } catch (e) {
187     console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);
188   }
189   ```
190