HarmonyOS 应用实战 87:缓存清理别误删用户数据:按 CacheOwner 划分可删边界

缓存和业务数据如果没有分类,用户点清理缓存可能误删牌组、收藏或历史。这个问题不能只靠页面上补一个提示解决,因为真正的断点在 libraryHAR/src/main/ets/repositories/PreferencesStore.ets、状态字段和服务 owner 之间。下面按现有工程事实展开:先看源码,再说明风险链路,最后给出可以落地的补强方式。

在这里插入图片描述

这篇解决什么:缓存清理

角度 结论 落点
当前事实 底层偏好仓储提供 remove,可以删除指定 store 里的指定 key。 libraryHAR/src/main/ets/repositories/PreferencesStore.ets
主要风险 缓存和业务数据如果没有分类,用户点清理缓存可能误删牌组、收藏或历史。 清理入口必须区分 cache、userData、runtimeSignal 三类,不允许页面直接传 key。
补强方向 CleanupScope 清理缓存只删除白名单中的 cacheKeys,不触碰 Deck/Favorite/History 数据。
页面责任 缓存清理 页面显示清理结果,不暴露底层 key 输入。

缓存清理 来说,这张表先把边界固定住:当前事实来自 libraryHAR/src/main/ets/repositories/PreferencesStore.ets,风险落在 清理入口必须区分 cache、userData、runtimeSignal 三类,不允许页面直接传 key。,补强方案只围绕 CleanupScope 展开,不把问题扩散成泛泛的 HarmonyOS 状态管理讨论。

现有代码锚点:缓存清理 对应 libraryHAR/src/main/ets/repositories/PreferencesStore.ets

下面这段来自 The_Book_of_Answers 当前工程,锚点是 async remove。它不是装饰性引用,而是判断这篇文章能不能落地的依据。

