HarmonyOS学习(十四)——数据管理(三) 用户首选项

ImomoTo2024-10-09 16:03

文章目录

1、概述

用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。

官方文档地址：通过用户首选项实现数据持久化-应用数据持久化-ArkData（方舟数据管理）-应用框架 - 华为HarmonyOS开发者 (huawei.com)

2、运行机制
复制代码 
<font style="color:rgba(0, 0, 0, 0.9);">用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到主动从内存中移除该实例或者删除该文件。</font>
3、约束条件
  • 因为Preferences实例会加载到内存中，所以存储的数据应该是轻量级别的，建议存储的数据不超过一万条。
  • 数据key键为string类型，要求非空，并且长度不超过1024个字节。
  • value值为string类型，可以为空，长度不超过1610241024。
4、接口说明
接口名称 描述
getPreferencesSync(context: Context, options: Options): Preferences 获取Preferences实例。该接口存在异步接口。
putSync(key: string, value: ValueType): void 将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。
hasSync(key: string): boolean 检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。
getSync(key: string, defValue: ValueType): ValueType 获取键对应的值，如果值为null或者非默认值类型，返回默认数据defValue。该接口存在异步接口。
deleteSync(key: string): void 从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。
flush(callback: AsyncCallback): void 将当前Preferences实例的数据异步存储到用户首选项持久化文件中。
on(type: 'change', callback: Callback): void 订阅数据变更，订阅的数据发生变更后，在执行flush方法后，触发callback回调。
off(type: 'change', callback?: Callback): void 取消订阅数据变更。
deletePreferences(context: Context, options: Options, callback: AsyncCallback): void 从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。
5、开发步骤
5.1、导入模块
plain 复制代码 
import preferences from '@ohos.data.preferences'
5.2、获取preference实例
plain 复制代码 
private  PREFERENCES_NAME: string = 'preferneces_name';
private dataPreference;
private context = getContext(this);

