• 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- Key键为string类型，要求非空且长度不超过80个字节。
23
24- 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过8192个字节。
25
26- 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。
27
28
29## 接口说明
30
31以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见[用户首选项](../reference/apis/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: ( key : string ) => void): void | 订阅数据变更，订阅的Key的值发生变更后，在执行flush方法后，触发callback回调。 |
42| off(type: 'change', callback?: ( key : string ) => void): 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实例。读取指定文件，将数据加载到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       try {
69         let options: dataPreferences.Options = { name: 'myStore' };
70         preferences = dataPreferences.getPreferencesSync(this.context, options);
71       } catch (err) {
72         let code = (err as BusinessError).code;
73         let message = (err as BusinessError).message;
74         console.error(`Failed to get preferences. Code:${code},message:${message}`);
75       }
76     }
77   }
78   ```
79
80   FA模型示例：
81
82
83   ```ts
84   // 获取context
85   import featureAbility from '@ohos.ability.featureAbility';
86   import { BusinessError } from '@ohos.base';
87
88   let context = featureAbility.getContext();
89   let preferences: dataPreferences.Preferences | null = null;
90
91   try {
92       let options: dataPreferences.Options =  { name: 'myStore' };
93       preferences = dataPreferences.getPreferencesSync(context, options);
94   } catch (err) {
95       let code = (err as BusinessError).code;
96     	let message = (err as BusinessError).message;
97     	console.error(`Failed to get preferences. Code is ${code},message:${message}`);
98   }
99   ```
100
1013. 写入数据。
102
103   使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。
104
105   > **说明：**
106   >
107   > 当对应的键已经存在时，putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。
108
109   示例代码如下所示：
110
111
112   ```ts
113   try {
114     if (preferences.hasSync('startup')) {
115       console.info("The key 'startup' is contained.");
116     } else {
117       console.info("The key 'startup' does not contain.");
118       // 此处以此键值对不存在时写入数据为例
119       preferences.putSync('startup', 'auto');
120     }
121   } catch (err) {
122     let code = (err as BusinessError).code;
123     let message = (err as BusinessError).message;
124     console.error(`Failed to check the key 'startup'. Code:${code}, message:${message}`);
125   }
126   ```
127
1284. 读取数据。
129
130     使用getSync()方法获取数据，即指定键对应的值。如果值为null或者非默认值类型，则返回默认数据。示例代码如下所示：
131
132   ```ts
133   try {
134     let val = preferences.getSync('startup', 'default');
135     console.info(`Succeeded in getting value of 'startup'. val: ${val}.`);
136   } catch (err) {
137     let code = (err as BusinessError).code;
138     let message = (err as BusinessError).message;
139     console.error(`Failed to get value of 'startup'. Code:${code}, message:${message}`);
140   }
141   ```
142
1435. 删除数据。
144
145   使用deleteSync()方法删除指定键值对，示例代码如下所示：
146
147
148   ```ts
149   try {
150     preferences.deleteSync('startup');
151   } catch (err) {
152     let code = (err as BusinessError).code;
153     let message = (err as BusinessError).message;
154     console.error(`Failed to delete the key 'startup'. Code:${code}, message:${message}`);
155   }
156   ```
157
1586. 数据持久化。
159
160     应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示：
161
162   ```ts
163   try {
164     preferences.flush((err: BusinessError) => {
165       if (err) {
166         console.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
167         return;
168       }
169       console.info('Succeeded in flushing.');
170     })
171   } catch (err) {
172     let code = (err as BusinessError).code;
173     let message = (err as BusinessError).message;
174     console.error(`Failed to flush. Code:${code}, message:${message}`);
175   }
176   ```
177
1787. 订阅数据变更。
179
180     应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。示例代码如下所示：
181
182   ```ts
183   let observer = (key: string) => {
184     console.info('The key' + key + 'changed.');
185   }
186   preferences.on('change', observer);
187   // 数据产生变更，由'auto'变为'manual'
188   preferences.put('startup', 'manual', (err: BusinessError) => {
189     if (err) {
190       console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`);
191       return;
192     }
193     console.info("Succeeded in putting the value of 'startup'.");
194     preferences.flush((err: BusinessError) => {
195       if (err) {
196         console.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
197         return;
198       }
199       console.info('Succeeded in flushing.');
200     })
201   })
202   ```
203
2048. 删除指定文件。
205
206   使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。
207
208   > **说明：**
209   >
210   > - 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。
211   >
212   > - 成功删除后，数据及文件将不可恢复。
213
214   示例代码如下所示：
215
216
217   ```ts
218   try {
219       let options: dataPreferences.Options = { name: 'myStore' };
220       dataPreferences.deletePreferences(this.context, options, (err: BusinessError) => {
221           if (err) {
222               console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`);
223               return;
224           }
225           console.info('Succeeded in deleting preferences.');
226       })
227   } catch (err) {
228       let code = (err as BusinessError).code;
229       let message = (err as BusinessError).message;
230       console.error(`Failed to delete preferences. Code:${code}, message:${message}`);
231   }
232   ```
233
234## 相关实例
235
236针对用户首选项开发，有以下相关实例可供参考：
237
238- [游戏2048（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/Solutions/Game/Game2048)
239
240- [图案密码锁（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/Solutions/Tools/PatternLock)
241
242- [首选项（ArkTS）（API9）](https://gitee.com/openharmony/applications_app_samples/tree/OpenHarmony-4.0-Release/code/BasicFeature/DataManagement/Preferences)
243
244- [首选项（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/Preferences)
245
246- [用户首选项（JS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/PreferenceJS)
247
248- [备忘录（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/NotePadOpenHarmony)
249
250- [应用的首次启动（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/FirstStartDemo)
251
252- [应用内字体大小调节（ArkTS）（API9）](https://gitee.com/openharmony/codelabs/tree/master/Data/SetAppFontSize)