使用Preferences实现草稿自动暂存
【摘要】 前言在笔记类应用里,最影响用户体验的场景之一就是意外退出:切后台被系统回收、误点返回、APP闪退,还没保存的文字直接丢失。如果用RDB全量写入,每次输入都操作数据库开销偏高;Preferences轻量键值存储刚好适合承担草稿实时暂存的能力。本文基于HarmonyOS NEXT,讲解如何基于@ohos.data.preferences实现笔记草稿自动保存、加载、清空逻辑。目标效果:用户输入富...
前言
在笔记类应用里,最影响用户体验的场景之一就是意外退出:切后台被系统回收、误点返回、APP闪退,还没保存的文字直接丢失。如果用RDB全量写入,每次输入都操作数据库开销偏高;Preferences轻量键值存储刚好适合承担草稿实时暂存的能力。本文基于HarmonyOS NEXT,讲解如何基于@ohos.data.preferences实现笔记草稿自动保存、加载、清空逻辑。
目标效果:用户输入富文本内容时,延迟防抖写入本地缓存;打开编辑页自动读取草稿;正常保存笔记后清除草稿。
一、方案选型对比
| 方案 | 优点 | 缺点 | 适用场景 |
|---|---|---|---|
| RDB关系型数据库 | 结构化存储、支持复杂查询 | 频繁IO性能开销大 | 正式笔记入库 |
| Preferences | 轻量、读写速度快、API简单 | 只适合小体量字符串,不适合大文件 | 草稿、临时配置、输入缓存 |
| AppStorage / LocalStorage | 内存级,访问极快 | 进程销毁数据丢失 | 页面内临时状态 |
结论:草稿属于临时、小体积、低频率持久化数据,Preferences是最合适的方案,和正式笔记存储做分层隔离。
二、核心依赖与初始化
import preferences from '@ohos.data.preferences';
import common from '@ohos.app.ability.common';
import { BusinessError } from '@ohos.base';
// 获取应用上下文
let context: common.UIAbilityContext = getContext(this) as common.UIAbilityContext;
let prefs: preferences.Preferences | null = null;
// 初始化Preferences实例
async function initPrefs() {
try {
prefs = await preferences.getPreferences(context, 'note_draft_store');
console.info('草稿存储初始化成功');
} catch (err) {
let error = err as BusinessError;
console.error(`初始化失败:${error.code}, ${error.message}`);
}
}
要点:文件名
note_draft_store会在应用沙盒生成对应的存储文件,属于应用私有数据,卸载自动清除。
三、封装草稿读写工具类
封装统一方法:保存草稿、读取草稿、清除草稿,对外屏蔽底层preferences API。
export class DraftUtil {
private static prefsIns: preferences.Preferences;
static async init(ctx: common.UIAbilityContext) {
this.prefsIns = await preferences.getPreferences(ctx, 'note_draft_store');
}
/**
* 保存草稿
* @param draftKey 笔记草稿唯一key,新建笔记可以固定为draft_new
* @param content 富文本序列化后的字符串
*/
static async saveDraft(draftKey: string, content: string) {
if (!this.prefsIns) return;
await this.prefsIns.putSync(draftKey, content);
await this.prefsIns.flush(); // 落盘
}
/**
* 读取草稿
*/
static async getDraft(draftKey: string): Promise<string> {
if (!this.prefsIns) return '';
return this.prefsIns.getSync(draftKey, '');
}
/**
* 清空草稿(笔记正式保存成功后调用)
*/
static async clearDraft(draftKey: string) {
if (!this.prefsIns) return;
await this.prefsIns.deleteSync(draftKey);
await this.prefsIns.flush();
}
}
四、搭配防抖,避免频繁写入
直接在onChange里每敲一个字就调用存储,会造成大量磁盘IO。用防抖函数,用户停止输入500ms之后再保存草稿:
let timerId: number | null = null;
function debounceSaveDraft(key: string, text: string) {
if (timerId) clearTimeout(timerId);
timerId = setTimeout(async () => {
await DraftUtil.saveDraft(key, text);
console.info('草稿已自动暂存');
}, 500);
}
在RichEditor的onChange回调中调用:
RichEditor()
.onChange((value) => {
// value 为富文本序列化字符串
debounceSaveDraft('draft_new', value);
})
五、页面生命周期联动逻辑
@Entry
@Component
struct NoteEditPage {
@State richContent: string = '';
private draftKey: string = 'draft_new';
aboutToAppear() {
// 页面打开,加载草稿
DraftUtil.getDraft(this.draftKey).then(res => {
if (res) {
this.richContent = res;
}
})
}
// 点击保存笔记,入库RDB并清除草稿
async onSaveNote() {
// 这里调用RDB写入正式笔记逻辑
// await RdbUtil.insertNote(this.richContent);
await DraftUtil.clearDraft(this.draftKey);
router.back();
}
aboutToDisappear() {
// 页面销毁前,清除防抖定时器
if (timerId) clearTimeout(timerId);
}
}
六、边界问题与坑点
- 数据体积限制:Preferences不适合超大文本,当笔记内容很长(上万字+大量富文本标签),建议降级提示或者改用临时文件。
- 多笔记编辑隔离:编辑已有笔记时,草稿key要用
draft_${noteId},避免不同笔记草稿互相覆盖。 - flush()同步落盘:putSync只是写到内存缓存,必须调用flush才会持久化到磁盘;如果不flush,进程异常退出时草稿会丢失。
- 多实例冲突:不要多处同时getPreferences同一个文件,统一单例管理。
- 版本升级迁移:Preferences数据在版本升级会保留,不需要额外迁移代码。
七、扩展优化方向
- 增加草稿过期清理:记录草稿保存时间,超过7天未使用的草稿自动清理;
- 增加草稿列表页面,支持用户手动恢复历史草稿;
- 增加标记区分:草稿/已保存笔记状态;
- 结合任务调度,低电量时降低防抖频率,减少写入。
结语
Preferences不是用来替代数据库,而是承担轻量临时缓存的角色。这套草稿暂存方案开发成本很低,却能直接解决用户痛点,是笔记类应用里性价比很高的基础能力。把草稿和正式笔记存储分开设计,后续迭代端云同步、版本快照的时候,架构也会更清晰。
【声明】本内容来自华为云开发者社区博主,不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)