鸿蒙之用户首选项

        应用数据持久化，是指应用将内存中的数据通过文件或数据库的形式保存到设备上。内存中的数据形态通常是任意的数据结构或数据对象，存储介质上的数据形态可能是文本、数据库、二进制文件等，用户首选项是实现应用数据持久化的一种方式。

        用户首选项通常用于保存应用的配置信息。数据通过文本的形式保存在设备中，应用使用过程中会将文本中的数据全量加载到内存中，所以访问速度快、效率高，但不适合需要存储大量数据的场景。

场景介绍

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

运作机制

约束限制

• Key键为string类型，要求非空且长度不超过80个字节。

• 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过8192个字节。

• 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。

接口说明以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见用户首选项。

接口名称	描述
getPreferencesSync(context: Context, options: Options): Preferences	获取Preferences实例。该接口存在异步接口。
putSync(key: string, value: ValueType): void	将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。
hasSync(key: string): void	检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。
getSync(key: string, defValue: ValueType): void	获取键对应的值，如果值为null或者非默认值类型，返回默认数据defValue。该接口存在异步接口。
deleteSync(key: string): void	从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。
flush(callback: AsyncCallback<void>): void	将当前Preferences实例的数据异步存储到用户首选项持久化文件中。
on(type: 'change', callback: Callback<string>): void	订阅数据变更，订阅的数据发生变更后，在执行flush方法后，触发callback回调。
off(type: 'change', callback?: Callback<string>): void	取消订阅数据变更。
deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void	从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。

开发步骤

主要方法：

创建首选项实例-getPreferencesSync(getContext(), { key:value })

读取文件中的数据-preferences.getSync('startup', 'default');

在文件中写入数据--putSync()

删除文件中数据--preferences.deleteSync('startup');

刷盘实现数据持久化--preferences.flush(）

删除数据持久化文件-deletePreferences()

代码实现

//导入相关模块
import Preferences from '@kit.preferences';
//   创建用户首选项实例对象,并命名为keyword
let Instance = preferences.getPreferencesSync(getContext(), { name: 'keywords' })

封装首选项工具类

import { preferences } from '@kit.ArkData'
import { promptAction } from '@kit.ArkUI'


//用户首选项工具类
class PreferenceUtils {
  //   创建存储用户首选项实例的MAP对象
  preMap: Map<string, preferences.Preferences> = new Map()

  // 创建用户首选项对象
  loadPreference(filename: string) {
    let isPreferenceFile = this.preMap.has(filename)
    if (isPreferenceFile) { //判断是否存在该文件
      return
    }
    // 创建用户首选项对象
    let Instance = preferences.getPreferencesSync(getContext(), { name: filename })
    // 存入Map
    this.preMap.set(filename, Instance)
  }

  //   往首选项文件中写入值
  //   当对应的键已经存在时，putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。
  PutPreference(filename: string, key: string, value: preferences.ValueType) {
    let isPreferenceFile = this.preMap.has(filename)
    if (!isPreferenceFile) { //判断是否存在该文件
      return
    }
    let preference = this.preMap.get(filename) //读取该首选项文件
    let isExistKey = preference?.hasSync(key)
    if (!isExistKey) { //写入数据
      preference!.putSync(key, value)
      preference!.flush() //刷盘
      promptAction.showToast({ message: '首选项保存数据成功' })
    } else {
      //   修改数据
      preference!.putSync(key, value)
      preference!.flush() //刷盘
      promptAction.showToast({ message: '首选项修改数据成功' })
    }
  }

  //   读值
  getPreference(filename: string, key: string) {
    let isPreferenceFile = this.preMap.has(filename)
    if (!isPreferenceFile) { //判断是否存在该文件
      promptAction.showToast({ message: '不存在该文件' })
      return
    } else {
      let preference = this.preMap.get(filename)
      let value = preference?.getSync(key, 'defaultValue')
      return value
    }
  }

  //   删除首选项文件值
  deletePreference(filename: string, key: string) {
    let isPreferenceFile = this.preMap.has(filename)
    if (!isPreferenceFile) { //判断是否存在该文件
      return
    }
    let preference = this.preMap.get(filename)
    preference?.deleteSync(key)
    preference?.flush()
    promptAction.showToast({ message: '首选项删除数据成功' })
  }

  //删除首选项文件夹
  async deletePreferenceFile(filename: string) {
    let isPreferenceFile = this.preMap.has(filename)
    if (!isPreferenceFile) { //判断是否存在该文件
      promptAction.showToast({ message: '不存在该文件' })
      return
    }
    try {
      await preferences.deletePreferences(getContext(), { name: filename })
      this.preMap.delete(filename)
      return true
    } catch (e) {
      return false
    }
  }

  //   查询所有的用户首选项文件
  queryAllPreference() {
    let fileNameMap = this.preMap.keys()
    let filenameArr = Array.from(fileNameMap)//将Map值转换为数组
    return JSON.stringify(filenameArr)
  }
}