一、用户首选项简介
在iOS开发中有一个名为UserDefaults的类专门管理存储和读取轻量型数据的时候使用，有些时候也称之为用户偏好设置。而今天这里我们所说的HarmonyOS中的Preferences（也称之为用户首选项）其实与iOS的UserDefaults的作用几乎是一样的。为了方便记忆这里对两者进行了总结，具体总结如下：
| 特性 | iOS系统的 UserDefaults | HarmonyOS系统的Preferences |
|---|---|---|
| 存储机制 | 以键值对形式存储数据，支持多种数据类型（布尔值、整数、浮点数、字符串、数组、字典等）。数据存储在设备上的 plist 文件中。 | 以键值对形式存储数据，支持多种数据类型（布尔值、整数、浮点数、字符串等）。数据存储在设备上的 XML 文件中。 |
| 易用性 | 提供了简洁的 API，易于使用。 | 提供了简洁的 API，易于使用。 |
| 轻量级 | 适用于存储少量数据，不适合存储大量数据或频繁更新的数据。 | 适用于存储少量数据，不适合存储大量数据或频繁更新的数据。建议存储的数据不超过一万条。 |
| 持久化 | 数据会持久化到设备上，即使应用被关闭或重启，数据仍然保留。 | 数据会持久化到设备上，即使应用被关闭或重启，数据仍然保留。 |
| 性能 | 读写速度快，但大量数据或频繁更新可能影响性能。 | 读写速度快，但大量数据或频繁更新可能影响性能。 |
| 安全性 | 不适合存储敏感信息，如密码或个人身份信息。建议使用 Keychain 服务。 | 不适合存储敏感信息，如密码或个人身份信息。建议使用其他安全存储机制。 |
| 同步性 | 在主线程上访问是线程安全的。 | 在主线程上访问是线程安全的。 |
| 使用场景 | 适用于存储用户的偏好设置、应用状态等轻量级数据。 | 适用于存储用户的偏好设置、应用状态等轻量级数据，如屏幕亮度、夜间模式等。 |
| API 示例 | swift<br>let defaults = UserDefaults.standard<br>defaults.set(true, forKey: "isDarkModeEnabled")<br> | java<br>Preferences preferences = Preferences.getInstance();<br>preferences.putBoolean("isDarkModeEnabled", true);<br> |
| 读取数据 | swift<br>let defaults = UserDefaults.standard<br>let isDarkModeEnabled = defaults.bool(forKey: "isDarkModeEnabled")<br> | java<br>Preferences preferences = Preferences.getInstance();<br>boolean isDarkModeEnabled = preferences.getBoolean("isDarkModeEnabled", false);<br> |
| 数据量限制 | 没有明确的数据量限制，但建议不要存储大量数据。 | 建议存储的数据不超过一万条，避免过大的内存开销。 |
| 开发语言支持 | 主要支持 Swift 和 Objective-C。 | 支持 Java 和 C++，近期新增了 JS/TypeScript 接口。 |
总结
- 存储机制：两者都以键值对的形式存储数据，支持多种数据类型，但 iOS 使用 plist 文件，鸿蒙使用 XML 文件。
- 易用性：两者都提供了简洁的 API，易于使用。
- 轻量级：都适用于存储少量数据，不适合存储大量数据或频繁更新的数据。
- 持久化：数据都会持久化到设备上，即使应用被关闭或重启，数据仍然保留。
- 性能：读写速度快，但大量数据或频繁更新可能影响性能。
- 安全性：都不适合存储敏感信息，建议使用其他安全存储机制。
- 使用场景：都适用于存储用户的偏好设置和应用状态等轻量级数据。
- API 示例：两者的 API 使用方式相似，但具体语法有所不同。
- 数据量限制：iOS 没有明确的数据量限制，但建议不要存储大量数据；鸿蒙建议存储的数据不超过一万条。
- 开发语言支持：iOS 主要支持 Swift 和 Objective-C，鸿蒙支持 Java 和 C++，近期新增了 JS/TypeScript 接口。
希望这个表格能帮助你更好地理解和对比 iOS 的 UserDefaults 和鸿蒙的 Preferences。
二、约束限制
- 首选项无法保证进程并发安全，会有文件损坏和数据丢失的风险，不支持在多进程场景下使用。
- Key键为string类型，要求非空且长度不超过1024个字节。
- 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过16 * 1024 * 1024个字节。
- 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过
一万条，否则会在内存方面产生较大的开销。
三、 接口说明
以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见用户首选项。
| 接口名称 | 描述 |
|---|---|
| getPreferencesSync(context: Context, options: Options): Preferences | 获取Preferences实例。该接口存在异步接口。 |
| putSync(key: string, value: ValueType): void | 将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。 |
| hasSync(key: string): boolean | 检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。 |
| getSync(key: string, defValue: ValueType): ValueType | 获取键对应的值，如果值为null或者非默认值类型，返回默认数据defValue。该接口存在异步接口。 |
| deleteSync(key: string): void | 从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。 |
| flush(callback: AsyncCallback): void | 将当前Preferences实例的数据异步存储到用户首选项持久化文件中。 |
| on(type: 'change', callback: Callback): void | 订阅数据变更，订阅的数据发生变更后，在执行flush方法后，触发callback回调。 |
| off(type: 'change', callback?: Callback): void | 取消订阅数据变更。 |
| deletePreferences(context: Context, options: Options, callback: AsyncCallback): void | 从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。 |
四、开发步骤
-
1. 导入@kit.ArkData模块。
import { preferences } from '@kit.ArkData'; -
2. 获取Preferences实例。
import { UIAbility } from '@kit.AbilityKit';import { BusinessError } from '@kit.BasicServicesKit';import { window } from '@kit.ArkUI'; let dataPreferences: preferences.Preferences | null = null; class EntryAbility extends UIAbility { onWindowStageCreate(windowStage: window.WindowStage) { let options: preferences.Options = { name: 'myStore' }; dataPreferences = preferences.getPreferencesSync(this.context, options); }} -
3. 写入数据。
使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。
说明: 当对应的键已经存在时，putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。
示例代码如下所示：
import { util } from '@kit.ArkTS';if (dataPreferences.hasSync('startup')) { console.info("The key 'startup' is contained.");} else { console.info("The key 'startup' does not contain."); // 此处以此键值对不存在时写入数据为例 dataPreferences.putSync('startup', 'auto'); // 当字符串有特殊字符时，需要将字符串转为Uint8Array类型再存储 let uInt8Array1 = new util.TextEncoder().encodeInto("~！@#￥%……&*（）——+？"); dataPreferences.putSync('uInt8', uInt8Array1);} -
4. 读取数据。
使用getSync()方法获取数据，即指定键对应的值。如果值为null或者非默认值类型，则返回默认数据。
示例代码如下所示：
let val = dataPreferences.getSync('startup', 'default');console.info("The 'startup' value is " + val);// 当获取的值为带有特殊字符的字符串时，需要将获取到的Uint8Array转换为字符串let uInt8Array2 : preferences.ValueType = dataPreferences.getSync('uInt8', new Uint8Array(0));let textDecoder = util.TextDecoder.create('utf-8');val = textDecoder.decodeToString(uInt8Array2 as Uint8Array);console.info("The 'uInt8' value is " + val); -
5. 删除数据。
使用deleteSync()方法删除指定键值对，示例代码如下所示：
dataPreferences.deleteSync('startup'); -
6. 数据持久化。
应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示：
dataPreferences.flush((err: BusinessError) => { if (err) { console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); return; } console.info('Succeeded in flushing.');}) -
7. 订阅数据变更。
应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。示例代码如下所示：
let observer = (key: string) => { console.info('The key' + key + 'changed.');}dataPreferences.on('change', observer);// 数据产生变更，由'auto'变为'manual'dataPreferences.put('startup', 'manual', (err: BusinessError) => { if (err) { console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`); return; } console.info("Succeeded in putting the value of 'startup'."); if (dataPreferences !== null) { dataPreferences.flush((err: BusinessError) => { if (err) { console.error(`Failed to flush. Code:${err.code}, message:${err.message}`); return; } console.info('Succeeded in flushing.'); }) }}) -
8. 删除指定文件。
使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。
说明: 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。 成功删除后，数据及文件将不可恢复。
示例代码如下所示：
preferences.deletePreferences(this.context, options, (err: BusinessError) => { if (err) { console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`); return; } console.info('Succeeded in deleting preferences.');})
