HarmonyOS本地存储-Preferences(用户首选项)的使用

一，用户首选项简述

1. @ohos.data.preferences (用户首选项)

复制代码

用户首选项为应用提供Key-Value键值型的数据处理惩罚能力，支持应用持久化轻量级数据，并对其修改和查询。
数据存储形式为键值对，键的范例为字符串型，值的存储数据范例包罗数字型、字符型、布尔型以及这3种范例的数组范例。
说明：
本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
具体详情查看官网，地点：
文档中央
二，常用接口介绍

• 数据保存（putString）
  
• 获取数据（getString）
  
• 是否包罗指定的key（has）
  
• 数据持久化（flush）
  
• 修改数据（update）
  
• 删除数据（delete）
  
• 清空数据（clear）
  

 三，创建单列GlobalContext，方便后期可以通过单例直接获取实例；由于get()返回值范例是不确定性，定义一个联合范例的别名ValueType 来接收

1. export default class GlobalContext {
2.   private constructor() {
3.   }
5.   private static instance: GlobalContext
6.   private _objects = new Map<string, Object>()
8.   public static getContext(): GlobalContext {
9.     if (!GlobalContext.instance) {
10.       GlobalContext.instance = new GlobalContext()
11.     }
12.     return GlobalContext.instance
13.   }
15.   getObject(value: string): Object | undefined {
16.     return this._objects.get(value)
17.   }
19.   setObject(key: string, objectClass: Object): void {
20.     this._objects.set(key, objectClass)
21.   }
22. }

复制代码

四，创建PreferencesUtils工具类

1. import dataPreferences from '@ohos.data.preferences'
2. import GlobalContext from './GlobalContext'
4. const TAG = "PreferencesUtils"
5. // 默认文件名，可以在构造函数进行修改
6. const PREFERENCES_NAME = 'dbPreferences'
7. const PREFERENCES_KEY = "preferences"
8. type ValueType = number | string | boolean | Array<number> | Array<string> | Array<boolean>;
12. class PreferencesUtils{
15.   //  preferences的文件名-数据库表名
16.   private preferencesName: string = PREFERENCES_NAME
17.   // 用于获取preferences实例的key值，保存到单例中
18.   private keyPreferences: string = PREFERENCES_KEY
22.   constructor(name: string = PREFERENCES_NAME, key: string = PREFERENCES_KEY) {
23.     this.preferencesName = name
24.     this.keyPreferences = key
25.   }
28.   /**
29.    * 创建首选项实例
30.    * @param context 应用上下文
31.    * @returns 数据库表名
32.    */
33.   initPreferences(context): Promise<dataPreferences.Preferences> {
34.     let preferences = dataPreferences.getPreferences(context, this.preferencesName)
35.     GlobalContext.getContext().setObject(this.keyPreferences, preferences)
36.     return
37.   }
39.   /**
40.    * 获取首选项实例
41.    * @returns
42.    */
43.   getPreferences(): Promise<dataPreferences.Preferences> {
44.     return GlobalContext.getContext().getObject(this.keyPreferences) as Promise<dataPreferences.Preferences>
45.   }
47.   /**
48.    * 获取数据
49.    * @param key 读取key值
50.    * @param def 函数出参
51.    * @returns
52.    */
53.   async getString(key: string, defaultValue?: ValueType): Promise<ValueType> {
54.     //在typescript中，空字符串、数字0、null、undefined都被认为是false，其他值为true
55.     if (!key) {
56.       return defaultValue
57.     }
58.     return (await this.getPreferences()).get(key, defaultValue)
59.   }
61.   /**
62.    * 获取全部数据
63.    * @returns
64.    */
65.   async getAll(): Promise<Object> {
66.     let preferences = await this.getPreferences()
67.     if (!preferences) {
68.       console.debug(TAG+'--->>>[getAll] Preferences实例为空')
69.       return
70.     }
71.     return preferences.getAll()
72.   }
74.   /**
75.    * 插入数据
76.    * @param key 插入key值
77.    * @param value 存储数据
78.    * @returns
79.    */
80.   async putString(key: string, defaultValue: ValueType): Promise<void> {
82.     let promise = await this.getPreferences().then(async preferences => {
83.       // 插入数据
84.       await preferences.put(key, defaultValue)
85.       //写入文件
86.       await preferences.flush()
87.     }).catch(error => {
88.       console.error(TAG, `code:${error.code}, message:${error.message}`)
89.     })
90.     return promise
91.   }
93.   /**
94.    * 更新指定key的值
95.    * @param key  需要更新的key
96.    * @param newValue 新的值
97.    * @returns
98.    */
99.   async update(key:string, newValue: ValueType):Promise<void>{
100.     if (!key) {
101.       throw new Error('Key cannot be empty!');
102.     }
103.     const preferences = await this.getPreferences()
104.     if (await preferences.has(key)) {//检查key是否存在
105.       await preferences.put(key, newValue); // 更新值
106.       await preferences.flush(); // 刷新以保存更改
107.     }else {
108.       throw new Error(`Key ${key} does not exist`); // 如果key不存在，抛出错误
109.     }
111. }
116.   /**
117.    * 删除数据
118.    * @param key 删除key的value值
119.    * @returns
120.    */
121.   async delete(key:string):Promise<void>{
122.     return (await this.getPreferences()).delete(key).finally(async ()=>{
123.       (await this.getPreferences()).flush()
124.     })
125.   }
127.   /**
128.    * 清空数据
129.    * @returns
130.    */
131.   async clear():Promise<void>{
132.     return (await this.getPreferences()).clear().finally(async ()=>{
133.       (await this.getPreferences()).flush()
134.     })
135.   }
136. }
138. export default new PreferencesUtils()

