HarmonyOS应用开发实战：小事记 - 用户偏好存储 @ohos.data.preferences：Preferences 的键值对读写与异步初始化

前言

@ohos.data.preferences是 HarmonyOS 提供的轻量级键值对存储，适用于存储用户偏好设置、应用配置等小型数据。与关系型数据库不同，Preferences 使用更简单的键值对模型，适合存储单个配置项。本文以小事记（xiaoshiji_ohos_app） 的SettingsPage.ets为分析对象，深入解析 Preferences 的使用。

本文参考 HarmonyOS 官方文档：preferences 文档 和 数据管理。

一、Preferences 的基本用法

1.1 获取实例

// 获取 Preferences 实例import{preferences}from'@kit.DataKit';import{common}from'@kit.AbilityKit';asyncfunctiongetPreferences(context:common.Context):Promise<preferences.Preferences>{constpref=awaitpreferences.getPreferences(context,'user_preferences');returnpref;}

二、读写操作

2.1 写入数据

// 写入数据asyncfunctionsavePreferences(pref:preferences.Preferences):Promise<void>{awaitpref.put('theme_color','#7B68EE');awaitpref.put('is_dark_mode',false);awaitpref.put('font_size',16);awaitpref.put('auto_backup',true);awaitpref.put('last_sync_time','2024-05-20 14:30:00');awaitpref.flush();// 持久化到磁盘}

2.2 读取数据

// 读取数据asyncfunctionloadPreferences(pref:preferences.Preferences):Promise<UserPreferences>{constthemeColor=awaitpref.get('theme_color','#7B68EE');constisDarkMode=awaitpref.get('is_dark_mode',false);constfontSize=awaitpref.get('font_size',16);constautoBackup=awaitpref.get('auto_backup',true);constlastSyncTime=awaitpref.get('last_sync_time','');return{themeColor,isDarkMode,fontSize,autoBackup,lastSyncTime};}

三、Preferences 与 RdbStore 的对比

四、常见问题

4.1 数据未持久化

问题：调用了put方法，但应用重启后数据丢失。

解决方案：调用flush方法将数据持久化到磁盘。

// ✅ 正确：flush 持久化awaitpref.put('key','value');awaitpref.flush();// ❌ 错误：没有 flush，数据可能丢失awaitpref.put('key','value');

五、

// 错误处理示例import{BusinessError}from"@kit.BasicServicesKit";try{constdata=awaitgetData("https://api.example.com");}catch(err){console.error(`请求失败:${(errasBusinessError).message}`);}

最佳实践

八、拓展阅读

本节汇总了与本文主题相关的扩展阅读材料，帮助读者深入理解相关技术细节。

8.1 官方文档

• 开发者指南：HarmonyOS 应用开发概述
• API 参考：ArkTS API 参考

8.2 相关技术文章

• 性能优化最佳实践
• 常见问题排查指南

8.3 社区资源

• 开源鸿蒙跨平台社区：https://openharmonycrossplatform.csdn.net

十、最佳实践与优化建议

在实际开发中，合理运用上述技术可以显著提升应用的性能和用户体验。以下是几个关键的最佳实践建议：

10.1 性能优化要点

10.2 推荐实践步骤

按照以下步骤进行优化：

1. 使用 DevEco Studio 的 Profiler 工具分析当前性能瓶颈
2. 针对识别出的热点进行针对性优化
3. 通过单元测试和集成测试验证优化效果
4. 在真机环境下进行回归测试

10.3 代码示例

// 推荐的最佳实践示例@Componentexportstruct OptimizedComponent{// 使用 @State 管理最小粒度的状态@StateprivateisActive:boolean=false;build(){Column(){Text(this.isActive?'激活':'未激活').fontSize(16)}.onClick(()=>{// 使用 animateTo 实现平滑过渡animateTo({duration:300},()=>{this.isActive=!this.isActive;});});}}

最佳实践提示：在编写代码时，始终遵循 ArkUI 的性能优化原则，避免在 build() 方法中执行复杂计算或频繁的状态更新。

十、进一步学习与拓展

掌握以上内容后，可以进一步探索以下相关主题，深化对 HarmonyOS 开发的理解：

10.1 推荐学习路径

10.2 实践项目建议

建议通过以下实践项目巩固所学知识：

1. 基于小事记项目，尝试独立实现一个类似的功能模块
2. 阅读 HarmonyOS 官方 Sample 代码，学习最佳实践
3. 参与开源社区，贡献代码或文档

10.3 相关资源

• HarmonyOS 官方文档：提供完整的 API 参考和开发指南
• DevEco Studio 文档：包含 IDE 使用技巧和调试方法
• 开源社区：获取项目源码和开发经验

学习建议：理论与实践相结合，在阅读文档的同时动手编写代码，才能更好地掌握 HarmonyOS 应用开发技能。

10.4 拓展阅读

以下资源可以加深对本文内容的理解：

1. HarmonyOS 官方开发者文档提供了最权威的 API 参考和最佳实践指南
2. 开源社区的项目源码是学习实际应用开发的宝贵资源
3. DevEco Studio 的代码示例模板可以帮助快速上手

学习路径：建议按照"官方文档 → 开源项目 → 实践项目"的路径循序渐进地学习。

