HarmonyOS NEXT实战：持久化存储-首选项工具

HarmonyOS Next实战##HarmonyOS SDK应用服务##教育

目标：封装Preferences工具类，实现持久化存储数据。

用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据，当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大，因此，Preferences不适合存放过多的数据，也不支持通过配置加密，适用的场景一般为应用保存用户的个性化设置（字体大小，是否开启夜间模式）等。

运作机制
如图所示，用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到主动从内存中移除该实例或者删除该文件。

应用首选项的持久化文件保存在应用沙箱内部，可以通过context获取其路径。具体可见获取应用文件路径。

约束限制：

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

实战：PreferencesService

import {
    preferences } from '@kit.ArkData'

export default class PreferencesService {
   
  /**
   * 保存key和value（新增和更新）
   * @param key
   * @param value
   */
  static save(key: string, value: preferences.ValueType) {
   
    const pfr = getPreferences()
    pfr.putSync(key, value)
    pfr.flush()
    // // 当字符串有特殊字符时，需要将字符串转为Uint8Array类型再存储
    // let uInt8Array1 = new util.TextEncoder().encodeInto("~！@#￥%……&*（）——+？");
    // dataPreferences.putSync('uInt8', uInt8Array1);
  }

  /**
   * 根据key删除
   * @param key
   */
  static delete(key: string) {
   
    const pfr = getPreferences()
    pfr.deleteSync(key)
    pfr.flush()
  }

  // static get(key: string, defaultValue: preferences.ValueType) : preferences.ValueType{
   
  /**
   * 根据preferencesItem的key获取value，有该项则获取对应的value，没有则返回preferencesItem.defaultValue
   * @param preferencesItem
   * @returns
   */
  static get(preferencesItem: PreferencesItem): preferences.ValueType {
   
    const pfr = getPreferences()
    return pfr.getSync(preferencesItem.key, preferencesItem.defaultValue)
  }

  /**
   * 清除全部信息
   */
  static clear(){
   
    const pfr = getPreferences()
    pfr.clearSync()
    pfr.flush()
  }
}

/**
 * 获取preferences实例
 * @returns
 */
function getPreferences(): preferences.Preferences {
   
  const context = AppStorage.get<Context>('ablity_context')
  const pfr = preferences.getPreferencesSync(context, {
    name: 'my_preferences' })
  return pfr
}

export interface PreferencesItem {
   
  key: string;
  defaultValue: preferences.ValueType;
}