用户首选项
场景介绍
1、用户首选项为应用提供Key-Value键值型的数据处理能力,支持应用持久化轻量级数据,并对其修改和查询。当用户希望有一个全局唯一存储的地方,可以采用用户首选项来进行存储。
2、Preferences会将该数据缓存在内存中,当用户读取的时候,能够快速从内存中获取数据
3、当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。
4、Preferences会随着存放的数据量越多而导致应用占用的内存越大,因此,Preferences不适合存放过多的数据,也不支持通过配置加密,适用的场景一般为应用保存用户的个性化设置(字体大小,是否开启夜间模式)等
运作机制
如图所示,用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例,每个文件唯一对应到一个Preferences实例,系统会通过静态容器将该实例存储在内存中,直到主动从内存中移除该实例或者删除该文件。
存储约束限制
1、Key键为string类型,要求非空且长度不超过80个字节。
2、如果Value值为string类型,请使用UTF-8编码格式,可以为空,不为空时长度不超过8192个字节。
3、内存会随着存储数据量的增大而增大,所以存储的数据量应该是轻量级的,建议存储的数据不超过一万条,否则会在内存方面产生较大的开销。键值型数据库
接口说明
1、获取Preferences实例,存在异步接口
getPreferencesSync(context: Context, options: Options): Preferences
参数:
context: 当前上下文
options: 存储数据
调用者:preferences
2、将数据写入Preferences实例,通过flush刷盘实现持久化,存在异步接口
putSync(key: string, value: ValueType): void
参数:
key:存储的键
value:存储的值
调用者:Preferences实例
2.1、将当前Preferences实例的数据异步存储到用户首选项持久化文件中。
flush(callback: AsyncCallback<void>): void
参数:
callback:处理刷盘结果的回调
调用者:Preferences实例
3、检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。
hasSync(key: string): void
参数:
key:查询的键
调用者:
Preferences实例
4、获取键对应的值,如果值为null或者非默认值类型,返回默认数据defValue。该接口存在异步接口。
getSync(key: string, defValue: ValueType): void
参数:
key:获取的键
defValue:如果获取的键没有值,使用默认值
调用者:
Preferences实例
5、从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。
deleteSync(key: string): void
参数:
key:删除的键
调用者:
Preferences实例
6、订阅数据变更,订阅的数据发生变更后,在执行flush方法后,触发callback回调。
on(type: 'change', callback: Callback<string>): void
参数:
callback:应用订阅数据变更需要指定回调方法
调用者:
Preferences实例
7、取消订阅数据变更。
off(type: 'change', callback?: Callback<string>): void
参数:
callback:应用订阅数据变更的回调方法
调用者:
Preferences实例
8、从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件,则同时删除其持久化文件。
deletePreferences(context: Context, options: Options, callback: AsyncCallback<void>): void
参数:
context:删除的上下文
options:删除实例的数据
callback:删除对应的实例
调用者:
Preferences实例
用户首选项基本使用
// 引入preferences
import preferences from '@ohos.data.preferences';class PreferencesUtil{prefMap: Map<string, preferences.Preferences> = new Map()// 获取Preferences实例async loadPreference(context, name: string){try { // 加载preferenceslet pref = await preferences.getPreferences(context, name)this.prefMap.set(name, pref)console.log('testTag', `加载Preferences[${name}]成功`)} catch (e) {console.log('testTag', `加载Preferences[${name}]失败`, JSON.stringify(e))}}async putPreferenceValue(name: string, key: string, value: preferences.ValueType){if (!this.prefMap.has(name)) {console.log('testTag', `Preferences[${name}]尚未初始化!`)return}try {let pref = this.prefMap.get(name)// 写入数据await pref.put(key, value)// 刷盘await pref.flush()console.log('testTag', `保存Preferences[${name}.${key} = ${value}]成功`)} catch (e) {console.log('testTag', `保存Preferences[${name}.${key} = ${value}]失败`, JSON.stringify(e))}}async getPreferenceValue(name: string, key: string, defaultValue: preferences.ValueType){if (!this.prefMap.has(name)) {console.log('testTag', `Preferences[${name}]尚未初始化!`)return}try {let pref = this.prefMap.get(name)// 读数据let value = await pref.get(key, defaultValue)console.log('testTag', `读取Preferences[${name}.${key} = ${value}]成功`)return value} catch (e) {console.log('testTag', `读取Preferences[${name}.${key} ]失败`, JSON.stringify(e))}}
}const preferencesUtil = new PreferencesUtil()export default preferencesUtil as PreferencesUtil
键值型数据库
关系型数据库