十、完整示例：数据存储封装

将数据存取逻辑封装为统一的 Repository 模式，可以简化数据层操作。

10.1 数据仓库封装

// DataRepository.ets — 数据仓库import{preferences}from'@kit.ArkData';exportclassDataRepository{privatepref:preferences.Preferences|null=null;asyncinit(context:Context):Promise<void>{this.pref=awaitpreferences.getPreferences(context,'app_pref');}asyncsetString(key:string,value:string):Promise<void>{if(!this.pref)return;awaitthis.pref.put(key,value);awaitthis.pref.flush();}asyncgetString(key:string,def:string=''):Promise<string>{if(!this.pref)returndef;return(awaitthis.pref.get(key,def))asstring;}asyncsetNumber(key:string,value:number):Promise<void>{if(!this.pref)return;awaitthis.pref.put(key,value);awaitthis.pref.flush();}asyncremove(key:string):Promise<void>{if(!this.pref)return;awaitthis.pref.delete(key);awaitthis.pref.flush();}}

10.2 使用示例

// 在 Ability 中初始化constrepo=newDataRepository();awaitrepo.init(this.context);// 存储数据awaitrepo.setString('user_name','张三');awaitrepo.setNumber('user_age',28);// 读取数据constname=awaitrepo.getString('user_name','默认用户');console.log(`用户:${name}`);

10.3 存储方案选择

数据安全：敏感数据建议使用加密存储，避免明文保存用户密码和 Token 等敏感信息。

十一、常见错误排查

在实际开发过程中，开发者经常会遇到一些典型的错误和问题。以下汇总了常见错误及其解决方案：

11.1 典型错误一览

11.2 调试步骤

遇到问题时，按以下步骤进行排查：

1. 查看 hilog 日志，定位错误发生的位置和堆栈信息
2. 使用 DevEco Studio 的断点调试功能，逐步跟踪代码执行路径
3. 检查 module.json5 和资源配置文件，确认配置项是否正确
4. 在真机环境下复现问题，验证是否与模拟器环境差异有关

11.3 调试代码示例

// 调试工具函数exportclassDebugUtil{staticlogError(tag:string,message:string,error?:Error):void{console.error(`[${tag}]${message}`);if(error){console.error(`[${tag}] Stack:${error.stack}`);}}staticlogState(tag:string,state:Record<string,Object>):void{console.info(`[${tag}] State:${JSON.stringify(state)}`);}}

调试建议：在开发阶段保持 hilog 的详细日志输出，发布前关闭调试日志以提升性能。

总结

// 网络请求示例import{http}from"@kit.NetworkKit";asyncfunctiongetData(url:string):Promise<Object>{consthttpRequest=http.createHttp();constresponse=awaithttpRequest.request(url);httpRequest.destroy();returnresponse.result;}

本文深入解析了 Preferences 键值对存储的使用。核心要点如下：

1. Preferences：轻量级键值对存储，适用于配置项
2. 读写操作：put 写入，get 读取，flush 持久化
3. 与 RdbStore 对比：Preferences 适用于小型配置数据
4. 异步初始化：在 aboutToAppear 中异步加载

如果这篇文章对你有帮助，欢迎点赞👍、收藏⭐、关注🔔，你的支持是我持续创作的动力！

九、完整示例代码

9.1 完整组件实现

以下是一个完整的组件实现示例，展示了本文介绍的各个技术点的综合运用：

import{Component,State,Prop}from'@kit.ArkUI';@Componentexportstruct DemoComponent{@Proptitle:string='';@Statecount:number=0;build(){Column({space:12}){// 标题区域Text(this.title).fontSize(18).fontWeight(FontWeight.Bold).fontColor('#1A1A2E').width('100%')// 内容区域Text(`当前计数:${this.count}`).fontSize(14).fontColor('#6B7280')// 交互按钮Button('点击增加').width(120).height(40).backgroundColor('#7B68EE').borderRadius(20).fontColor(Color.White).onClick(()=>{this.count++;})}.width('100%').padding(16).backgroundColor(Color.White).borderRadius(12).shadow({radius:4,color:'#00000008',offsetX:0,offsetY:2})}}

9.2 使用方式

在页面中引入并使用该组件：

@Entry@Componentstruct Index{build(){Column(){DemoComponent({title:'示例组件'})}.width('100%').height('100%').backgroundColor('#F8F9FA')}}

9.3 代码说明

• 组件封装：使用@Component装饰器定义可复用的组件
• 状态管理：使用@State管理组件内部状态
• 参数传递：使用@Prop接收外部传入的参数
• 事件处理：使用onClick处理用户交互
• 样式优化：使用borderRadius、shadow等属性美化 UI

相关资源：

• 官方文档 - 开发者指南：HarmonyOS 应用开发
• 官方文档 - ArkUI 组件参考：ArkUI 组件
• 官方文档 - API 参考：API 参考
• 官方文档 - 状态管理：状态管理概述
• 官方文档 - 动画：动画概述
• 官方文档 - 网络管理：网络管理
• 官方文档 - 数据管理：数据管理
• 开源鸿蒙跨平台社区：https://openharmonycrossplatform.csdn.net