1# 通过用户首选项实现数据持久化 (ArkTS) 2<!--Kit: ArkData--> 3<!--Subsystem: DistributedDataManager--> 4<!--Owner: @yanhuii--> 5<!--Designer: @houpengtao1--> 6<!--Tester: @yippo; @logic42--> 7<!--Adviser: @ge-yafang--> 8 9 10## 场景介绍 11 12用户首选项(Preferences)为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户有轻量级的键值型数据需要存储时，可以采用Preferences来进行存储。一般适用于保存用户的个性化设置，例如字体大小、是否开启夜间模式等。 13 14 15## 运作机制 16 17如图所示，用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到主动从内存中移除该实例或删除该文件。 18 19应用首选项的持久化文件保存在应用沙箱内部，可以通过context获取其路径。具体请参见[获取应用文件路径](../application-models/application-context-stage.md#获取应用文件路径)。 20 21**图1** 用户首选项运作机制 22 23 24 25## 存储模式说明 26用户首选项默认使用XML格式进行存储，从API version 18开始，可选择GSKV存储模式。 27 28### XML存储 29XML存储指的是数据会以XML的形式存储到文件中，该模式的优点是通用性强，支持跨平台。当选择该模式时，首选项对数据的操作主要发生在内存中，开发者可以在需要的时候再调用[flush](../reference/apis-arkdata/js-apis-data-preferences.md#flush)接口进行数据持久化。针对单进程、小数据量场景，推荐使用该存储模式。 30 31### GSKV存储 32GSKV是从API version 18起提供的一种存储模式，数据以二进制的形式存储在文件中，该模式的优点是支持多进程并发读写。当选择该模式时，首选项对数据的操作会实时落盘。针对多进程并发场景，推荐使用该存储模式。 33 34## 约束限制 35 36### 首选项通用限制 37 38- Key键为string类型，要求非空且长度不超过1024个字节。 39 40- 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过16MB。 41 42- 当调用[removePreferencesFromCache](../reference/apis-arkdata/js-apis-data-preferences.md#preferencesremovepreferencesfromcache)或者[deletePreferences](../reference/apis-arkdata/js-apis-data-preferences.md#preferencesdeletepreferences)后，订阅的数据变更会主动取消订阅，重新[getPreferences](../reference/apis-arkdata/js-apis-data-preferences.md#preferencesgetpreferences)后需要重新订阅数据变更。 43 44- 不允许deletePreferences与其他接口多线程、多进程并发调用，否则可能会发生不可预期行为。 45 46- 不支持数据加密存储。如果需要进行数据加密，应用应该先将数据进行加密，然后将密文通过Uint8Array类型存储到Preferences中。 47 48### XML模式约束限制 49 50- XML模式（首选项的默认模式）无法保证进程并发安全，会有文件损坏和数据丢失的风险，不支持在多进程场景下使用。 51 52- 当存储的数据中包含非UTF-8格式的字符串时，请使用Uint8Array类型存储，否则会造成持久化文件出现格式错误造成文件损坏。 53 54- 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过50MB。数据量较大时，在使用同步接口创建Preferences对象和持久化数据时会成为耗时操作，不建议在主线程中使用，否则可能会出现appfreeze问题。 55 56### GSKV模式约束限制 57 58- GSKV模式不支持跨平台，使用该模式前需调用[isStorageTypeSupported](../reference/apis-arkdata/js-apis-data-preferences.md#preferencesisstoragetypesupported18)接口判断当前平台是否支持该模式。 59 60 61 62## 接口说明 63 64以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见[用户首选项](../reference/apis-arkdata/js-apis-data-preferences.md)。 65 66| 接口名称 | 描述 | 67| ------------------------------------------------------------ | ------------------------------------------------------------ | 68| getPreferencesSync(context: Context, options: Options): Preferences | 获取Preferences实例。该接口存在异步接口。 | 69| putSync(key: string, value: ValueType): void | 将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。 | 70| hasSync(key: string): boolean | 检查Preferences实例是否包含名为给定Key的存储键值对，true表示包含，false表示不包含。给定的Key值不能为空。该接口存在异步接口。 | 71| getSync(key: string, defValue: ValueType): ValueType | 获取键对应的值，如果值为null或非默认值类型，将返回默认数据defValue。该接口存在异步接口。 | 72| deleteSync(key: string): void | 从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。 | 73| flush(callback: AsyncCallback<void>): void | 将当前Preferences实例的数据异步存储到用户首选项持久化文件中。 | 74| on(type: 'change', callback: Callback<string>): void | 订阅数据变更，订阅的数据发生变更后，在执行flush方法后，触发callback回调。 | 75| off(type: 'change', callback?: Callback<string>): void | 取消订阅数据变更。 | 76| deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void | 从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。 | 77| isStorageTypeSupported(type: StorageType): boolean | 判断当前平台是否支持希望使用的存储模式。true表示支持，false表示不支持。| 78 79 80## 开发步骤 81 821. 导入`@kit.ArkData`模块。 83 84 ```ts 85 import { preferences } from '@kit.ArkData'; 86 ``` 87 882. （可选）选择存储模式。 89 90 该步骤为可选步骤。首选项默认使用XML模式存储数据，从API version 18开始，新增提供并支持使用GSKV存储模式。 91 92 在选择GSKV存储模式之前，需要使用isStorageTypeSupported()接口判断当前平台是否支持GSKV模式。 93 94 若接口返回false，则说明当前平台不支持GSKV模式，请使用XML模式进行数据存储。 95 96 ```ts 97 let isGskvSupported = preferences.isStorageTypeSupported(preferences.StorageType.GSKV); 98 console.info("Is gskv supported on this platform: " + isGskvSupported); 99 ``` 100 1013. 获取Preferences实例。 102 103 针对默认的XML存储模式，使用getPreferencesSync()方法获取Preferences实例。 104 105 <!--Del-->Stage模型示例：<!--DelEnd--> 106 107 ```ts 108 import { UIAbility } from '@kit.AbilityKit'; 109 import { BusinessError } from '@kit.BasicServicesKit'; 110 import { window } from '@kit.ArkUI'; 111 112 let dataPreferences: preferences.Preferences | null = null; 113 114 class EntryAbility extends UIAbility { 115 onWindowStageCreate(windowStage: window.WindowStage) { 116 let options: preferences.Options = { name: 'myStore' }; 117 dataPreferences = preferences.getPreferencesSync(this.context, options); 118 } 119 } 120 ``` 121 122 <!--Del-->FA模型示例： 123 124 ```ts 125 // 获取context 126 import { featureAbility } from '@kit.AbilityKit'; 127 import { BusinessError } from '@kit.BasicServicesKit'; 128 129 let context = featureAbility.getContext(); 130 let options: preferences.Options = { name: 'myStore' }; 131 let dataPreferences: preferences.Preferences = preferences.getPreferencesSync(context, options); 132 ``` 133 <!--DelEnd--> 134 135 针对GSKV存储模式，使用getPreferencesSync()方法获取Preferences实例。 136 137 若希望使用GSKV存储模式且当前平台支持该模式，可以通过以下方式获取GSKV存储模式的Preferences实例。需要注意的是，当选择某一存储模式后，不允许再对存储模式进行切换。 138 <!--Del-->Stage模型示例：<!--DelEnd--> 139 140 ```ts 141 import { UIAbility } from '@kit.AbilityKit'; 142 import { BusinessError } from '@kit.BasicServicesKit'; 143 import { window } from '@kit.ArkUI'; 144 145 let dataPreferences: preferences.Preferences | null = null; 146 147 class EntryAbility extends UIAbility { 148 onWindowStageCreate(windowStage: window.WindowStage) { 149 let options: preferences.Options = { name: 'myStore', storageType: preferences.StorageType.GSKV }; 150 dataPreferences = preferences.getPreferencesSync(this.context, options); 151 } 152 } 153 ``` 154 155 <!--Del-->FA模型示例： 156 157 ```ts 158 // 获取context 159 import { featureAbility } from '@kit.AbilityKit'; 160 import { BusinessError } from '@kit.BasicServicesKit'; 161 162 let context = featureAbility.getContext(); 163 let options: preferences.Options = { name: 'myStore', storageType: preferences.StorageType.GSKV }; 164 let dataPreferences: preferences.Preferences = preferences.getPreferencesSync(context, options); 165 ``` 166 <!--DelEnd--> 167 168 1694. 写入数据。 170 171 使用putSync()方法将数据写入Preferences实例中。 172 173 针对默认存储模式（XML存储模式），在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。 174 175 针对GSKV存储模式，在写入数据后，数据会实时持久化到文件中。 176 177 > **说明：** 178 > 179 > 当对应的键已经存在时，putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。 180 181 示例代码如下所示： 182 183 ```ts 184 import { util } from '@kit.ArkTS'; 185 if (dataPreferences.hasSync('startup')) { 186 console.info("The key 'startup' is contained."); 187 } else { 188 console.info("The key 'startup' does not contain."); 189 // 此处以此键值对不存在时写入数据为例 190 dataPreferences.putSync('startup', 'auto'); 191 // 在XML模式下，当字符串包含非UTF-8格式的字符时，需要将字符串转为Uint8Array类型再存储，长度均不超过16 * 1024 * 1024个字节。 192 let uInt8Array1 = new util.TextEncoder().encodeInto("~！@#￥%……&*（）——+？"); 193 dataPreferences.putSync('uInt8', uInt8Array1); 194 } 195 ``` 196 1975. 读取数据。 198 199 使用getSync()方法获取数据，即指定键对应的值。如果值为null或非默认值类型，则返回默认数据。 200 201 示例代码如下所示： 202 203 ```ts 204 let val = dataPreferences.getSync('startup', 'default'); 205 console.info("The 'startup' value is " + val); 206 let uInt8Array2 : preferences.ValueType = dataPreferences.getSync('uInt8', new Uint8Array(0)); 207 // 将获取到的Uint8Array转换为字符串 208 let textDecoder = util.TextDecoder.create('utf-8'); 209 val = textDecoder.decodeToString(uInt8Array2 as Uint8Array); 210 console.info("The 'uInt8' value is " + val); 211 ``` 212 2136. 删除数据。 214 215 使用deleteSync()方法删除指定键值对，示例代码如下所示： 216 217 ```ts 218 dataPreferences.deleteSync('startup'); 219 ``` 220 2217. 数据持久化。 222 223 应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示： 224 225 ```ts 226 dataPreferences.flush((err: BusinessError) => { 227 if (err) { 228 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 229 return; 230 } 231 console.info('Succeeded in flushing.'); 232 }) 233 ``` 234 2358. 订阅数据变更。 236 237 应用订阅数据变更需要指定observer作为回调方法。 238 239 针对首选项的默认存储模式（XML存储模式），订阅的Key值发生变更后，当执行flush()方法时，触发observer回调。 240 241 示例代码如下所示： 242 243 ```ts 244 let observer = (key: string) => { 245 console.info('The key' + key + 'changed.'); 246 } 247 dataPreferences.on('change', observer); 248 // 数据产生变更，由'auto'变为'manual' 249 dataPreferences.put('startup', 'manual', (err: BusinessError) => { 250 if (err) { 251 console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`); 252 return; 253 } 254 console.info("Succeeded in putting the value of 'startup'."); 255 if (dataPreferences !== null) { 256 dataPreferences.flush((err: BusinessError) => { 257 if (err) { 258 console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); 259 return; 260 } 261 console.info('Succeeded in flushing.'); 262 }) 263 } 264 }) 265 ``` 266 267 针对GSKV存储模式，订阅的Key值发生变更后（无需调用flush），observer被触发回调。 268 269 示例代码如下所示： 270 ```ts 271 let observer = (key: string) => { 272 console.info('The key' + key + 'changed.'); 273 } 274 dataPreferences.on('change', observer); 275 // 数据产生变更，由'auto'变为'manual' 276 dataPreferences.put('startup', 'manual', (err: BusinessError) => { 277 if (err) { 278 console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`); 279 return; 280 } 281 console.info("Succeeded in putting the value of 'startup'."); 282 }) 283 ``` 2849. 删除指定文件。 285 286 使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例及其数据。若该Preference存在对应的持久化文件，则一并删除，包括指定文件及其备份文件、损坏文件。 287 288 > **说明：** 289 > 290 > - 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。 291 > 292 > - 成功删除后，数据及文件将不可恢复。 293 > 294 > - 在GSKV模式中，该接口不支持与其他接口并发调用（包括多进程），否则会出现不可预期行为。 295 296 示例代码如下所示： 297 298 ```ts 299 preferences.deletePreferences(this.context, options, (err: BusinessError) => { 300 if (err) { 301 console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`); 302 return; 303 } 304 console.info('Succeeded in deleting preferences.'); 305 }) 306 ``` 307 308## 相关实例 309 310针对用户首选项开发，有以下相关实例可供参考： 311 312- [游戏2048（ArkTS）（API9）](https://gitcode.com/openharmony/applications_app_samples/tree/master/code/Solutions/Game/Game2048) 313 314- [图案密码锁（ArkTS）（API9）](https://gitcode.com/openharmony/applications_app_samples/tree/master/code/Solutions/Tools/PatternLock) 315 316- [首选项（ArkTS）（API9）](https://gitcode.com/openharmony/applications_app_samples/tree/master/code/BasicFeature/DataManagement/Preferences) 317 318- [首选项（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/Preferences) 319 320- [用户首选项（JS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/PreferenceJS) 321 322- [备忘录（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/NotePadOpenHarmony) 323 324- [应用的首次启动（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/FirstStartDemo) 325 326- [应用内字体大小调节（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/SetAppFontSize) 327 328<!--RP1--><!--RP1End-->
