鸿蒙Harmony-数据持久化（Preferences）详解

早安脚下的路没人能替你决定方向，你心中的梦也没人能代替你去完成，你若想得到这世界最好的东西，就先让世界看到最好的你，当你努力把该做的事情都做好，生活也会把该属于你的东西再合适的时候都给你

目录

一 ，定义

二，运作机制

三，约束限制

四，接口说明

五，使用

5.1 获取Preference

5.2 写入数据

5.3 读取数据

5.4 删除数据

5.5?数据持久化

5.6 删除指定文件

一 ，定义

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

二，运作机制

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

三，约束限制

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

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

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

四，接口说明

接口名称	描述
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: ( key : string ) => void): void	订阅数据变更，订阅的Key的值发生变更后，在执行flush方法后，触发callback回调。
off(type: ‘change’, callback?: ( key : string ) => void): void	取消订阅数据变更。
deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void	从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。

五，使用

5.1 获取Preference

import dataPreferences from '@ohos.data.preferences';



dataPreferences.getPreferences(this.context, "yuanzhen").then(preferences=>{
      

    }).catch((err:Error)=>{

    })

5.2 写入数据

dataPreferences.getPreferences(this.context, "yuanzhen").then(preferences=>{
      //写入数据
      if(!preferences.has("yuanzhen")){
        preferences.put("yuanzhen","111")
      }
      

    }).catch((err:Error)=>{

    })

5.3 读取数据

dataPreferences.getPreferences(this.context, "yuanzhen").then(preferences=>{
     
      //读取数据
      preferences.get("yuanzhen","默认数据").then((value)=>{
        hilog.info(0x0000, 'testTag', '读取数据成功: %{public}s', value);
      })
      

    }).catch((err:Error)=>{

    })

5.4 删除数据

dataPreferences.getPreferences(this.context, "yuanzhen").then(preferences=>{
      
      //删除数据
      preferences.delete("yuanzhen")



    }).catch((err:Error)=>{

    })

5.5?数据持久化

dataPreferences.getPreferences(this.context, "yuanzhen").then(preferences=>{
      
      //数据持久化
      preferences.flush()



    }).catch((err:Error)=>{

    })

5.6 删除指定文件

注意：

1，调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。

2，成功删除后，数据及文件将不可恢复。

dataPreferences.deletePreferences(this.context,"yuanzhen",(err:Error)=>{
  
})