1# 通过用户首选项实现数据持久化 2 3 4## 场景介绍 5 6用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据，当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大，因此，Preferences不适合存放过多的数据，适用的场景一般为应用保存用户的个性化设置（字体大小，是否开启夜间模式）等。 7 8 9## 运作机制 10 11如图所示，用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到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类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过8192个字节。 25 26- 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。 27 28 29## 接口说明 30 31以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见[用户首选项](../reference/apis-arkdata/js-apis-data-preferences.md)。 32 33| 接口名称 | 描述 | 34| ------------------------------------------------------------ | ------------------------------------------------------------ | 35| getPreferencesSync(context: Context, options: Options): Preferences | 获取Preferences实例。该接口存在异步接口。 | 36| putSync(key: string, value: ValueType): void | 将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。 | 37| hasSync(key: string): void | 检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。 | 38| getSync(key: string, defValue: ValueType): void | 获取键对应的值，如果值为null或者非默认值类型，返回默认数据defValue。该接口存在异步接口。 | 39| deleteSync(key: string): void | 从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。 | 40| flush(callback: AsyncCallback<void>): void | 将当前Preferences实例的数据异步存储到用户首选项持久化文件中。 | 41| on(type: 'change', callback: Callback<string>): void | 订阅数据变更，订阅的数据发生变更后，在执行flush方法后，触发callback回调。 | 42| off(type: 'change', callback?: Callback<string>): void | 取消订阅数据变更。 | 43| deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void | 从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。 | 44 45 46## 开发步骤 47 481. 导入`@ohos.data.preferences`模块。 49 50 ```ts 51 import dataPreferences from '@ohos.data.preferences'; 52 ``` 53 542. 获取Preferences实例。 55 56 Stage模型示例： 57 58 59 ```ts 60 import UIAbility from '@ohos.app.ability.UIAbility'; 61 import { BusinessError } from '@ohos.base'; 62 import window from '@ohos.window'; 63 64 let preferences: dataPreferences.Preferences | null = null; 65 66 class EntryAbility extends UIAbility { 67 onWindowStageCreate(windowStage: window.WindowStage) { 68 let options: dataPreferences.Options = { name: 'myStore' }; 69 preferences = dataPreferences.getPreferencesSync(this.context, options); 70 } 71 } 72 ``` 73 74 FA模型示例： 75 76 77 ```ts 78 // 获取context 79 import featureAbility from '@ohos.ability.featureAbility'; 80 import { BusinessError } from '@ohos.base'; 81 82 let context = featureAbility.getContext(); 83 let options: dataPreferences.Options = { name: 'myStore' }; 84 let preferences: dataPreferences.Preferences = dataPreferences.getPreferencesSync(context, options); 85 ``` 86 873. 写入数据。 88 89 使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。 90 91 > **说明：** 92 > 93 > 当对应的键已经存在时，putSync()方法会修改其值。可以使用hasSync()方法检查是否存在对应键值对。 94 95 示例代码如下所示： 96 97 ```ts 98 import util from '@ohos.util'; 99 if (preferences.hasSync('startup')) { 100 console.info("The key 'startup' is contained."); 101 } else { 102 console.info("The key 'startup' does not contain."); 103 // 此处以此键值对不存在时写入数据为例 104 preferences.putSync('startup', 'auto'); 105 // 当字符串有特殊字符时，需要将字符串转为Uint8Array类型再存储 106 let uInt8Array = new util.TextEncoder().encodeInto("~！@#￥%……&*（）——+？"); 107 preferences.putSync('uInt8', uInt8Array); 108 } 109 ``` 110 1113. 读取数据。 112 113 使用getSync()方法获取数据，即指定键对应的值。如果值为null或者非默认值类型，则返回默认数据。 114 115 示例代码如下所示： 116 117 ```ts 118 import util from '@ohos.util'; 119 let val = preferences.getSync('startup', 'default'); 120 console.info("The 'startup' value is " + val); 121 // 当获取的值为带有特殊字符的字符串时，需要将获取到的Uint8Array转换为字符串 122 let uInt8Array : dataPreferences.ValueType = preferences.getSync('uInt8', new Uint8Array(0)); 123 let textDecoder = util.TextDecoder.create('utf-8'); 124 val = textDecoder.decodeWithStream(uInt8Array as Uint8Array); 125 console.info("The 'uInt8' value is " + val); 126 ``` 127 1284. 删除数据。 129 130 使用deleteSync()方法删除指定键值对，示例代码如下所示： 131 132 133 ```ts 134 preferences.deleteSync('startup'); 135 ``` 136 1375. 数据持久化。 138 139 应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示： 140 141 ```ts 142 preferences.flush((err: BusinessError) => { 143 if (err) { 144 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 145 return; 146 } 147 console.info('Succeeded in flushing.'); 148 }) 149 ``` 150 1516. 订阅数据变更。 152 153 应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。示例代码如下所示： 154 155 ```ts 156 let observer = (key: string) => { 157 console.info('The key' + key + 'changed.'); 158 } 159 preferences.on('change', observer); 160 // 数据产生变更，由'auto'变为'manual' 161 preferences.put('startup', 'manual', (err: BusinessError) => { 162 if (err) { 163 console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`); 164 return; 165 } 166 console.info("Succeeded in putting the value of 'startup'."); 167 if (preferences !== null) { 168 preferences.flush((err: BusinessError) => { 169 if (err) { 170 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 171 return; 172 } 173 console.info('Succeeded in flushing.'); 174 }) 175 } 176 }) 177 ``` 178 1797. 删除指定文件。 180 181 使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。 182 183 > **说明：** 184 > 185 > - 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。 186 > 187 > - 成功删除后，数据及文件将不可恢复。 188 189 示例代码如下所示： 190 191 192 ```ts 193 let options: dataPreferences.Options = { name: 'myStore' }; 194 dataPreferences.deletePreferences(this.context, options, (err: BusinessError) => { 195 if (err) { 196 console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`); 197 return; 198 } 199 console.info('Succeeded in deleting preferences.'); 200 }) 201 ``` 202 203## 相关实例 204 205针对用户首选项开发，有以下相关实例可供参考： 206 207- [游戏2048（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/Solutions/Game/Game2048) 208 209- [图案密码锁（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/Solutions/Tools/PatternLock) 210 211- [首选项（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/DataManagement/Preferences) 212 213- [首选项（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/Preferences) 214 215- [用户首选项（JS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/PreferenceJS) 216 217- [备忘录（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/NotePadOpenHarmony) 218 219- [应用的首次启动（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/FirstStartDemo) 220 221- [应用内字体大小调节（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/SetAppFontSize)
