harmony-utils之PreferencesUtil，首選項工具類

harmony-utils 簡介與說明

[harmony-utils] 一款功能豐富且極易上手的HarmonyOS工具庫，借助眾多實用工具類，致力于助力開發者迅速構建鴻蒙應用。其封裝的工具涵蓋了APP、設備、屏幕、授權、通知、線程間通信、彈框、吐司、生物認證、用戶首選項、拍照、相冊、掃碼、文件、日志，異常捕獲、字符、字符串、數字、集合、日期、隨機、base64、加密、解密、JSON等一系列的功能和操作，能夠滿足各種不同的開發需求。
[picker_utils] 是harmony-utils拆分出來的一個子庫，包含PickerUtil、PhotoHelper、ScanUtil。

下載安裝
ohpm i @pura/harmony-utils
ohpm i @pura/picker_utils

//全局初始化方法，在UIAbility的onCreate方法中初始化 AppUtil.init()
 onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
   AppUtil.init(this.context);
 }

API方法與使用

init 初始化

PreferencesUtil.init("my_app_preferences");

put 將數據緩存

PreferencesUtil.put("id", 10000018);
PreferencesUtil.putSync("name", "張三叁");
PreferencesUtil.putSync("bl_nuv", false);

get 獲取緩存值

let id = await PreferencesUtil.get("id", "");

getString 獲取string類型的緩存值

let name1 = await PreferencesUtil.getString("name");
let name2 = PreferencesUtil.getStringSync('name');

getNumber 獲取number類型的緩存值

let id1 = await PreferencesUtil.getNumber("id");
let id2 = PreferencesUtil.getNumberSync('id');

getBoolean 獲取boolean類型的緩存值

let bl1 = await PreferencesUtil.getBoolean("bl_nut");
let bl2 = PreferencesUtil.getBooleanSync('bl_nuv');

has 檢查緩存實例中是否包含給定Key的存儲鍵值對

let bl1 = await PreferencesUtil.has("id");
let bl2 = PreferencesUtil.hasSync('name');

delete 刪除緩存值

PreferencesUtil.delete("id");
PreferencesUtil.deleteSync("name");

clear 清空緩存

PreferencesUtil.clear();
PreferencesUtil.clearSync();

deletePreferences 從緩存中移出指定的Preferences實例，若Preferences實例有對應的持久化文件，則同時刪除其持久化文件。

PreferencesUtil.deletePreferences(getContext(), "SP_PREFERENCES_MSG");

onChange 訂閱數據變更，訂閱的Key的值發生變更后，在執行flush方法后，觸發callback回調

private callback: Callback< string > = (value) = > {
    LogUtil.error("onChange: " + value);
  }
  
 PreferencesUtil.onChange(callback);

offChange 取消訂閱數據變更

PreferencesUtil.offChange(callback);

onDataChange 精確訂閱數據變更，只有被訂閱的key值發生變更后，在執行flush方法后，觸發callback回調

private dataCallback = (data: Record< string, preferences.ValueType >) = > {
    for (const keyValue of Object.entries(data)) {
      LogUtil.error("onDataChange: " + keyValue);
    }
  }
  
  PreferencesUtil.onDataChange(["id", "name"], dataCallback);

offDataChange 取消精確訂閱數據變更

PreferencesUtil.offDataChange(["id", "name"], dataCallback);

創作不易，請給童長老點贊

審核編輯 黃宇