HarmonyOS NEXT - Preferences用户首选项

• 用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。
• Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据。Preferences会随着存放的数据量越多而导致应用占用的内存越大，因此，Preferences不适合存放过多的数据。

适用的场景：为应用保存用户的个性化设置（字体大小，是否开启夜间模式）和个性化信息（用户名，登录有效期）等。

约束限制

• 首选项无法保证进程并发安全，会有文件损坏和数据丢失的风险，不支持在多进程场景下使用。
• Key键为string类型，要求非空且长度不超过1024个字节。
• 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过16 * 1024 * 1024个字节。
• 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。
• 当存储的数据中包含非UTF-8格式的字符串时，请使用Uint8Array类型存储，否则会造成持久化文件出现格式错误造成文件损坏。
• 当调用removePreferencesFromCache或者deletePreferences后，订阅的数据变更会主动取消订阅，重新getPreferences后需要重新订阅数据变更。
• 不允许deletePreferences与其他接口多线程、多进程并发调用，否则会发生不可预期行为。

运作机制：

• 用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到主动从内存中移除该实例或者删除该文件。
• 应用首选项的持久化文件保存在应用沙箱内部，可以通过context获取其路径。具体可见获取应用文件路径。

接口说明：

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>): void//将当前Preferences实例的数据异步存储到用户首选项持久化文件中。

代码示例
PreferencesUtil

export class PreferencesUtil {
  static getPreferences(context?: Context, preferencesFileName = "MyPreferences") {
    context = context || getContext()
    let options: preferences.Options = { name: preferencesFileName }
    return preferences.getPreferencesSync(context, options);
  }

  static async setData(key: string, value: string, context?: Context) {
    const store = PreferencesUtil.getPreferences(context);
    store.putSync(key, value)
    await store.flush()
  }

  static getData(key: string, context?: Context) {
    const store = PreferencesUtil.getPreferences(context);
    return store.getSync(key, "") as string
  }
}

使用方式

const list = PreferencesUtil.getData("beautyList");
PreferencesUtil.setData("beautyList", JSON.stringify(this.data.getAllData()));