1# 通过用户首选项实现数据持久化 2 3 4## 场景介绍 5 6用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据。Preferences会随着存放的数据量越多而导致应用占用的内存越大，因此，Preferences不适合存放过多的数据，适用的场景一般为应用保存用户的个性化设置（字体大小，是否开启夜间模式）等。 7 8 9## 运作机制 10 11如图所示，用户程序通过JS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到主动从内存中移除该实例或者删除该文件。 12 13应用首选项的持久化文件保存在应用沙箱内部，可以通过context获取其路径。具体可见[获取应用开发路径](../application-models/application-context-stage.md#获取应用开发路径)。 14 15**图1** 用户首选项运作机制 16 17 18 19 20## 约束限制 21 22- Key键为string类型，要求非空且长度不超过80个字节。 23 24- 如果Value值为string类型，可以为空，不为空时长度不超过8192个字节。 25 26- 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。 27 28 29## 接口说明 30 31以下是用户首选项持久化功能的相关接口，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以callback形式为例，更多接口及使用方式请见[用户首选项](../reference/apis/js-apis-data-preferences.md)。 32 33 | 接口名称 | 描述 | 34| -------- | -------- | 35| getPreferences(context: Context, name: string, callback: AsyncCallback<Preferences>): void | 获取Preferences实例。 | 36| put(key: string, value: ValueType, callback: AsyncCallback<void>): void | 将数据写入Preferences实例，可通过flush将Preferences实例持久化。 | 37| has(key: string, callback: AsyncCallback<boolean>): void | 检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。 | 38| get(key: string, defValue: ValueType, callback: AsyncCallback<ValueType>): void | 获取键对应的值，如果值为null或者非默认值类型，返回默认数据defValue。 | 39| delete(key: string, callback: AsyncCallback<void>): void | 从Preferences实例中删除名为给定Key的存储键值对。 | 40| flush(callback: AsyncCallback<void>): void | 将当前Preferences实例的数据异步存储到用户首选项持久化文件中。 | 41| on(type: 'change', callback: Callback<{ key : string }>): void | 订阅数据变更，订阅的Key的值发生变更后，在执行flush方法后，触发callback回调。 | 42| off(type: 'change', callback?: Callback<{ key : string }>): void | 取消订阅数据变更。 | 43| deletePreferences(context: Context, name: string, callback: AsyncCallback<void>): void | 从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。 | 44 45 46## 开发步骤 47 481. 导入`@ohos.data.preferences`模块。 49 50 ```js 51 import dataPreferences from '@ohos.data.preferences'; 52 ``` 53 542. 要通过用户首选项实现数据持久化，首先要获取Preferences实例。读取指定文件，将数据加载到Preferences实例，用于数据操作。 55 56 Stage模型示例： 57 58 59 ```js 60 import UIAbility from '@ohos.app.ability.UIAbility'; 61 62 class EntryAbility extends UIAbility { 63 onWindowStageCreate(windowStage) { 64 try { 65 dataPreferences.getPreferences(this.context, 'mystore', (err, preferences) => { 66 if (err) { 67 console.error(`Failed to get preferences. Code:${err.code},message:${err.message}`); 68 return; 69 } 70 console.info('Succeeded in getting preferences.'); 71 // 进行相关数据操作 72 }) 73 } catch (err) { 74 console.error(`Failed to get preferences. Code:${err.code},message:${err.message}`); 75 } 76 } 77 } 78 ``` 79 80 FA模型示例： 81 82 83 ```js 84 import featureAbility from '@ohos.ability.featureAbility'; 85 86 // 获取context 87 let context = featureAbility.getContext(); 88 89 try { 90 dataPreferences.getPreferences(context, 'mystore', (err, preferences) => { 91 if (err) { 92 console.error(`Failed to get preferences. Code:${err.code},message:${err.message}`); 93 return; 94 } 95 console.info('Succeeded in getting preferences.'); 96 // 进行相关数据操作 97 }) 98 } catch (err) { 99 console.error(`Failed to get preferences. Code is ${err.code},message:${err.message}`); 100 } 101 ``` 102 1033. 写入数据。 104 105 使用put()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。 106 107 > **说明：** 108 > 109 > 当对应的键已经存在时，put()方法会修改其值。如果仅需要在键值对不存在时新增键值对，而不修改已有键值对，需使用has()方法检查是否存在对应键值对；如果不关心是否会修改已有键值对，则直接使用put()方法即可。 110 111 示例代码如下所示： 112 113 114 ```js 115 try { 116 preferences.has('startup', function (err, val) { 117 if (err) { 118 console.error(`Failed to check the key 'startup'. Code:${err.code}, message:${err.message}`); 119 return; 120 } 121 if (val) { 122 console.info("The key 'startup' is contained."); 123 } else { 124 console.info("The key 'startup' does not contain."); 125 // 此处以此键值对不存在时写入数据为例 126 try { 127 preferences.put('startup', 'auto', (err) => { 128 if (err) { 129 console.error(`Failed to put data. Code:${err.code}, message:${err.message}`); 130 return; 131 } 132 console.info('Succeeded in putting data.'); 133 }) 134 } catch (err) { 135 console.error(`Failed to put data. Code: ${err.code},message:${err.message}`); 136 } 137 } 138 }) 139 } catch (err) { 140 console.error(`Failed to check the key 'startup'. Code:${err.code}, message:${err.message}`); 141 } 142 ``` 143 1444. 读取数据。 145 146 使用get()方法获取数据，即指定键对应的值。如果值为null或者非默认值类型，则返回默认数据。示例代码如下所示： 147 148 ```js 149 try { 150 preferences.get('startup', 'default', (err, val) => { 151 if (err) { 152 console.error(`Failed to get value of 'startup'. Code:${err.code}, message:${err.message}`); 153 return; 154 } 155 console.info(`Succeeded in getting value of 'startup'. val: ${val}.`); 156 }) 157 } catch (err) { 158 console.error(`Failed to get value of 'startup'. Code:${err.code}, message:${err.message}`); 159 } 160 ``` 161 1625. 删除数据。 163 164 使用delete()方法删除指定键值对，示例代码如下所示： 165 166 167 ```js 168 try { 169 preferences.delete('startup', (err) => { 170 if (err) { 171 console.error(`Failed to delete the key 'startup'. Code:${err.code}, message:${err.message}`); 172 return; 173 } 174 console.info("Succeeded in deleting the key 'startup'."); 175 }) 176 } catch (err) { 177 console.error(`Failed to delete the key 'startup'. Code:${err.code}, message:${err.message}`); 178 } 179 ``` 180 1816. 数据持久化。 182 183 应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示： 184 185 ```js 186 try { 187 preferences.flush((err) => { 188 if (err) { 189 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 190 return; 191 } 192 console.info('Succeeded in flushing.'); 193 }) 194 } catch (err) { 195 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 196 } 197 ``` 198 1997. 订阅数据变更。 200 201 应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。示例代码如下所示： 202 203 ```js 204 let observer = function (key) { 205 console.info('The key' + key + 'changed.'); 206 } 207 preferences.on('change', observer); 208 // 数据产生变更，由'auto'变为'manual' 209 preferences.put('startup', 'manual', (err) => { 210 if (err) { 211 console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`); 212 return; 213 } 214 console.info("Succeeded in putting the value of 'startup'."); 215 preferences.flush((err) => { 216 if (err) { 217 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 218 return; 219 } 220 console.info('Succeeded in flushing.'); 221 }) 222 }) 223 ``` 224 2258. 删除指定文件。 226 227 使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。 228 229 > **说明：** 230 > 231 > - 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。 232 > 233 > - 成功删除后，数据及文件将不可恢复。 234 235 示例代码如下所示： 236 237 238 ```js 239 try { 240 dataPreferences.deletePreferences(this.context, 'mystore', (err, val) => { 241 if (err) { 242 console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`); 243 return; 244 } 245 console.info('Succeeded in deleting preferences.'); 246 }) 247 } catch (err) { 248 console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`); 249 } 250 ``` 251 252## 相关实例 253 254针对用户首选项开发，有以下相关实例可供参考： 255 256- [`Preferences`：首选项（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-3.2-Release/code/BasicFeature/DataManagement/Preferences) 257 258- [首选项（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-3.2-Release/code/BasicFeature/DataManagement/Preferences)
