HarmonyOS：通过preferences (用户首选项)实现数据持久化

ChinaDragon2025-03-25 10:15

一、场景介绍

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

二、运作机制

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

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

用户首选项运作机制如下图

三、约束限制

  • 首选项无法保证进程并发安全，会有文件损坏和数据丢失的风险，不支持在多进程场景下使用。
  • Key键为string类型，要求非空且长度不超过1024个字节。
  • 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过16MB。
  • 当存储的数据中包含非UTF-8格式的字符串时，请使用Uint8Array类型存储，否则会造成持久化文件出现格式错误造成文件损坏。
  • 当调用removePreferencesFromCache或者deletePreferences后，订阅的数据变更会主动取消订阅，重新getPreferences后需要重新订阅数据变更。
  • 不允许deletePreferences与其他接口多线程、多进程并发调用，否则会发生不可预期行为。
  • 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。

四、接口说明

以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见用户首选项。

接口名称 描述
getPreferencesSync(context: Context, options: Options): Preferences 获取Preferences实例。该接口存在异步接口。
putSync(key: string, value: ValueType): void 将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。
hasSync(key: string): boolean 检查Preferences实例是否包含名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。
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实例有对应的持久化文件，则同时删除其持久化文件。

preferences.deletePreferences deletePreferences(context: Context, name: string, callback: AsyncCallback): void

从缓存中移出指定的Preferences实例，若Preferences实例有对应的持久化文件，则同时删除其持久化文件。使用callback异步回调。
调用该接口后，不建议再使用旧的Preferences实例进行数据操作，否则会出现数据一致性问题，应将Preferences实例置为null，系统将会统一回收。

不支持该接口与preference其他接口并发调用。

元服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.DistributedDataManager.Preferences.Core

五、开发步骤

5.1 导入@kit.ArkData模块。

c 复制代码 
import { preferences } from '@kit.ArkData';

5.2 获取Preferences实例。

c 复制代码 
import { UIAbility } from '@kit.AbilityKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { window } from '@kit.ArkUI';

let dataPreferences: preferences.Preferences | null = null;

class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage) {
    let options: preferences.Options = { name: 'myStore' };
    dataPreferences = preferences.getPreferencesSync(this.context, options);
  }
}

5.3 写入数据。

使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。
说明 当对应的键已经存在时，putSync()方法会覆盖其值。可以使用hasSync()方法检查是否存在对应键值对。

示例代码如下所示：

c 复制代码 
import { util } from '@kit.ArkTS';
if (dataPreferences.hasSync('startup')) {
  console.info("The key 'startup' is contained.");
} else {
  console.info("The key 'startup' does not contain.");
  // 此处以此键值对不存在时写入数据为例
  dataPreferences.putSync('startup', 'auto');
  // 当字符串有特殊字符时，需要将字符串转为Uint8Array类型再存储
  let uInt8Array1 = new util.TextEncoder().encodeInto("~！@#￥%......&*（）------+？");
  dataPreferences.putSync('uInt8', uInt8Array1);
}

5.4 读取数据。

使用getSync()方法获取数据，即指定键对应的值。如果值为null或者非默认值类型，则返回默认数据。

示例代码如下所示：

c 复制代码 
let val = dataPreferences.getSync('startup', 'default');
console.info("The 'startup' value is " + val);
// 当获取的值为带有特殊字符的字符串时，需要将获取到的Uint8Array转换为字符串
let uInt8Array2 : preferences.ValueType = dataPreferences.getSync('uInt8', new Uint8Array(0));
let textDecoder = util.TextDecoder.create('utf-8');
val = textDecoder.decodeToString(uInt8Array2 as Uint8Array);
console.info("The 'uInt8' value is " + val);

5.5 删除数据。

使用deleteSync()方法删除指定键值对，示例代码如下所示：

c 复制代码 
dataPreferences.deleteSync('startup');

5.6 数据持久化。

应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示：

c 复制代码 
dataPreferences.flush((err: BusinessError) => {
  if (err) {
    console.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
    return;
  }
  console.info('Succeeded in flushing.');
})

5.7 订阅数据变更。

应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。示例代码如下所示：

