【HarmonyOS NEXT】数据持久化 - 用户首选项

用户首选项（Preference）为应用提供 key-value 键值型的数据处理能力，支持应用持久化轻量型数据。

一、用户首选项完成数据持久化的过程

首先创建首选项实例，一个应用内部可以创建多个首选项实例，这样可以在应用的不同模块用不同的实例，避免相互之间干扰。每一个用户首选项的实例都会对应应用隔离沙箱内的一个持久化文件，当我们去调用用户首选项相关接口进行数据读写的时候，它就会去操作那个持久化文件，从而实现对数据持久化以及读写操作。

二、用户首选项具体使用步骤

1. 导入首选项模块

   import dataPreference from '@ohos.data.preferences'
   

2. 获取首选项实例，读取指定文件

   dataPreferences.getPreferences(this.getContext(), 'MyAppPreferences')
     .then(preferences => {
       // 获取成功
     })
     .catch((error: Error) => {
      // 获取失败
     })
   

   • this.getContext()：上下文，也就是 UIAbilityContext
   • MyAppPreferences：是 Preferences 实例名称

   注：获取首选项实例肯定要读写磁盘上的持久化文件，这是一个 I/O 操作，比较耗时，所以它是一个异步的，因此，调用这个方法不会立刻返回 Preferences 对象，而是返回一个 Promise，所以会发现依然调用了 then 和 catch。

3. 数据操作

   // 写入数据，如果已经存在则会覆盖，可利用 .has() 判断是否存在
   preferences.put('key', value)
     .then(() => preferences.flush())   // 刷到磁盘
     .catch((error: Error) => {})       // 处理异常 
   

   // 删除数据
   preferences.delete('key')
     .then(() => {})
     .catch((error: Error) => {})
   

   // 查询数据
   preferences.get('key', 'defaultValue')
     .then(value => console.log('查询成功'))
     .catch((error: Error) => console.log('查询失败'))
   

   说明：

   • Key 为 string 类型，要求非空且长度不超过80字节
   • Value 可以是 string、number、boolean 及以上类型数组，大小不超过8192字节
   • 数据量建议不超过一万条