通过用户首选项进行数据持久化

是什么:

用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。

作用:

当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。

运作机制:

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

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

限制:

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

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

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

 使用:

初始化首选项实例:

const KEY = 'UserInfo'
//获得首选项实例
//{ name: 'user' } 应用首选项的持久化文件的名字叫user
const preferenceInstance = preferences.getPreferencesSync(getContext(), { name: 'user' })

写入数据并持久化:

// 写入数据并持久化
  setPreferenceData(userinfo:user) {
    //Key 要写入数据的key
    //value 要写入的数据
    preferenceInstance.putSync(KEY, JSON.stringify(userinfo))

    //将数据写入到文件中
    preferenceInstance.flush()
  }

注意:当对应的键已经存在时，putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。

获取首选项数据:

 //获取首选项数据
  getPreferenceData() {
    // 第一个参数KEY:要获取数据的key
    // 第二个参数defValue：如果没有读取到数据，则返回默认数据
    return preferenceInstance.getSync(KEY,'')
  }

删除指定Key的数据:

 delPreferenceData(){
    //删除指定KEY的数据
    preferenceInstance.deleteSync(KEY)
  }

获取首选项文件的目录:

getPreferenceDir(){
    //获取首选项文件的目录
    return getContext().preferencesDir
  }

首选项文件操作演示代码:

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

const KEY = 'UserInfo'
//获得首选项实例
const preferenceInstance = preferences.getPreferencesSync(getContext(), { name: 'user' })

class user {
  name: string
  age: number

  constructor(name: string, age: number) {
    this.name = name;
    this.age = age;
  }
}

@Entry
@Component
struct PreferencesPage {
  // 写入数据并持久化
  setPreferenceData(userinfo:user) {
    //Key 要写入数据的key
    //value 要写入的数据
    preferenceInstance.putSync(KEY, JSON.stringify(userinfo))

    //将数据写入到文件中
    preferenceInstance.flush()
  }

  //获取首选项数据
  getPreferenceData() {
    // 第一个参数KEY:要获取数据的key
    // 第二个参数defValue：如果没有读取到数据，则返回默认数据
    return preferenceInstance.getSync(KEY,'')
  }

  delPreferenceData(){
    //删除指定KEY的数据
    preferenceInstance.deleteSync(KEY)
  }

  getPreferenceDir(){
    //获取首选项文件的目录
    return getContext().preferencesDir
  }

  build() {
    Row() {
      Column() {
        Button('向首选项保存数据')
          .onClick(()=>{
            this.setPreferenceData(new user('张三',16))
            promptAction.showToast({message:'保存成功'})
          })

        Button('更新首选项数据')
          .onClick(()=>{
            this.setPreferenceData(new user('李四',18))
            promptAction.showToast({message:'更新成功'})
          })

        Button('获取首选项数据')
          .onClick(()=>{
            const store=this.getPreferenceData()
            promptAction.showToast({message:store.toString()})
          })
        Button('删除首选项数据')
          .onClick(()=>{
            this.delPreferenceData()
            promptAction.showToast({message:'删除成功'})
          })

        Button('获取首选项文件路径')
          .onClick(()=>{
            const dir=this.getPreferenceDir()
            promptAction.showToast({message:dir})
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

查看文件: