通过用户首选项实现数据持久化场景介绍用户首选项为应用提供Key-Value键值型的数据处理能力支持应用持久化轻量级数据并对其修改和查询。当用户希望有一个全局唯一存储的地方可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中当用户读取的时候能够快速从内存中获取数据当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大因此Preferences不适合存放过多的数据也不支持通过配置加密适用的场景一般为应用保存用户的个性化设置字体大小是否开启夜间模式等。运作机制如图所示用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例每个文件唯一对应到一个Preferences实例系统会通过静态容器将该实例存储在内存中直到主动从内存中移除该实例或者删除该文件。应用首选项的持久化文件保存在应用沙箱内部可以通过context获取其路径。具体可见获取应用文件路径。约束限制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): boolean检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。getSync(key: string, defValue: ValueType): ValueType获取键对应的值如果值为null或者非默认值类型返回默认数据defValue。该接口存在异步接口。deleteSync(key: string): void从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。flush(callback: AsyncCallback): void将当前Preferences实例的数据异步存储到用户首选项持久化文件中。on(type: ‘change’, callback: Callback): void订阅数据变更订阅的数据发生变更后在执行flush方法后触发callback回调。off(type: ‘change’, callback?: Callback): void取消订阅数据变更。deletePreferences(context: Context, options: Options, callback: AsyncCallback): void从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件则同时删除其持久化文件。开发步骤导入kit.ArkData模块。import { preferences } from kit.ArkData;获取Preferences实例。Stage模型示例import { UIAbility } from kit.AbilityKit; import { BusinessError } from kit.BasicServicesKit; import { window } from kit.ArkUI; let dataPreferences: preferences.Preferences | null null; class EntryAbility extends UIAbility { onWindowStageCreate(windowStage: window.WindowStage) { let options: preferences.Options { name: myStore }; dataPreferences preferences.getPreferencesSync(this.context, options); } }FA模型示例// 获取context import { featureAbility } from kit.AbilityKit; import { BusinessError } from kit.BasicServicesKit; let context featureAbility.getContext(); let options: preferences.Options { name: myStore }; let dataPreferences: preferences.Preferences preferences.getPreferencesSync(context, options);写入数据。使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后如有需要可使用flush()方法将Preferences实例的数据存储到持久化文件。说明当对应的键已经存在时putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。示例代码如下所示import { util } from kit.ArkTS; if (dataPreferences.hasSync(startup)) { console.info(The key startup is contained.); } else { console.info(The key startup does not contain.); // 此处以此键值对不存在时写入数据为例 dataPreferences.putSync(startup, auto); // 当字符串有特殊字符时需要将字符串转为Uint8Array类型再存储 let uInt8Array1 new util.TextEncoder().encodeInto(~#%……*——); dataPreferences.putSync(uInt8, uInt8Array1); }读取数据。使用getSync()方法获取数据即指定键对应的值。如果值为null或者非默认值类型则返回默认数据。示例代码如下所示let val dataPreferences.getSync(startup, default); console.info(The startup value is val); // 当获取的值为带有特殊字符的字符串时需要将获取到的Uint8Array转换为字符串 let uInt8Array2 : preferences.ValueType dataPreferences.getSync(uInt8, new Uint8Array(0)); let textDecoder util.TextDecoder.create(utf-8); val textDecoder.decodeWithStream(uInt8Array2 as Uint8Array); console.info(The uInt8 value is val);删除数据。使用deleteSync()方法删除指定键值对示例代码如下所示dataPreferences.deleteSync(startup);数据持久化。应用存入数据到Preferences实例后可以使用flush()方法实现数据持久化。示例代码如下所示dataPreferences.flush((err: BusinessError) { if (err) { console.error(Failed to flush. Code:${err.code}, message:${err.message}); return; } console.info(Succeeded in flushing.); })订阅数据变更。应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后当执行flush()方法时observer被触发回调。示例代码如下所示let observer (key: string) { console.info(The key key changed.); } dataPreferences.on(change, observer); // 数据产生变更由auto变为manual dataPreferences.put(startup, manual, (err: BusinessError) { if (err) { console.error(Failed to put the value of startup. Code:${err.code},message:${err.message}); return; } console.info(Succeeded in putting the value of startup.); if (dataPreferences ! null) { dataPreferences.flush((err: BusinessError) { if (err) { console.error(Failed to flush. Code:${err.code}, message:${err.message}); return; } console.info(Succeeded in flushing.); }) } })删除指定文件。使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例包括内存中的数据。若该Preference存在对应的持久化文件则同时删除该持久化文件包括指定文件及其备份文件、损坏文件。说明调用该接口后应用不允许再使用该Preferences实例进行数据操作否则会出现数据一致性问题。成功删除后数据及文件将不可恢复。示例代码如下所示preferences.deletePreferences(this.context, options, (err: BusinessError) { if (err) { console.error(Failed to delete preferences. Code:${err.code}, message:${err.message}); return; } console.info(Succeeded in deleting preferences.); })实战 : 登录数据存储接口设计export interface LoginUserInfo{ username: string password: string validCode: string } interface responseData { code: string msg: string data:userInfo } export interface userInfo{ address:string age:number avatar:string flag:string id:number nickname:string password:string phone:string sex:string username:string }封装用户首选项新建ets文件创建preferences类、实例化对象class PreferencesUtil{ ... } let preferencesUtil new PreferencesUtil() export default preferencesUtil创建对象列表对象名–preferences实例化对象import preferences from ohos.data.preferences; import { Context } from kit.AbilityKit; ... class PreferencesUtil{ prefMap new MapString, preferences.Preferences(); datapreferences : preferences.Preferences |null null; async loadPreference(context:Context,name:string){ try { let pref await preferences.getPreferences(context,name); this.prefMap.set(name, pref); }catch (err ){} } ...... }putKey封装//放入数据 async putKey(name:string, key:string, value:preferences.ValueType|userInfo) { if (!this.prefMap.has(name)) { return; } try { let pref this.prefMap.get(name); await pref?.put(key, value) await pref?.flush() } catch (err) { } }getKey封装//提取数据 async getKey(name:string, key:string,defaultValue:preferences.ValueType): Promisepreferences.ValueType|void { if (!this.prefMap.has(name)) { console.log(preference 不存在) return; } try { let pref this.prefMap.get(name); let val await pref?.get(key, defaultValue) console.log(get preference,key) return val; } catch (err) { console.log(get preference 失败,JSON.stringify(err)) } }页面创建时初始化创建preferences对象preferencesUtil.loadPreference(this.context,myPreferences)调用完整代码//preferenceutil.ets import preferences from ohos.data.preferences; import { Context } from kit.AbilityKit; import { userInfo } from ../pages/Login/HttpUtil; class PreferencesUtil{ prefMap new MapString, preferences.Preferences(); datapreferences : preferences.Preferences |null null; async loadPreference(context:Context,name:string){ try { let pref await preferences.getPreferences(context,name); this.prefMap.set(name, pref); }catch (err ){ } } //放入数据 async putKey(name:string, key:string, value:preferences.ValueType|userInfo) { if (!this.prefMap.has(name)) { return; } try { let pref this.prefMap.get(name); await pref?.put(key, value) await pref?.flush() } catch (err) { } } //提取数据 async getKey(name:string, key:string,defaultValue:preferences.ValueType|userInfo): Promisepreferences.ValueType|void { if (!this.prefMap.has(name)) { console.log(preference 不存在) return; } try { let pref this.prefMap.get(name); let val await pref?.get(key, defaultValue) console.log(get preference,key) return val; } catch (err) { console.log(get preference 失败,JSON.stringify(err)) } } } let preferencesUtil new PreferencesUtil() export default preferencesUtil//LoginUtil import axios, { AxiosResponse } from ohos/axios import preferencesUtil from ../../utils/preferenceutil; export interface LoginUserInfo{ username: string password: string validCode: string } interface responseData { code: string msg: string data:userInfo } export interface userInfo{ address:string age:number avatar:string flag:string id:number nickname:string password:string phone:string sex:string username:string } export function LoginPOST(user:LoginUserInfo){ axios.postresponseData, AxiosResponseresponseData, LoginUserInfo( https://xxx.xxx/user/login, user, { headers:{ Content-Type: application/json } } ) .then((response: AxiosResponseresponseData) { if (response.data.code 0) { let val response.data.data; console.log(login-val,val); preferencesUtil.putKey(myPreferences,userInfo,val) } }) } export async function readUserInfo(key: string) { try { const val await preferencesUtil.getKey(myPreferences, key, unknowns); let value val as userInfo; console.log(ss,value.address,typeof value) } catch (error) { console.error(读取用户信息时出错:, error); } }
通过用户首选项实现数据持久化
通过用户首选项实现数据持久化场景介绍用户首选项为应用提供Key-Value键值型的数据处理能力支持应用持久化轻量级数据并对其修改和查询。当用户希望有一个全局唯一存储的地方可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中当用户读取的时候能够快速从内存中获取数据当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大因此Preferences不适合存放过多的数据也不支持通过配置加密适用的场景一般为应用保存用户的个性化设置字体大小是否开启夜间模式等。运作机制如图所示用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例每个文件唯一对应到一个Preferences实例系统会通过静态容器将该实例存储在内存中直到主动从内存中移除该实例或者删除该文件。应用首选项的持久化文件保存在应用沙箱内部可以通过context获取其路径。具体可见获取应用文件路径。约束限制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): boolean检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。getSync(key: string, defValue: ValueType): ValueType获取键对应的值如果值为null或者非默认值类型返回默认数据defValue。该接口存在异步接口。deleteSync(key: string): void从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。flush(callback: AsyncCallback): void将当前Preferences实例的数据异步存储到用户首选项持久化文件中。on(type: ‘change’, callback: Callback): void订阅数据变更订阅的数据发生变更后在执行flush方法后触发callback回调。off(type: ‘change’, callback?: Callback): void取消订阅数据变更。deletePreferences(context: Context, options: Options, callback: AsyncCallback): void从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件则同时删除其持久化文件。开发步骤导入kit.ArkData模块。import { preferences } from kit.ArkData;获取Preferences实例。Stage模型示例import { UIAbility } from kit.AbilityKit; import { BusinessError } from kit.BasicServicesKit; import { window } from kit.ArkUI; let dataPreferences: preferences.Preferences | null null; class EntryAbility extends UIAbility { onWindowStageCreate(windowStage: window.WindowStage) { let options: preferences.Options { name: myStore }; dataPreferences preferences.getPreferencesSync(this.context, options); } }FA模型示例// 获取context import { featureAbility } from kit.AbilityKit; import { BusinessError } from kit.BasicServicesKit; let context featureAbility.getContext(); let options: preferences.Options { name: myStore }; let dataPreferences: preferences.Preferences preferences.getPreferencesSync(context, options);写入数据。使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后如有需要可使用flush()方法将Preferences实例的数据存储到持久化文件。说明当对应的键已经存在时putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。示例代码如下所示import { util } from kit.ArkTS; if (dataPreferences.hasSync(startup)) { console.info(The key startup is contained.); } else { console.info(The key startup does not contain.); // 此处以此键值对不存在时写入数据为例 dataPreferences.putSync(startup, auto); // 当字符串有特殊字符时需要将字符串转为Uint8Array类型再存储 let uInt8Array1 new util.TextEncoder().encodeInto(~#%……*——); dataPreferences.putSync(uInt8, uInt8Array1); }读取数据。使用getSync()方法获取数据即指定键对应的值。如果值为null或者非默认值类型则返回默认数据。示例代码如下所示let val dataPreferences.getSync(startup, default); console.info(The startup value is val); // 当获取的值为带有特殊字符的字符串时需要将获取到的Uint8Array转换为字符串 let uInt8Array2 : preferences.ValueType dataPreferences.getSync(uInt8, new Uint8Array(0)); let textDecoder util.TextDecoder.create(utf-8); val textDecoder.decodeWithStream(uInt8Array2 as Uint8Array); console.info(The uInt8 value is val);删除数据。使用deleteSync()方法删除指定键值对示例代码如下所示dataPreferences.deleteSync(startup);数据持久化。应用存入数据到Preferences实例后可以使用flush()方法实现数据持久化。示例代码如下所示dataPreferences.flush((err: BusinessError) { if (err) { console.error(Failed to flush. Code:${err.code}, message:${err.message}); return; } console.info(Succeeded in flushing.); })订阅数据变更。应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后当执行flush()方法时observer被触发回调。示例代码如下所示let observer (key: string) { console.info(The key key changed.); } dataPreferences.on(change, observer); // 数据产生变更由auto变为manual dataPreferences.put(startup, manual, (err: BusinessError) { if (err) { console.error(Failed to put the value of startup. Code:${err.code},message:${err.message}); return; } console.info(Succeeded in putting the value of startup.); if (dataPreferences ! null) { dataPreferences.flush((err: BusinessError) { if (err) { console.error(Failed to flush. Code:${err.code}, message:${err.message}); return; } console.info(Succeeded in flushing.); }) } })删除指定文件。使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例包括内存中的数据。若该Preference存在对应的持久化文件则同时删除该持久化文件包括指定文件及其备份文件、损坏文件。说明调用该接口后应用不允许再使用该Preferences实例进行数据操作否则会出现数据一致性问题。成功删除后数据及文件将不可恢复。示例代码如下所示preferences.deletePreferences(this.context, options, (err: BusinessError) { if (err) { console.error(Failed to delete preferences. Code:${err.code}, message:${err.message}); return; } console.info(Succeeded in deleting preferences.); })实战 : 登录数据存储接口设计export interface LoginUserInfo{ username: string password: string validCode: string } interface responseData { code: string msg: string data:userInfo } export interface userInfo{ address:string age:number avatar:string flag:string id:number nickname:string password:string phone:string sex:string username:string }封装用户首选项新建ets文件创建preferences类、实例化对象class PreferencesUtil{ ... } let preferencesUtil new PreferencesUtil() export default preferencesUtil创建对象列表对象名–preferences实例化对象import preferences from ohos.data.preferences; import { Context } from kit.AbilityKit; ... class PreferencesUtil{ prefMap new MapString, preferences.Preferences(); datapreferences : preferences.Preferences |null null; async loadPreference(context:Context,name:string){ try { let pref await preferences.getPreferences(context,name); this.prefMap.set(name, pref); }catch (err ){} } ...... }putKey封装//放入数据 async putKey(name:string, key:string, value:preferences.ValueType|userInfo) { if (!this.prefMap.has(name)) { return; } try { let pref this.prefMap.get(name); await pref?.put(key, value) await pref?.flush() } catch (err) { } }getKey封装//提取数据 async getKey(name:string, key:string,defaultValue:preferences.ValueType): Promisepreferences.ValueType|void { if (!this.prefMap.has(name)) { console.log(preference 不存在) return; } try { let pref this.prefMap.get(name); let val await pref?.get(key, defaultValue) console.log(get preference,key) return val; } catch (err) { console.log(get preference 失败,JSON.stringify(err)) } }页面创建时初始化创建preferences对象preferencesUtil.loadPreference(this.context,myPreferences)调用完整代码//preferenceutil.ets import preferences from ohos.data.preferences; import { Context } from kit.AbilityKit; import { userInfo } from ../pages/Login/HttpUtil; class PreferencesUtil{ prefMap new MapString, preferences.Preferences(); datapreferences : preferences.Preferences |null null; async loadPreference(context:Context,name:string){ try { let pref await preferences.getPreferences(context,name); this.prefMap.set(name, pref); }catch (err ){ } } //放入数据 async putKey(name:string, key:string, value:preferences.ValueType|userInfo) { if (!this.prefMap.has(name)) { return; } try { let pref this.prefMap.get(name); await pref?.put(key, value) await pref?.flush() } catch (err) { } } //提取数据 async getKey(name:string, key:string,defaultValue:preferences.ValueType|userInfo): Promisepreferences.ValueType|void { if (!this.prefMap.has(name)) { console.log(preference 不存在) return; } try { let pref this.prefMap.get(name); let val await pref?.get(key, defaultValue) console.log(get preference,key) return val; } catch (err) { console.log(get preference 失败,JSON.stringify(err)) } } } let preferencesUtil new PreferencesUtil() export default preferencesUtil//LoginUtil import axios, { AxiosResponse } from ohos/axios import preferencesUtil from ../../utils/preferenceutil; export interface LoginUserInfo{ username: string password: string validCode: string } interface responseData { code: string msg: string data:userInfo } export interface userInfo{ address:string age:number avatar:string flag:string id:number nickname:string password:string phone:string sex:string username:string } export function LoginPOST(user:LoginUserInfo){ axios.postresponseData, AxiosResponseresponseData, LoginUserInfo( https://xxx.xxx/user/login, user, { headers:{ Content-Type: application/json } } ) .then((response: AxiosResponseresponseData) { if (response.data.code 0) { let val response.data.data; console.log(login-val,val); preferencesUtil.putKey(myPreferences,userInfo,val) } }) } export async function readUserInfo(key: string) { try { const val await preferencesUtil.getKey(myPreferences, key, unknowns); let value val as userInfo; console.log(ss,value.address,typeof value) } catch (error) { console.error(读取用户信息时出错:, error); } }
