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