复制代码

五，在EntryAbility中onCreate()方法初始化：

1. onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
2.     hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onCreate');
3.     //TODO 方法初始化
4.     PreferencesUtils.initPreferences(this.context)
6.   }

复制代码

六，在pages中使用

1. import PreferencesUtils from '../dbSQL/PreferencesUtils';
3. @Entry
4. @Component
5. struct Index {
6.   @State message: string = '';
8.    aboutToAppear(){
9.      PreferencesUtils.putString('userName','张三')
10.      PreferencesUtils.putString('age','18')
11.      PreferencesUtils.putString('sex','男')
12.    }
14.   async getAll(){
15.     this.message=JSON.stringify(await PreferencesUtils.getAll())
16.     console.log('getAll', this.message)
17.   }
20.   build() {
21.     Column({space:50}) {
22.       Text(this.message)
23.         .fontSize(20)
24.         .margin({top:30})
25.         .fontWeight(FontWeight.Bold)
27.         Column({space:20}){
28.           Button('getAll').onClick(async ()=>{
29.             this.getAll()
30.           })
32.           Button('put').onClick(async ()=>{//插入数据key相同时，会自动修改替换value值
33.             PreferencesUtils.putString('userName','李四')
34.             PreferencesUtils.putString('age','24')
35.             PreferencesUtils.putString('sex','女')
36.             this.getAll()
37.           })
40.           Button('update').onClick(async ()=>{
41.             await PreferencesUtils.update('userName','王二麻子')
42.             await PreferencesUtils.update('age','35')
43.             await PreferencesUtils.update('sex','男')
44.             this.getAll()
45.           })
48.           Button('delete').onClick(async ()=>{
49.             await PreferencesUtils.delete('sex')
50.             this.getAll()
51.           })
53.           Button('clear').onClick(async ()=>{
54.             await PreferencesUtils.clear()
55.             this.getAll()
56.           })
57.         }.margin({top:30})
58.         .justifyContent(FlexAlign.Center)
59.     }
60.     .width('100%')
61.   }
62. }

复制代码

   

     getAll查询      

     put      

     update   
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。