跨平台开发 / 系统课时
缓存 Flutter 和 pub 依赖
缓存 Flutter 和 pub 依赖
本篇解决 CI 流水线中 Flutter SDK、pub 包和构建缓存重复下载的问题。通过合理配置缓存键和恢复策略,可以缩短构建时间,同时避免不同依赖状态之间相互污染。
学习目标
- 理解 Flutter CI 中常见缓存对象和缓存失效原因
- 学会在流水线中配置 pub 依赖缓存
- 掌握缓存命中、失效和清理的验证方法
为什么需要缓存 Flutter 依赖
CI 环境通常是临时创建的运行环境,每次执行任务时可能都需要重新安装 Flutter SDK、解析 pub 依赖并下载构建工具。如果项目依赖较多,下载过程会占用大量时间。
缓存的目标不是保存整个构建环境,而是保存可以安全复用的输入,例如 pub 包缓存目录、Flutter SDK 缓存目录或包管理器下载内容。
Flutter 项目中常见的缓存对象包括:
| 缓存内容 | 作用 | 变化频率 |
|---|---|---|
| pub cache | 保存 Dart 包下载结果 | 依赖变更时变化 |
| Flutter SDK | 避免重复下载 SDK | Flutter 版本变化时变化 |
| 构建产物 | 加速部分重复构建 | 与构建配置相关 |
配置 pub 依赖缓存
以 GitHub Actions 为例,可以使用缓存 action 保存 pub 依赖目录。缓存键需要包含操作系统和依赖锁文件哈希,避免不同依赖版本共用错误缓存。
yaml
name: flutter-ci
on:
push:
branches: [main]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: subosito/flutter-action@v2
with:
flutter-version: '<FLUTTER_VERSION>'
- name: Cache pub packages
uses: actions/cache@v4
with:
path: ~/.pub-cache
key: ${{ runner.os }}-pub-${{ hashFiles('pubspec.lock') }}
restore-keys: |
${{ runner.os }}-pub-
- name: Install dependencies
run: flutter pub get预期结果
text
Cache restored if a matching key exists.
flutter pub get completes with fewer downloads after cache hit.这里使用 pubspec.lock 参与缓存键计算。当依赖版本发生变化时,哈希值改变,CI 会创建新的缓存,避免旧依赖污染。
避免缓存污染
缓存失败通常不是缓存本身不可用,而是缓存范围设计不合理。例如:
- 多个 Flutter 版本共享同一个缓存键。
- 修改依赖后仍然恢复旧缓存。
- 缓存构建产物但没有区分构建模式。
可以通过增加版本信息控制缓存边界,例如将 Flutter 主版本加入缓存键:
yaml
key: ${{ runner.os }}-flutter-<FLUTTER_VERSION>-pub-${{ hashFiles('pubspec.lock') }}预期结果
text
Different Flutter versions use different cache entries.
Dependency changes create a new cache key.缓存不是永久存储。遇到难以解释的依赖问题时,应优先尝试清理缓存并重新执行一次完整安装,确认问题来自缓存还是项目配置。
验证缓存是否生效
判断缓存是否有效,可以观察 CI 日志中的恢复信息,并比较首次运行和后续运行的依赖安装时间。
有效缓存通常表现为:
- 日志显示缓存命中。
flutter pub get不再大量下载包。- 构建时间明显下降。
合理缓存的原则是让稳定输入快速复用,让变化输入及时失效。缓存配置越激进,速度可能越快,但错误复用的风险也越高。
按自己的节奏,确认真正理解。