鸿蒙NEXT开发Preferences工具类（ArkTs）

news2025/4/18 20:17:14 
import { AppUtil } from './AppUtil';
import dataPreferences from '@ohos.data.preferences';
export const DEFAULT_PREFERENCE_NAME: string = "SP_HARMONY_UTILS_PREFERENCES"; // Preferences实例的名称。

/**
 * Preferences工具类
 * @author CSDN-鸿蒙布道师
 * @since 2025/04/09
 */
export class PreferencesUtil {

  private static defaultPreferenceName: string = DEFAULT_PREFERENCE_NAME;
  private static preferences: dataPreferences.Preferences;

  /**
   * 初始化Preferences实例（非必要不要初始化该方法）。
   * @param preferenceName Preferences实例的名称。
   */
  static init(preferenceName: string) {
    if (!PreferencesUtil.preferences || preferenceName !== PreferencesUtil.defaultPreferenceName) {
      PreferencesUtil.defaultPreferenceName = preferenceName;
      PreferencesUtil.preferences = dataPreferences.getPreferencesSync(AppUtil.getContext(), { name: preferenceName });
    }
  }

  /**
   * 获取Preferences实例。
   * @param preferenceName 实例名称。
   * @returns Preferences实例。
   */
  private static async getPreferences(preferenceName: string = PreferencesUtil.defaultPreferenceName): Promise<dataPreferences.Preferences> {
    if (preferenceName !== PreferencesUtil.defaultPreferenceName || !PreferencesUtil.preferences) {
      PreferencesUtil.preferences = await dataPreferences.getPreferences(AppUtil.getContext(), preferenceName);
    }
    return PreferencesUtil.preferences;
  }

  /**
   * 同步获取Preferences实例。
   * @param preferenceName 实例名称。
   * @returns Preferences实例。
   */
  private static getPreferencesSync(preferenceName: string = PreferencesUtil.defaultPreferenceName): dataPreferences.Preferences {
    if (preferenceName !== PreferencesUtil.defaultPreferenceName || !PreferencesUtil.preferences) {
      PreferencesUtil.preferences = dataPreferences.getPreferencesSync(AppUtil.getContext(), { name: preferenceName });
    }
    return PreferencesUtil.preferences;
  }