c 复制代码 
let observer = (key: string) => {
  console.info('The key' + key + 'changed.');
}
dataPreferences.on('change', observer);
// 数据产生变更，由'auto'变为'manual'
dataPreferences.put('startup', 'manual', (err: BusinessError) => {
  if (err) {
    console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`);
    return;
  }
  console.info("Succeeded in putting the value of 'startup'.");
  if (dataPreferences !== null) {
    dataPreferences.flush((err: BusinessError) => {
      if (err) {
        console.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
        return;
      }
      console.info('Succeeded in flushing.');
    })
  }
})

5.8 删除指定文件。

使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。
说明

  • 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。
  • 成功删除后，数据及文件将不可恢复。

示例代码如下所示：

c 复制代码 
preferences.deletePreferences(this.context, options, (err: BusinessError) => {
  if (err) {
    console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`);
      return;
  }
  console.info('Succeeded in deleting preferences.');
})

六、示例完整代码

效果图

TestPreferences.ets

c 复制代码 
import { preferences } from '@kit.ArkData'
import { common } from '@kit.AbilityKit'
import { util } from '@kit.ArkTS'
import { BusinessError } from '@kit.BasicServicesKit';

/*
通过用户首选项实现数据持久化
https://developer.huawei.com/consumer/cn/training/course/slightMooc/C101717498132814493
 */

const PREFERENCES_NAME = "myStore"
let context = getContext(this) as common.UIAbilityContext;
let options: preferences.Options = { name: PREFERENCES_NAME };
let dataPreferences: preferences.Preferences = preferences.getPreferencesSync(context, options);

const KEY_STARTUP = "startup";
const KEY_UINT8 = "uInt8";

/**
 * 写入数据
 * 使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。
 */
function savaData() {

  if (dataPreferences.hasSync(KEY_STARTUP)) {
    console.info("The key 'startup' is contained.");
  } else {
    console.info("The key 'startup' does not contain.");
    // 此处以此键值对不存在时写入数据为例
    dataPreferences.putSync(KEY_STARTUP, 'auto');
    // 当字符串有特殊字符时，需要将字符串转为Uint8Array类型再存储
    let uInt8Array1 = new util.TextEncoder().encodeInto("~！@#￥%......&*（）------+？");
    dataPreferences.putSync(KEY_UINT8, uInt8Array1);
  }
  console.log("savaData 写入数据结束")
}

/**
 * 读取数据
 * 使用getSync()方法获取数据，即指定键对应的值。如果值为null或者非默认值类型，则返回默认数据。
 */
function readData() {
  let val = dataPreferences.get(KEY_STARTUP, 'default');
  val.then((value) => {
    console.info("The 'startup' value is " + value );
  })

  // 当获取的值为带有特殊字符的字符串时，需要将获取到的Uint8Array转换为字符串
  let uInt8Array2: preferences.ValueType = dataPreferences.getSync(KEY_UINT8, new Uint8Array(0));
  let textDecoder = util.TextDecoder.create('utf-8');
  let uInt8Value = textDecoder.decodeToString(uInt8Array2 as Uint8Array);
  console.info("The 'uInt8' value is " + uInt8Value);
  console.log("readData 读取数据结束")
}

/*
删除数据。

使用deleteSync()方法删除指定键值对
 */
function testDeleteSync() {
  dataPreferences.deleteSync(KEY_STARTUP);
  console.log("testDeleteSync 执行结束")
}

/**
 * 数据持久化。
 应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示：
 */
function flushData() {
  dataPreferences.flush((err: BusinessError) => {
    if (err) {
      console.error(`数据持久化 Failed to flush. Code:${err.code}, message:${err.message}`);
      return;
    }
    console.info('数据持久化 Succeeded in flushing.');
  })
}

/**
 * 订阅数据变更。
 应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。
 */
function observerData() {
  let observer = (key: string) => {
    console.info('订阅数据变更 The key' + key + 'changed.');
  }
  dataPreferences.on('change', observer);
  // 数据产生变更，由'auto'变为'manual'
  dataPreferences.put(KEY_STARTUP, 'manual', (err: BusinessError) => {
    if (err) {
      console.error(`订阅数据变更 Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`);
      return;
    }
    console.info("订阅数据变更 Succeeded in putting the value of 'startup'.");
    if (dataPreferences !== null) {
      dataPreferences.flush((err: BusinessError) => {
        if (err) {
          console.error(`订阅数据变更 Failed to flush. Code:${err.code}, message:${err.message}`);
          return;
        }
        console.info('订阅数据变更 Succeeded in flushing.');
      })
    }
  })
}