0169     }
0170     try {
0171       return await this.store(storeName).has(key);
0172     } catch (e) {
0173       return false;
0174     }
0175   }
0176 
0177   async remove(storeName: string, key: string): Promise<void> {
0178     const s = this.store(storeName);
0179     try {
0180       await s.delete(key);
0181       await s.flush();
0182     } catch (e) {
0183       const err = e as BusinessError;
0184       hilog.error(DOMAIN, TAG, 'remove fail %{public}s %{public}s', key, JSON.stringify(err));
0185       throw err as Error;

这段代码说明:底层偏好仓储提供 remove,可以删除指定 store 里的指定 key。 所以后续补强不能绕开这个事实;如果把 缓存清理 直接写成页面局部变量,第一次交互可能看起来没问题,跨页面、重进或发布回归时就会暴露。

失败链路:问题通常不是突然出现

缓存和业务数据如果没有分类,用户点清理缓存可能误删牌组、收藏或历史。

环节 内容 排查动作
触发点 用户点清理缓存 确认输入来自哪里
断点 清理入口必须区分 cache、userData、runtimeSignal 三类,不允许页面直接传 key。 确认服务层有没有拦住
外显现象 清理后牌组没了 确认页面有没有清楚反馈

这张断点表是给 缓存清理 做回归时用的。先复现触发点,再检查 清理入口必须区分 cache、userData、runtimeSignal 三类,不允许页面直接传 key。 是否存在,最后看用户能不能从 清理后牌组没了 这种现象里得到下一步动作。

先排除误区:缓存清理 不是页面补丁

遇到 缓存清理,最容易犯的错是先在页面里加一个局部状态,让当前场景看起来正常。这个做法短期能遮住现象,但不会处理 清理后牌组没了 这类断点。

临时做法 看起来解决了什么 后续会留下什么
页面里直接改 @State 当前界面刷新了 服务和仓储没有真实状态
保存失败后直接返回 用户看不到报错 数据可能没有写入
每个入口各写一份判断 某个页面正常 其他入口继续出错
只看成功路径 操作流程很顺 失败分支无法复现
function unsafeHandleArticle87(reason: string): void {
  if (!reason) {
    return;
  }
  promptAction.showToast({ message: reason });
  // 只提示不收口,下一次进入仍可能遇到同一个 缓存清理 问题。
}

这段反例的目的不是讲语法,而是提醒边界:缓存清理 的根因要回到 清理缓存只删除白名单中的 cacheKeys,不触碰 Deck/Favorite/History 数据。,页面只能表达反馈,不能替服务层决定数据是否已经可靠。

在这里插入图片描述

按照图里的顺序看,真正要拦住的是这一句:清理入口必须区分 cache、userData、runtimeSignal 三类,不允许页面直接传 key。 只要这个点没有收口,用户看到的现象就会在刷新、保存、返回、导入或发布时反复变化。

责任边界:缓存清理 不该由谁兜底

CacheCleanupService 定义白名单,PreferencesStore 执行底层删除。

层级 应该负责 不应该负责
页面 页面显示清理结果,不暴露底层 key 输入。 直接改底层 key 或吞掉失败
服务 清理缓存只删除白名单中的 cacheKeys,不触碰 Deck/Favorite/History 数据。 让每个页面复制一套规则
仓储/配置 只保存和读取真实数据 理解页面交互语义

排查 缓存清理 时先问 owner,再问信号,最后才看样式。像 清理后牌组没了,通常不是单纯的 UI 细节,而是 缓存范围包含业务 key 没被服务层收住。

状态模型:CleanupScope

建议把这件事压成一个明确模型。下面代码是建议补强,不表示当前工程已经存在同名接口。

interface CleanupScope {
  cacheKeys: string[]; // 可清理缓存 key
  runtimeSignalKeys: string[]; // 可重置运行时信号
  protectedKeys: string[]; // 牌组、收藏、历史等受保护 key
  finishedAt: number; // 清理完成时间
}

function createCleanupScope(input: Partial<CleanupScope>): CleanupScope {
  return {
    cacheKeys: Array.isArray(input.cacheKeys) ? input.cacheKeys : [],
    runtimeSignalKeys: Array.isArray(input.runtimeSignalKeys) ? input.runtimeSignalKeys : [],
    protectedKeys: Array.isArray(input.protectedKeys) ? input.protectedKeys : [],
    finishedAt: typeof input.finishedAt === 'number' ? input.finishedAt : 0,
  };
}

CleanupScope 至少要能回答三个问题:输入从哪里来、失败怎么表达、成功之后谁刷新。字段少一点没关系,但不能让页面靠猜来决定 页面显示清理结果,不暴露底层 key 输入。

提交顺序:缓存清理 要先有提交点

把状态模型写出来以后,还要约束提交顺序。否则接口名字很好看,实际调用仍可能在页面、服务和仓储之间来回绕。

  1. 页面先收集用户动作,只生成 CleanupScope 或等价输入。
  2. 服务读取必要的当前状态,执行 清理缓存只删除白名单中的 cacheKeys,不触碰 Deck/Favorite/History 数据。
  3. 通过边界后再写仓储、Preferences 或运行时信号。
  4. 页面根据结果展示成功、失败、刷新或恢复入口。
async function submitArticle87(state: CleanupScope): Promise<void> {
  const result: CleanupScopeResult = await commitCleanupScope(state);
  if (!result.ok) {
    CleanupScopeNotice(result.reason);
    return;
  }
  AppStorage.setOrCreate('article87ChangedAt', result.changedAt);
}

这个顺序的价值在失败分支。只要 缓存清理 没通过服务闸门,就不应该提前写入运行时信号,也不应该让页面表现得像已经保存成功。

服务闸门:先判断能不能提交

缓存清理 的服务层应该先判断边界,再执行写入或刷新。下面的写法把 reason 返回给页面,是为了让 按钮无反馈 能被解释,而不是只弹一个“失败”。

interface CleanupScopeResult {
  ok: boolean;
  reason: string;
  changedAt: number;
}

function explainCleanupScope(state: CleanupScope): string {
  if (state.cacheKeys.length === 0) {
    return 'cacheKeys 不能为空';
  }
  return '';
}

async function commitCleanupScope(state: CleanupScope): Promise<CleanupScopeResult> {
  const reason: string = explainCleanupScope(state);
  if (reason) {
    return { ok: false, reason, changedAt: Date.now() };
  }
  return { ok: true, reason: 'ready', changedAt: Date.now() };
}

这里的关键是:缓存清理 不满足边界时不要写仓储,也不要悄悄修改运行时状态。先返回原因,页面再决定展示刷新、重试、回退还是放弃入口。

页面接入:提示可以清楚,规则不要搬到 UI

页面要做的是把用户动作表达清楚。比如 页面显示清理结果,不暴露底层 key 输入。,这类信息适合放到 UI;但真正的校验和写入顺序仍然应该在服务层。

@Builder
function CleanupScopeNotice(reason: string) {
  if (reason) {
    Column({ space: 8 }) {
      Text('缓存清理')
        .fontSize(16)
        .fontWeight(FontWeight.Medium)
      Text(reason)
        .fontSize(13)
        .fontColor(AppColor.danger)
    }
    .padding(12)
    .border({ width: 1, color: AppColor.danger })
    .borderRadius(AppRadius.md)
  }
}

这种接入方式对 缓存清理 有一个好处:页面可以保持轻量,服务仍然是规则 owner。以后再加列表页、设置页、恢复页或发布回归,也不用围绕 CleanupScope 复制判断条件。

结构收口:从源码到验证只走一条线

在这里插入图片描述

缓存清理 的结构图要能互相对应:源码锚点证明当前事实,CleanupScope 描述新增边界,服务规则决定提交方式,验证点证明 清理缓存后,自建牌组仍存在。 没有被吞掉。

验证路径:成功和失败都要跑

序号 验证点
1 清理缓存后,自建牌组仍存在。
2 收藏列表不应变化。
3 历史问题不应被清空。
4 运行时刷新信号可以重置并重新写入当前时间。
Write-Host "查看 缓存清理 的源码锚点"
rg -n "async\ remove|CleanupScope" "D:\ProgramData\huawei\lesson\The_Book_of_Answers\libraryHAR\src\main\ets\repositories\PreferencesStore.ets"

Write-Host "查看相关状态字段"
rg -n "cacheKeys|runtimeSignalKeys|protectedKeys|AppStorageKey|AppPrefKey|StorageLink|updatedAt" "D:\ProgramData\huawei\lesson\The_Book_of_Answers"

这些命令只能检查 缓存清理 的源码落点和关键字段,不代表已经完成真机交互。涉及 清理缓存后,自建牌组仍存在。 这种场景时,还需要在 DevEco/设备侧补完整流程验证。

负向回归:缓存清理 要故意跑坏一次

只跑成功路径很容易误判。缓存清理 至少要准备一组负向样本,让服务层证明它会拒绝错误输入,而不是靠页面刚好没有触发问题。

负向样本 期望反应 说明
缺少 cacheKeys 返回明确原因,不写仓储 验证主输入不是默认通过
触发 清理后牌组没了 保留当前页面状态 验证失败分支不会静默返回
模拟 清理完成时间未写入 页面显示下一步动作 验证用户能继续处理
重复执行提交 结果保持一致 验证服务闸门能承受重进
async function runNegativeArticle87(state: CleanupScope): Promise<string> {
  const result: CleanupScopeResult = await commitCleanupScope(state);
  if (result.ok) {
    return 'unexpected success';
  }
  return result.reason;
}

这组负向样本能把 缓存清理 从“看起来能用”推进到“失败时也能解释”。写文章时把这部分放出来,读者才能按自己的工程复现。

常见问题:先定位断点

现象 常见原因 优先检查
清理后牌组没了 缓存范围包含业务 key 白名单中排除 DeckPrefKey
按钮无反馈 清理完成时间未写入 返回 CleanupScope.finishedAt
部分 key 删除失败 底层 remove 错误未收集 返回逐项结果

遇到 缓存清理 的异常时不要先改样式。先确认是哪一层没有交接:页面是否保留 cacheKeys,服务是否统一处理规则,仓储或配置是否留下旧值,运行时信号是否发出。

落地顺序:先最小闭环,再补体验

  1. libraryHAR/src/main/ets/repositories/PreferencesStore.ets 附近确认当前链路,避免改错文件。
  2. 增加 CleanupScope 或等价状态模型,字段只保留能解释失败的部分。
  3. 缓存清理 的规则放到服务层,页面只展示原因和下一步动作。
  4. 跑成功路径和失败路径,特别是 清理缓存后,自建牌组仍存在。
const regressionForArticle87: string[] = [
  '清理缓存后,自建牌组仍存在。',
  '收藏列表不应变化。',
  '历史问题不应被清空。'
];

收口

缓存清理 的处理方法可以压成一句话:CacheCleanupService 定义白名单,PreferencesStore 执行底层删除。 当前工程已经有可依赖的源码基础,文章里的新增接口和函数属于建议补强;真正落地时,优先保持 owner 清楚,再补页面反馈。

结论 内容 边界
可以直接复用 底层偏好仓储提供 remove,可以删除指定 store 里的指定 key。 libraryHAR/src/main/ets/repositories/PreferencesStore.ets
建议新增 CleanupScope 清理缓存只删除白名单中的 cacheKeys,不触碰 Deck/Favorite/History 数据。
暂不声明 真机行为、CSDN 上传、发布结果 没有实际执行就不写成已完成
结论 内容 边界
可以直接复用 底层偏好仓储提供 remove,可以删除指定 store 里的指定 key。 libraryHAR/src/main/ets/repositories/PreferencesStore.ets
建议新增 CleanupScope 清理缓存只删除白名单中的 cacheKeys,不触碰 Deck/Favorite/History 数据。
暂不声明 真机行为、CSDN 上传、发布结果 没有实际执行就不写成已完成
Logo

讨论HarmonyOS开发技术,专注于API与组件、DevEco Studio、测试、元服务和应用上架分发等。

更多推荐