  /**
   * 将数据缓存到指定的Preferences实例中。
   * @param key 键。
   * @param value 值。
   * @param preferenceName 实例名称。
   */
  static putSync(key: string, value: dataPreferences.ValueType, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      preferences.putSync(key, value);
      preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  static async put(key: string, value: dataPreferences.ValueType, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    await PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => {
      await preferences.put(key, value);
      await preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  /**
   * 获取缓存值（同步）。
   * @param key 键。
   * @param defValue 默认值。
   * @param preferenceName 实例名称。
   * @returns 缓存值。
   */
  static getSync<T extends dataPreferences.ValueType>(key: string, defValue: T, preferenceName: string = PreferencesUtil.defaultPreferenceName): T {
    return PreferencesUtil.performSyncAction(preferenceName, (preferences) => preferences.getSync(key, defValue)) as T;
  }

  /**
   * 获取缓存值（异步）。
   * @param key 键。
   * @param defValue 默认值。
   * @param preferenceName 实例名称。
   * @returns 缓存值。
   */
  static async get<T extends dataPreferences.ValueType>(key: string, defValue: T, preferenceName: string = PreferencesUtil.defaultPreferenceName): Promise<T> {
    return PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => await preferences.get(key, defValue)) as Promise<T>;
  }

  /**
   * 删除指定键的缓存值。
   * @param key 键。
   * @param preferenceName 实例名称。
   */
  static deleteSync(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      preferences.deleteSync(key);
      preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  static async delete(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    await PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => {
      await preferences.delete(key);
      await preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  /**
   * 清空所有缓存数据。
   * @param preferenceName 实例名称。
   */
  static clearSync(preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      preferences.clearSync();
      preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  static async clear(preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    await PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => {
      await preferences.clear();
      await preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  /**
   * 检查是否包含指定键。
   * @param key 键。
   * @param preferenceName 实例名称。
   * @returns 是否包含。
   */
  static hasSync(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName): boolean {
    return PreferencesUtil.performSyncAction(preferenceName, (preferences) => preferences.hasSync(key));
  }

  static async has(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName): Promise<boolean> {
    return PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => await preferences.has(key));
  }

  /**
   * 订阅数据变更。
   * @param callback 回调函数。
   * @param preferenceName 实例名称。
   */
  static onChange(callback: Callback<string>, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => preferences.on('change', callback));
  }

  static offChange(callback?: Callback<string>, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      if (callback) {
        preferences.off('change', callback);
      } else {
        preferences.off('change');
      }
    });
  }

  /**
   * 辅助方法：执行同步操作。
   * @param preferenceName 实例名称。
   * @param action 执行的操作。
   * @returns 操作的结果。
   */
  private static performSyncAction<T>(preferenceName: string, action: (preferences: dataPreferences.Preferences) => T): T {
    const preferences = PreferencesUtil.getPreferencesSync(preferenceName);
    return action(preferences); // 确保返回操作的结果
  }

  /**
   * 辅助方法：执行异步操作。
   * @param preferenceName 实例名称。
   * @param action 执行的操作。
   */
  private static async performAsyncAction<T>(preferenceName: string, action: (preferences: dataPreferences.Preferences) => Promise<T>): Promise<T> {
    const preferences = await PreferencesUtil.getPreferences(preferenceName);
    return action(preferences);
  }
}

代码如下：

import { AppUtil } from './AppUtil';
import dataPreferences from '@ohos.data.preferences';
export const DEFAULT_PREFERENCE_NAME: string = "SP_HARMONY_UTILS_PREFERENCES"; // Preferences实例的名称。

/**
 * Preferences工具类
 * @author CSDN-鸿蒙布道师
 * @since 2025/04/09
 */
export class PreferencesUtil {

  private static defaultPreferenceName: string = DEFAULT_PREFERENCE_NAME;
  private static preferences: dataPreferences.Preferences;

  /**
   * 初始化Preferences实例（非必要不要初始化该方法）。
   * @param preferenceName Preferences实例的名称。
   */
  static init(preferenceName: string) {
    if (!PreferencesUtil.preferences || preferenceName !== PreferencesUtil.defaultPreferenceName) {
      PreferencesUtil.defaultPreferenceName = preferenceName;
      PreferencesUtil.preferences = dataPreferences.getPreferencesSync(AppUtil.getContext(), { name: preferenceName });
    }
  }

  /**
   * 获取Preferences实例。
   * @param preferenceName 实例名称。
   * @returns Preferences实例。
   */
  private static async getPreferences(preferenceName: string = PreferencesUtil.defaultPreferenceName): Promise<dataPreferences.Preferences> {
    if (preferenceName !== PreferencesUtil.defaultPreferenceName || !PreferencesUtil.preferences) {
      PreferencesUtil.preferences = await dataPreferences.getPreferences(AppUtil.getContext(), preferenceName);
    }
    return PreferencesUtil.preferences;
  }

  /**
   * 同步获取Preferences实例。
   * @param preferenceName 实例名称。
   * @returns Preferences实例。
   */
  private static getPreferencesSync(preferenceName: string = PreferencesUtil.defaultPreferenceName): dataPreferences.Preferences {
    if (preferenceName !== PreferencesUtil.defaultPreferenceName || !PreferencesUtil.preferences) {
      PreferencesUtil.preferences = dataPreferences.getPreferencesSync(AppUtil.getContext(), { name: preferenceName });
    }
    return PreferencesUtil.preferences;
  }

  /**
   * 将数据缓存到指定的Preferences实例中。
   * @param key 键。
   * @param value 值。
   * @param preferenceName 实例名称。
   */
  static putSync(key: string, value: dataPreferences.ValueType, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      preferences.putSync(key, value);
      preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  static async put(key: string, value: dataPreferences.ValueType, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    await PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => {
      await preferences.put(key, value);
      await preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  /**
   * 获取缓存值（同步）。
   * @param key 键。
   * @param defValue 默认值。
   * @param preferenceName 实例名称。
   * @returns 缓存值。
   */
  static getSync<T extends dataPreferences.ValueType>(key: string, defValue: T, preferenceName: string = PreferencesUtil.defaultPreferenceName): T {
    return PreferencesUtil.performSyncAction(preferenceName, (preferences) => preferences.getSync(key, defValue)) as T;
  }

  /**
   * 获取缓存值（异步）。
   * @param key 键。
   * @param defValue 默认值。
   * @param preferenceName 实例名称。
   * @returns 缓存值。
   */
  static async get<T extends dataPreferences.ValueType>(key: string, defValue: T, preferenceName: string = PreferencesUtil.defaultPreferenceName): Promise<T> {
    return PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => await preferences.get(key, defValue)) as Promise<T>;
  }

  /**
   * 删除指定键的缓存值。
   * @param key 键。
   * @param preferenceName 实例名称。
   */
  static deleteSync(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      preferences.deleteSync(key);
      preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  static async delete(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    await PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => {
      await preferences.delete(key);
      await preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  /**
   * 清空所有缓存数据。
   * @param preferenceName 实例名称。
   */
  static clearSync(preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      preferences.clearSync();
      preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  static async clear(preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    await PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => {
      await preferences.clear();
      await preferences.flush(); // 确保数据永久序列化到本地
    });
  }

  /**
   * 检查是否包含指定键。
   * @param key 键。
   * @param preferenceName 实例名称。
   * @returns 是否包含。
   */
  static hasSync(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName): boolean {
    return PreferencesUtil.performSyncAction(preferenceName, (preferences) => preferences.hasSync(key));
  }

  static async has(key: string, preferenceName: string = PreferencesUtil.defaultPreferenceName): Promise<boolean> {
    return PreferencesUtil.performAsyncAction(preferenceName, async (preferences) => await preferences.has(key));
  }

  /**
   * 订阅数据变更。
   * @param callback 回调函数。
   * @param preferenceName 实例名称。
   */
  static onChange(callback: Callback<string>, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => preferences.on('change', callback));
  }

  static offChange(callback?: Callback<string>, preferenceName: string = PreferencesUtil.defaultPreferenceName) {
    PreferencesUtil.performSyncAction(preferenceName, (preferences) => {
      if (callback) {
        preferences.off('change', callback);
      } else {
        preferences.off('change');
      }
    });
  }

  /**
   * 辅助方法：执行同步操作。
   * @param preferenceName 实例名称。
   * @param action 执行的操作。
   * @returns 操作的结果。
   */
  private static performSyncAction<T>(preferenceName: string, action: (preferences: dataPreferences.Preferences) => T): T {
    const preferences = PreferencesUtil.getPreferencesSync(preferenceName);
    return action(preferences); // 确保返回操作的结果
  }

  /**
   * 辅助方法：执行异步操作。
   * @param preferenceName 实例名称。
   * @param action 执行的操作。
   */
  private static async performAsyncAction<T>(preferenceName: string, action: (preferences: dataPreferences.Preferences) => Promise<T>): Promise<T> {
    const preferences = await PreferencesUtil.getPreferences(preferenceName);
    return action(preferences);
  }
}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/2332372.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

电商素材革命：影刀RPA魔法指令3.0驱动批量去水印，实现秒级素材净化

电商素材革命：影刀RPA魔法指令3.0驱动批量去水印，实现秒级素材净化

本文 去除水印实操视频展示电商图片水印处理的困境​影刀 RPA 魔法指令 3.0 强势登场​利用魔法指令3.0两步实现去除水印操作关于影刀RPA 去除水印实操视频展示 我们这里选择了4张小红书里面比较帅气的图片&#xff0c;但凡用过小红书的都知道&#xff0c;小红书右下角是会有小…
阅读更多...
CVA6：支持 Linux 的 RISC-V CPU CORE-V

CVA6：支持 Linux 的 RISC-V CPU CORE-V

RISC-V 是一种开源的可扩展指令集架构 (ISA)&#xff0c;在过去几年中广受欢迎。RISC-V 的主要特性之一是它采用整体架构中性设计&#xff0c;支持浮点运算、加载存储架构、符号扩展加速和多路复用器简化。这使得 RISC-V 成为 FPGA 上软处理器的经济实惠的选择。自 RISC-V ISA …
阅读更多...
轻奢宅家|约克VRF带你畅享舒适居家体验

轻奢宅家|约克VRF带你畅享舒适居家体验

下班回到家最期待什么&#xff1f;当然是一阵阵沁人心脾的舒适感扑面而来啦&#xff01; 　　 　　想要从头到脚都舒服自在&#xff1f;答案就在眼前——就是它&#xff01;约克VRF中央空调&#xff01; 　　 　　约克VRF中央空调独特的臻静降噪技术&#xff0c;让空调运行音轻…
阅读更多...
uniapp微信小程序图片生成水印

uniapp微信小程序图片生成水印

整体思路&#xff1a; 用户通过uni.chooseImage选择图片后&#xff0c;获得图片文件的path和size。通过path调用uni.getImageInfo获取图片信息&#xff0c;也就是图片宽高。图片宽高等比缩放至指定大小&#xff0c;不然手机处理起来非常久&#xff0c;因为手机随便拍拍就很大。…
阅读更多...
不用额外下载jar包，idea快速查看使用的组件源码

不用额外下载jar包，idea快速查看使用的组件源码

以nacos为例子&#xff0c;在idea中引入了nacos依赖&#xff0c;就可以查看源码了。 2. idea选择open&#xff08;不关闭项目直接选择file-open也可以&#xff09;, 在maven的仓库里找到对应的包&#xff0c;打开 2.idea中选择 jar包&#xff0c;选择 add as library 3.这样j…
阅读更多...
网络通讯协议UDP转发TCP工具_UdpToTcpRelay_双向版

网络通讯协议UDP转发TCP工具_UdpToTcpRelay_双向版

UDP/TCP网络转发器程序说明书 1. 程序概述 本程序是一个高性能网络数据转发工具&#xff0c;支持UDP和TCP协议之间的双向数据转发&#xff0c;并具备以下核心功能&#xff1a; 协议转换&#xff1a;实现UDP↔TCP协议转换数据转换&#xff1a;支持十六进制/ASCII格式的数据转…
阅读更多...
DIA——边缘检测

DIA——边缘检测

1.边缘 边缘是像素的突变位置。 2.常见边缘检测算法 通过找到一阶导数的极值点或者二阶导数的过零点来确定边缘像素的位置。边缘检测通常使用算子&#xff0c;即特定的卷积核。通过差分对离散的像素点求导&#xff0c;然后转化成卷积核进行卷积。使用卷积统一涵盖求导&…
阅读更多...
【万象论坛】论坛系统测试报告

【万象论坛】论坛系统测试报告

一、项目背景 1.1项目起因 在当今数字化浪潮下&#xff0c;互联网技术呈爆发式发展&#xff0c;新技术、新框架、新应用场景不断涌现。从大型企业的数字化转型到初创公司的技术创新&#xff0c;各个层面都离不开互联网技术的支撑。然而&#xff0c;技术人员在学习与工作过程中…
阅读更多...
【AI工具】FastGPT：开启高效智能问答新征程

【AI工具】FastGPT：开启高效智能问答新征程

前言 在人工智能飞速发展的当下&#xff0c;各类 AI 工具如雨后春笋般涌现。FastGPT 作为一款基于大语言模型&#xff08;LLM&#xff09;的知识图谱问答系统&#xff0c;凭借其强大的数据处理和模型调校能力&#xff0c;为用户带来了便捷的使用体验。今天&#xff0c;就让我们…
阅读更多...
华为数字芯片机考2025合集1已校正

华为数字芯片机考2025合集1已校正

单选 1&#xff0e;以下低功耗措施中&#xff0c;哪种不是降低电路翻转率的方法? A.在不进行算术运算的时候&#xff0c;使这些模块的输入保持不变&#xff0c;不让新的操作数进来 B.采用Gray 码或One‐hot 码作为状态机编码 C.减少电路中的glitch D.重新安排“if‐else”表达…
阅读更多...
HackMyVM - todd记录

HackMyVM - todd记录

HackMyVM - toddhttps://mp.weixin.qq.com/s/E_-hepdfY-0veilL1fl2QA
阅读更多...
【完整可用】使用openhtmltopdf生成PDF（带SVG）

【完整可用】使用openhtmltopdf生成PDF（带SVG）

文章目录 前言OpenHTMLToPDF 简介maven配置依赖字体文件demo代码其他资源放置截图防止maven编译字体文件 前言 AI和网上都是跑不起来或者版本过低的&#xff0c;还有各种BUG的。本文都是查阅官方文档得出的。如果你能跑起来请给个大大的赞&#xff01; OpenHTMLToPDF 简介 Ope…
阅读更多...
CTF web入门之爆破

CTF web入门之爆破

爆破 web21: 打开burp进行抓包 通过对密码进行解析。得知密码是由拼接而来 admin:1 选择要攻击的参数 攻击方式。 选择payload方式 。。添加参数 1&#xff0c;2&#xff0c;3。账号 分隔符 密码 选择加密方式。添加buse64.去掉url字符。不然buse64后&#xff0c;会在u…
阅读更多...
7-openwrt-one通过web页面配置访客网络、无线中继等功能

7-openwrt-one通过web页面配置访客网络、无线中继等功能

前几个章节一直在介绍编译、分区之类的，都还没正常开始使用这个路由器的wifi。默认wifi是没有启动的，前面还是通过手动修改uci配置启动的，这个章节介绍下官方web页面的使用。特别是访客网络、无线中继 1、开启wifi，配置wifi基本信息 我们使用有线连接路由器，通过192.168.…
阅读更多...
Android使用声网SDK实现音视频互动(RTC)功能

Android使用声网SDK实现音视频互动(RTC)功能

一、前期准备 1、注册声网账号 声网官网 2、创建项目 拿到AppID&#xff0c;主要证书 二、代码部分 先上一下官方提供的demo地址&#xff1a; Agora-RTC-QuickStart: 此仓库包含 Agora RTC Native SDK 的QuickStart示例项目。 - Gitee.comhttps://gitee.com/agoraio-comm…
阅读更多...
FPGA_modelsim错误总结

FPGA_modelsim错误总结

1&#xff0c; 使用modelsim仿真DDR3报错Module ‘SIP_PHY_CONTROL‘ is not defined 在配置ddr3的时候vivado 速度太慢了&#xff0c;所以选用modelsim。我的是2018.3vivado&#xff0c;modelsim用了10.4 但是不行报错 然后看了帖子说 questasim可以下载了还是报错。 然后又…
阅读更多...
了解 DeFi：去中心化金融的入门指南与未来展望

了解 DeFi：去中心化金融的入门指南与未来展望

去中心化金融&#xff0c;或 DeFi&#xff0c;代表着全球金融体系运作方式的革命性转变。它是一个总称&#xff0c;指的是一个不断增长的去中心化应用程序&#xff08;dapp&#xff09;、协议和平台生态系统&#xff0c;这些生态系统构建在公共区块链网络上&#xff0c;无需传统…
阅读更多...
Python爬虫第10节-lxml解析库用 XPath 解析网页

Python爬虫第10节-lxml解析库用 XPath 解析网页

目录 引言 一、XPath简介 二、XPath常用规则 三、实例讲解 四、节点的选取 4.1 所有节点的选取 4.2 子节点的选取 4.3 父节点选取 五、属性匹配获取及文本获取 5.1 属性匹配 5.2 文本获取 5.3 属性获取 5.4 属性多值匹配 5.5 多属性匹配 六、按序选择 七、节点…
阅读更多...
【C语言】预处理（预编译）（C语言完结篇）

【C语言】预处理（预编译）（C语言完结篇）

一、预定义符号 前面我们学习了C语言的编译和链接。 在C语言中设置了一些预定义符号&#xff0c;其可以直接使用&#xff0c;预定义符号也是在预处理期间处理的。 如下&#xff1a; 可以看到上面的预定义符号&#xff0c;其都有两个短下划线&#xff0c;要注意的是&#xff…
阅读更多...
关于聊天室数据库建表

关于聊天室数据库建表

首先了解一下外键 ​​一、外键的本质​​ ​​定义​​&#xff1a;外键是某个表中的字段&#xff08;或字段组合&#xff09;&#xff0c;其值必须与另一张表的主键值相匹配。 ​​核心作用​​&#xff1a;强制数据一致性&#xff0c;维护表间关系。 二、外键的核心用途…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023