GitHub Actions cache restore-keys 怎样设计分层缓存
来源:17golang原创
时间:2026-11-20 08:36:08 354浏览 收藏
GitHub Actions 的分层缓存,核心不是把 restore-keys 写得越多越好,而是把“完全相同的依赖”和“可以安全复用的旧依赖”分开。建议让 key 负责精确命中,再让 restore-keys 按从窄到宽的顺序回退:先找同一运行系统、同一分支的旧缓存,最后才退到同一系统的通用缓存。
官方地址:https://docs.github.com/en/actions/reference/workflows-and-actions/dependency-caching
下面用 npm 下载目录演示完整操作。文中的界面均为原创说明图,不是 GitHub 页面截图;真正的命中结果以你自己的 Actions 日志为准。
1. 先确定缓存层级和编辑入口
进入仓库的 Actions → Workflows,打开负责构建的 workflow 文件;如果你直接维护代码,也可以在仓库根目录打开 .github/workflows/ci.yml。先确认缓存对象是 npm 下载目录 ~/.npm,不要把工作区中的构建产物和依赖下载缓存混在同一个 key 里。
在 编辑文件 → Jobs → build → Steps 对应位置加入缓存步骤。第一张图只用于定位字段和保存入口:

2. 用 key 锁定完整依赖集合
把操作系统、分支和 lockfile 哈希放进精确 key。这样 package-lock.json 改变时会产生新的缓存,而不同系统不会因为目录结构差异误用同一份缓存。
steps:
- name: Cache npm directory
id: npm-cache
uses: actions/cache@v4
with:
# 只缓存 npm 下载目录,避免把工作区构建产物混入
path: ~/.npm
# lockfile 哈希变化时,精确层自动切换到新缓存
key: ${{ runner.os }}-npm-${{ github.ref_name }}-${{ hashFiles('package-lock.json') }}
这里的 key 是“精确层”。如果它完全匹配,输出 cache-hit 会为 true;如果只是前缀匹配,仍然能恢复文件,但不属于精确命中。
3. 按从窄到宽填写 restore-keys
在同一个 with 区域继续填写回退键,每行一个,并按优先级从上到下排列。第一层保留操作系统和分支,第二层只保留操作系统:
restore-keys: |
# 第一回退层:同系统、同分支的最近缓存
${{ runner.os }}-npm-${{ github.ref_name }}-
# 第二回退层:同系统的其他分支缓存
${{ runner.os }}-npm-
GitHub Actions 会先查精确 key,再按顺序查这些前缀;同一前缀有多个部分匹配时,会取最近创建的缓存。不要为了“多一层保险”直接写成跨系统的 npm-:Linux、macOS 和 Windows 的依赖目录可能不适合互换,回退层必须服从缓存内容的可兼容性。
4. 提交后从运行结果确认命中层级
点击 Commit changes,再进入 Actions → 对应 workflow → 最新 run → build → Cache npm directory。检查步骤日志中的 primary key、命中的 restore key 和 cache-hit 输出,不要只看步骤变绿。

| 看到的状态 | 说明 | 下一步 |
|---|---|---|
cache-hit: true | 精确 key 命中 | 继续观察安装和构建耗时 |
恢复成功但 cache-hit 不是 true | 命中了 restore-keys 的部分缓存 | 确认回退层是否仍然兼容 |
| 没有匹配缓存 | 本次从空目录开始,成功后会生成新缓存 | 等待下一次相同 key 的运行 |
5. 误命中时怎样调整
如果构建工具、Node 版本或依赖目录结构发生变化,优先把变化因素加入精确 key,而不是继续增加宽泛的 restore-key。若 pull request 来自低信任触发器,还要注意缓存写入权限和污染风险;不要在缓存路径中放 token、登录凭据或会被后续步骤直接执行的敏感文件。
最终可以把设计记成一句话:精确 key 负责正确,窄到宽的 restore-keys 负责复用,运行日志负责验收。这比用一个过宽的前缀覆盖所有分支更容易排错,也更容易控制跨系统和安全边界。
常见问题
为什么 restore-keys 要一行一个?因为它是按顺序尝试的候选前缀,换行就是优先级边界。
部分命中后还会保存新缓存吗?如果 job 成功,缓存 action 仍可能用当前精确 key 保存新的内容;是否写入还要受触发事件和仓库缓存权限影响。
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
190 收藏
-
293 收藏
-
306 收藏
-
322 收藏
-
462 收藏
-
196 收藏
-
442 收藏
-
151 收藏
-
441 收藏
-
435 收藏
-
397 收藏
-
398 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习