async aboutToAppear(){
 await preferences.getPreferences(this.context,this.PREFERENCES_NAME)
    .then((data) => {
      this.dataPreference = data;
      console.info(this.LOGTAG,"success in getting prefernec")
  }).catch((err) => {
     console.info(this.LOGTAG,'failed to get preferences ,cause:'+ err);
   });
5.3、写入数据
plain 复制代码 
Button("写入")
  .width('50%')
  .type(ButtonType.Capsule)
  .onClick(() => {
    this.dataPreference.put('pre_key', 'put avalue').then(() => {
      this.message = '写入成功'
      console.info(this.LOGTAG, 'put seccess')
    }).catch((err) => {
      console.info(this.LOGTAG, 'put failed,reason ;' + err);
    });
  });
5.4、读取数据
plain 复制代码 
Button("读取")
  .width('50%')
  .margin({top:50})
  .type(ButtonType.Capsule)
  .onClick(() => {
    this.dataPreference.get('pre_key','').then((data) =>{
      this.message = data.toString();
      console.info(this.LOGTAG,'get success,data'+data)
    }).catch((err) => {
      console.info(this.LOGTAG,'get failed ,reason:'+ err)
    })
  })
5.5、删除数据
plain 复制代码 
Button("删除")
  .width('50%')
  .margin({ top: 10 })
  .type(ButtonType.Capsule)
  .onClick(() => {
    this.dataPreference.delete('pre_key').then(() => {
      console.info(this.LOGTAG, 'delete success' )
    }).catch((err) => {
      console.info(this.LOGTAG, 'delete failed ,reason:' + err)
    })
  })
5.6、数据持久化
plain 复制代码 
Button("数据持久化")
  .width('50%')
  .margin({ top: 10 })
  .type(ButtonType.Capsule)
  .onClick(() => {
    // @ts-ignore
    this.dataPreference.flush((err: BusinessError) => {
      if (err) {
        console.info(this.LOGTAG, 'flush error code:' + err.code + 'message:' + err.message)
        return;
      }
      console.info(this.LOGTAG, 'flush success')
    })
  })
5.7、删除指定文件
plain 复制代码 
Button("删除指定文件")
  .width('50%')
  .margin({ top: 10 })
  .type(ButtonType.Capsule)
  .onClick(() => {
    preferences.deletePreferences(this.context,this.PREFERENCES_NAME,(err) =>{
      if (err) {
        console.info(this.LOGTAG, 'deletePreferences error code:' + err.code + 'message:' + err.message)
        return;
      }
      console.info(this.LOGTAG, 'deletePreferences success')
    })
  })
6、文件代码
plain 复制代码 
import preferences from '@ohos.data.preferences'


@Entry
@Component
struct Index {
  @State message: string = 'Hello World'
  private LOGTAG = 'log_cat';
  private PREFERENCES_NAME: string = 'preferneces_name';
  private dataPreference: preferences.Preferences;
  private context = getContext(this);

  async aboutToAppear() {
    await preferences.getPreferences(this.context, this.PREFERENCES_NAME)
      .then((data) => {
        this.dataPreference = data;
        console.info(this.LOGTAG, "success in getting prefernec")
      }).catch((err) => {
        console.info(this.LOGTAG, 'failed to get preferences ,cause:' + err);
      });
  }

  build() {
    Row() {
      Column() {
        Text(this.message)
          .fontSize(32)
          .width('100%')

        Button("写入")
          .width('50%')
          .type(ButtonType.Capsule)
          .onClick(() => {
            this.dataPreference.put('pre_key', 'put avalue').then(() => {
              this.message = '写入成功'
              console.info(this.LOGTAG, 'put seccess')
            }).catch((err) => {
              console.info(this.LOGTAG, 'put failed,reason ;' + err);
            });
          });

        Button("读取")
          .width('50%')
          .margin({ top: 10 })
          .type(ButtonType.Capsule)
          .onClick(() => {
            this.dataPreference.get('pre_key', '').then((data) => {
              this.message = data.toString();
              console.info(this.LOGTAG, 'get success,data' + data)
            }).catch((err) => {
              console.info(this.LOGTAG, 'get failed ,reason:' + err)
            })
          })

        Button("删除")
          .width('50%')
          .margin({ top: 10 })
          .type(ButtonType.Capsule)
          .onClick(() => {
            this.dataPreference.delete('pre_key').then(() => {
              console.info(this.LOGTAG, 'delete success')
            }).catch((err) => {
              console.info(this.LOGTAG, 'delete failed ,reason:' + err)
            })
          })

        Button("数据持久化")
          .width('50%')
          .margin({ top: 10 })
          .type(ButtonType.Capsule)
          .onClick(() => {
            // @ts-ignore
            this.dataPreference.flush((err: BusinessError) => {
              if (err) {
                console.info(this.LOGTAG, 'flush error code:' + err.code + 'message:' + err.message)
                return;
              }
              console.info(this.LOGTAG, 'flush success')
            })
          })

        Button("删除指定文件")
          .width('50%')
          .margin({ top: 10 })
          .type(ButtonType.Capsule)
          .onClick(() => {
            preferences.deletePreferences(this.context, this.PREFERENCES_NAME, (err) => {
              if (err) {
                console.info(this.LOGTAG, 'deletePreferences error code:' + err.code + 'message:' + err.message)
                return;
              }
              console.info(this.LOGTAG, 'deletePreferences success')
            })
          })
      }
      .width('100%')
      .height('100%')
    }
    .height('100%')
  }
}
相关推荐
喏喏心13 分钟前
深度强化学习：价值迭代与Bellman方程实践
人工智能·python·学习·机器学习
kkkkkkkkk_120130 分钟前
【强化学习】06周博磊强化学习纲要学习笔记——第三课下
笔记·学习·强化学习
白杨SEO营销44 分钟前
白杨SEO：看“20步：从0-1做项目的笨办法”来学习如何选一个项目做及经验分享
前端·学习
无所事事的程序员1 小时前
Claude指令学习
学习
吐个泡泡v1 小时前
深度学习中的“压缩与解压“艺术：自编码器与VAE详解
深度学习·vae·生成模型·自编码器
学习路上_write1 小时前
AD5293驱动学习
c语言·单片机·嵌入式硬件·学习
l木本I1 小时前
uv 技术详解
人工智能·python·深度学习·机器学习·uv
TracyCoder1231 小时前
机器学习与深度学习基础（五）：深度神经网络经典架构简介
深度学习·机器学习·dnn
遇到困难睡大觉哈哈1 小时前
HarmonyOS —— Remote Communication Kit 定制处理行为（ProcessingConfiguration）速记笔记
笔记·华为·harmonyos
热门推荐
01GitHub 镜像站点02【AutoGLM部署】本地私有化部署AI手机Agent03UV安装并设置国内源04【超详细教程】手把手教你从微软官网免费下载Windows 10官方原版ISO镜像（2025最新版）05Open-AutoGLM Windows 安装部署教程06Cursor 又偷偷更新，这个功能太实用：Visual Editor for Cursor Browser07安娜的档案(Anna’s Archive) 镜像网站/国内最新可访问入口（持续更新）08Linux下V2Ray安装配置指南09BongoCat - 跨平台键盘猫动画工具10在VSCode配置Java开发环境的保姆级教程（适配各类AI编程IDE）