harmonyOS鸿蒙-数据管理-用户首选项(@ohos.data.preferences)

目录

一、定义

二、导入模块

三、常用方法

四、Preferences对象常用方法

五、代码示例

---

一、定义

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

数据存储形式为键值对，键的类型为字符串，值得存储数据类型包括数字型、字符型、布尔型以及3种类型的数组类型。

二、导入模块

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

三、常用方法

1、获取Preferences实例

getPreferences(context: Context, name: string): Promise<Preferences>

四、Preferences对象常用方法

1、获取键对应的值，如果值为null或者非默认值类型，返回默认数据defValue

get(key: string, defValue: ValueType): Promise<ValueType>

2、将数据写入Preferences实例，可通过flush将Preferences实例持久化，使用Promise异步回调

put(key: string, value: ValueType): Promise<void>

3、将当前Preferences实例的数据异步存储到用户首选项的持久化文件中

flush(): Promise<void>

五、代码示例

import data_preferences from '@ohos.data.preferences';
import common from '@ohos.app.ability.common';
import hilog from '@ohos.hilog';
 
@Component
@Entry
export struct SplashPage {
  context:common.UIAbilityContext = getContext(this) as common.UIAbilityContext
 
  putValue(){
    data_preferences.getPreferences(this.context, 'userInfo').then(preferences => {
      preferences.put('agree',1).then(() => {
        preferences.flush()
      })
    })
  }
 
  getValue(){
    data_preferences.getPreferences(getContext(this), 'userInfo').then(preferences => {
      preferences.get('agree', 0).then(value => {
        hilog.info(0xF0000, 'dbTest', '%{public}s', value)
      })
    })
  }
 
  build(){
    Column() {
      Button('add').onClick(() => {
        this.putValue()
      })
      Button('get').onClick(() => {
        this.getValue()
      })
    }
  }
}