SPHelper.ets 4.77 KB
import data_preferences from '@ohos.data.preferences';
import { Logger } from './Logger';
import { JSON } from '@kit.ArkTS';

const TAG = 'SPHelper'

const logEnable = false

/**
 * sp存储,单条数据,value<1k;业务数据超过1k的,建议使用KVStoreHelper
 */
export class SPHelper {
  private static context: Context;
  private static spFilename: string = '__SPHelper';

  static init(context: Context) {
    SPHelper.context = context;
    if (context) {
      Logger.debug(TAG, '初始化context')
    }
  }

  static setSpFilename(spFilename: string) {
    SPHelper.spFilename = spFilename;
    Logger.debug(TAG, '设置文件名: ' + spFilename)
  }

  // 静态属性
  static default: SPHelper = new SPHelper();

  // 私有构造函数
  private constructor() {
  }

  private async getVideoPreferences(): Promise<data_preferences.Preferences> {
    let preferences: data_preferences.Preferences = await data_preferences.getPreferences(SPHelper.context, SPHelper.spFilename);
    return preferences;
  }

  private getVideoPreferencesSync(): data_preferences.Preferences {
    let options: data_preferences.Options = { name: SPHelper.spFilename };
    let preferences: data_preferences.Preferences = data_preferences.getPreferencesSync(SPHelper.context, options);
    return preferences;
  }

  async save(key: string, value: data_preferences.ValueType) {
    try {
      const preferences: data_preferences.Preferences = await this.getVideoPreferences();
      await preferences.put(key, value)
      await preferences.flush()
      if (logEnable) {
        Logger.debug(TAG, '保存 key: ' + key + " value => " + value)
      }
    } catch (e) {
      Logger.error(TAG, '保存 key: ' + key + " value => " + value + " 报错:" + JSON.stringify(e))
    }
  }

  saveSync(key: string, value: data_preferences.ValueType) {
    const preferences: data_preferences.Preferences = this.getVideoPreferencesSync();
    preferences.putSync(key, value)
    preferences.flush().then(() => {
      if (logEnable) {
        Logger.debug(TAG, 'sync保存 key: ' + key + " value => " + value)
      }
    }).catch((error: object) => {
      Logger.error(TAG, 'sync保存 key: ' + key + " value => " + value + " 报错:" + JSON.stringify(error))
    });
  }

  async get(key: string, defValue: data_preferences.ValueType): Promise<data_preferences.ValueType> {
    const preferences: data_preferences.Preferences = await this.getVideoPreferences();
    const data = await preferences.get(key, defValue);
    if (logEnable) {
      Logger.debug(TAG, '获取 key: ' + key + " value => " + data + "| 默认值:" + defValue)
    }
    return data
  }

  getSync(key: string, defValue: data_preferences.ValueType): data_preferences.ValueType {
    const preferences: data_preferences.Preferences = this.getVideoPreferencesSync();
    const data = preferences.getSync(key, defValue);
    if (logEnable) {
      Logger.debug(TAG, 'sync获取 key: ' + key + " value => " + data + "| 默认值:" + defValue)
    }
    return data
  }

  async has(key: string): Promise<boolean> {
    const preferences: data_preferences.Preferences = await this.getVideoPreferences();
    const data = await preferences.has(key);
    if (logEnable) {
      Logger.debug(TAG, 'has key: ' + key + ' => ' + data)
    }
    return data
  }

  hasSync(key: string): boolean {
    const preferences: data_preferences.Preferences = this.getVideoPreferencesSync();
    const data = preferences.hasSync(key);
    if (logEnable) {
      Logger.debug(TAG, 'synchas key: ' + key + ' => ' + data)
    }
    return data
  }

  async delete(key: string) {
    const preferences: data_preferences.Preferences = await this.getVideoPreferences();
    preferences.delete(key).then(async () => {
      await preferences.flush();
      if (logEnable) {
        Logger.debug(TAG, '删除 key: ' + key)
      }
    }).catch((err: Error) => {
      Logger.error(TAG, '删除 key失败:' + JSON.stringify(err));
    });
  }

  deleteSync(key: string) {
    const preferences: data_preferences.Preferences = this.getVideoPreferencesSync();
    preferences.deleteSync(key)
    preferences.flush().then(() => {
      if (logEnable) {
        Logger.debug(TAG, 'sync删除 key: ' + key)
      }
    }).catch((error: object) => {
      Logger.error(TAG, 'sync删除 key失败:' + JSON.stringify(error));
    });
  }

  async clearSync() {
    this.getVideoPreferences().then(async (preferences: data_preferences.Preferences) => {
      preferences.clearSync()
      await preferences.flush()
      Logger.debug(TAG, 'sync清除所有数据');
    }).catch((err: Error) => {
      Logger.error(TAG, 'sync清除所有数据,失败:' + JSON.stringify(err));
    });
  }

  public getPreferences() {
    let preferences = data_preferences.getPreferences(SPHelper.context, SPHelper.spFilename);
    return preferences;
  }
}