/**
 * 删除指定文件。

 使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。

 说明
 调用该接口后，应用不允许再使用该Preferences实例进行数据操作，否则会出现数据一致性问题。

 成功删除后，数据及文件将不可恢复。
 
调用该接口后，不建议再使用旧的Preferences实例进行数据操作，否则会出现数据一致性问题，应将Preferences实例置为null，系统将会统一回收。
 */

function testDeletePreferences() {
  preferences.deletePreferences(context, options, (err: BusinessError) => {
    if (err) {
      console.error(`删除指定文件 Failed to delete preferences. Code:${err.code}, message:${err.message}`);
      return;
    }
    dataPreferences = null
    console.info('删除指定文件 Succeeded in deleting preferences. dataPreferences 已设置为null');
  })
}


@Entry
@Component
struct TestPreferences {
  @State message: string = '通过用户首选项实现数据持久化';

  build() {
    Column({ space: 10 }) {
      Text(this.message)
        .id('TestPreferencesHelloWorld')
        .fontSize(20)
        .fontWeight(FontWeight.Bold)
      Button("写入数据")
        .fontColor(Color.White)
        .fontSize(20)
        .fontWeight(FontWeight.Medium)
        .onClick(() => {
          savaData();
        })
      Button("读取数据")
        .fontColor(Color.White)
        .fontSize(20)
        .fontWeight(FontWeight.Medium)
        .onClick(() => {
          readData();
        })
      Button("删除数据")
        .fontColor(Color.White)
        .fontSize(20)
        .fontWeight(FontWeight.Medium)
        .onClick(() => {
          testDeleteSync();
        })
      Button("数据持久化")
        .fontColor(Color.White)
        .fontSize(20)
        .fontWeight(FontWeight.Medium)
        .onClick(() => {
          flushData();
        })
      Button("订阅数据变更")
        .fontColor(Color.White)
        .fontSize(20)
        .fontWeight(FontWeight.Medium)
        .onClick(() => {
          observerData();
        })
      Button("删除指定文件。")
        .fontColor(Color.White)
        .fontSize(20)
        .fontWeight(FontWeight.Medium)
        .onClick(() => {
          testDeletePreferences();
        })

    }
    .height('100%')
    .width('100%')
  }
}
相关推荐
矛取矛求6 小时前
苹果与安卓，鸿蒙下跨设备，应用分享
android·华为·harmonyos
Zlssszls9 小时前
鸿蒙生态圈暗战：数字孪生三强争霸谁将主宰消费电子未来？
华为·harmonyos·数字孪生
用户33096607159614 小时前
鸿蒙ArkTS中级语法
harmonyos
程序猿阿伟14 小时前
《深度剖析：鸿蒙系统不同终端设备的UI自适应布局策略》
ui·华为·harmonyos
Raink15 小时前
第 2 章 初探ArkUI之页面布局
harmonyos
Raink15 小时前
第 16 章 一次开发多端部署
前端·harmonyos
Bruce_Liuxiaowei15 小时前
HarmonyOS Next～鸿蒙媒体开发技术解析：Audio Kit与AVCodec Kit的深度应用
华为·harmonyos·媒体
猿人在北京16 小时前
在鸿蒙 ArkUI 中使用本地数据缓存
缓存·华为·harmonyos·harmony next·兼容api12
别说我什么都不会16 小时前
OpenHarmony解读之设备认证：数据接收管理-消息处理(2)
物联网·嵌入式·harmonyos
李游Leo17 小时前
HarmonyOS @Reusable 装饰器自学指南：高性能组件复用实战指南
harmonyos
热门推荐
01第五章 动态规划02RAG 实践- Ollama+RagFlow 部署本地知识库03DeepSeek各版本说明与优缺点分析04苍穹外卖面试总结05本地化部署AI知识库：基于Ollama+DeepSeek+AnythingLLM保姆级教程06如何在WPS和Word/Excel中直接使用DeepSeek功能072024广东省职业技能大赛云计算赛项实战——Ansible部署Zabbix08DeepSeek R1本地化部署 Ollama + Chatbox 打造最强 AI 工具09从零安装 LLaMA-Factory 微调 Qwen 大模型成功及所有的坑10SQL 集合运算