鸿蒙OS 用户首选项Preferences封装

一、场景介绍

用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据，当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大，因此，Preferences不适合存放过多的数据，适用的场景一般为应用保存用户的个性化设置（字体大小，是否开启夜间模式）等。

二、运作机制

如图所示，用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到主动从内存中移除该实例或者删除该文件。

应用首选项的持久化文件保存在应用沙箱内部，可以通过context获取其路径。具体可见获取应用开发路径。

三、学习资料

1.官方文档
2.API

四、封装实现

import dataPreferences from '@ohos.data.preferences';
import preferences from '@ohos.data.preferences';
import { Log } from './Log';

/**
 * 用户首选项工具类
 */
export class PreferencesUtil {
  private mPreferences: dataPreferences.Preferences

  /**
   * 初始化
   * @param context
   */
  init(context: Context) {
    try {
      dataPreferences.getPreferences(context, 'Looper_Sp', (err, preferences) => {
        if (err) {
          Log.error(`Failed to get preferences. Code:${err.code},message:${err.message}`);
          return;
        }
        this.mPreferences = preferences
        Log.info('Succeeded in getting preferences.');
        // 进行相关数据操作
      })
    } catch (err) {
      Log.error(`Failed to get preferences. Code:${err.code},message:${err.message}`);
    }
  }

  /**
   * 写数据
   * @param isFlush 是否持久化
   */
  writeData(key: string, value: string, isFlush: boolean): Promise<boolean> {
    return new Promise((resolve, reject) => {
      try {
        this.mPreferences.put(key, value, (err) => {
          if (err) {
            Log.error(`Failed to put data. Code:${err.code}, message:${err.message}`);
            reject(false);
            return;
          }
          Log.info('Succeeded in putting data.');
          if (isFlush) {
            this.flushData()
          }
          resolve(true);
        })
      } catch (err) {
        Log.error(`Failed to check the key 'startup'. Code:${err.code}, message:${err.message}`);
        reject(false);
      }
    });
  }

  /**
   * 读取数据
   */
  readData(key: string): Promise<any> {
    return new Promise((resolve, reject) => {
      if (this.mPreferences == null) {
        reject(new Error("mPreferences is null"));
      } else {
        this.mPreferences.get(key, "", (err, value) => {
          if (err) {
            reject(err);
            return;
          }
          resolve(value);
        })
      }
    });
  }

  /**
   * 删除数据
   * @param isFlush 是否持久化
   */
  delData(key: string, isFlush: boolean): Promise<any> {
    return new Promise((resolve, reject) => {
      if (this.mPreferences == null) {
        reject(new Error("mPreferences is null"));
      } else {
        this.mPreferences.delete(key, (err, value) => {
          if (err) {
            reject(err);
            return;
          }
          if (isFlush) {
            this.flushData()
          }
          resolve(value);
        })
      }
    });
  }

  /**
   * 删除整个库
   * @param isFlush 是否持久化
   */
  delDB(context: Context, storeName: string): Promise<any> {
    return new Promise((resolve, reject) => {
      dataPreferences.deletePreferences(context, storeName, (err, value) => {
        if (err) {
          reject(err);
          return;
        }
        resolve(value);
      })
    });
  }

  /**
   * 持久化
   */
  flushData() {
    if (this.mPreferences != null) {
      try {
        this.mPreferences.flush((err) => {
          if (err) {
            Log.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
            return;
          }
          Log.info('Succeeded in flushing.');
        })
      } catch (err) {
        Log.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
      }
    }
  }
}

let preferencesUtil = new PreferencesUtil()

export default preferencesUtil as PreferencesUtil

五、代码使用

1.在 EntryAbility 中初始化。

onWindowStageCreate(windowStage: window.WindowStage) {
   
    PreferencesUtil.prototype.init(this.context)
   
    windowStage.loadContent('pages/me/LoginPage', (err, data) => {
      if (err.code) {
        hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
        return;
      }
      hilog.info(0x0000, 'testTag', 'Succeeded in loading the content. Data: %{public}s', JSON.stringify(data) ?? '');
    });

 
  }

如果无法引入，那么把EntryAbility 文件改成.ets即可。

2.写入数据
要注意数据的持久化，如果不开持久化，那么下次初始化的时候数据会清空，持久化影响操作：增、删。

PreferencesUtil.writeData("aaa", "ccc",true).then((value => {
      Log.info("添加成功:" + value)
    })).catch((err) => {
      Log.error("添加失败:" + err)
    })

3.读数据

 PreferencesUtil.readData("aaa").then((value => {
      Log.info("获取信息:" + value)
    })).catch((err) => {
      Log.error("报错了:" + err)
    })

4.删除数据

PreferencesUtil.delData("aaa",true).then((value => {
      Log.info("删除成功" )
    })).catch((err) => {
      Log.error("删除失败")
    })

六、最后

编写不易，欢迎看官一键三连~