深入解析actions/cache在各语言项目中的缓存实践

深入解析actions/cache在各语言项目中的缓存实践

cache Cache dependencies and build outputs in GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/cach/cache

在现代软件开发中，构建缓存是提升CI/CD流水线效率的重要手段。本文将全面介绍如何在各种编程语言环境中有效利用actions/cache来加速构建过程。

缓存机制基础原理

actions/cache的核心工作原理是通过识别项目依赖文件的哈希值（如lock文件）来创建和恢复缓存。当依赖文件未改变时，直接从缓存恢复依赖，避免重复下载和安装。

缓存关键参数解析

• path: 指定需要缓存的目录路径
• key: 唯一标识缓存的键，通常包含操作系统类型和依赖文件哈希
• restore-keys: 当精确匹配的key不存在时，用于部分匹配的回退方案

各语言缓存配置详解

JavaScript生态

npm项目缓存

- name: 获取npm缓存目录
  id: npm-cache-dir
  shell: bash
  run: echo "dir=$(npm config get cache)" >> ${GITHUB_OUTPUT}

- uses: actions/cache@v4
  with:
    path: ${{ steps.npm-cache-dir.outputs.dir }}
    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

关键点：

• 使用npm config get cache动态获取缓存目录
• 基于package-lock.json的哈希值创建缓存键
• 不推荐直接缓存node_modules目录

Yarn项目缓存

- name: 获取yarn缓存目录
  id: yarn-cache-dir
  run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT

- uses: actions/cache@v4
  with:
    path: ${{ steps.yarn-cache-dir.outputs.dir }}
    key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}

Python生态

pip缓存配置

- uses: actions/cache@v4
  with:
    path: ~/.cache/pip  # Linux系统路径
    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}

多操作系统支持方案：

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
        include:
        - os: ubuntu-latest
          path: ~/.cache/pip
        - os: macos-latest
          path: ~/Library/Caches/pip
        - os: windows-latest
          path: ~\AppData\Local\pip\Cache
    steps:
    - uses: actions/cache@v4
      with:
        path: ${{ matrix.path }}
        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}

Java生态

Maven项目缓存

- uses: actions/cache@v4
  with:
    path: ~/.m2/repository
    key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}

Gradle项目缓存

- uses: actions/cache@v4
  with:
    path: |
      ~/.gradle/caches
      ~/.gradle/wrapper
    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*') }}

注意：需确保Gradle守护进程已停止，避免缓存时文件锁定

Go语言项目

- uses: actions/cache@v4
  with:
    path: |
      ~/.cache/go-build  # Linux
      ~/go/pkg/mod
    key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}

多系统路径差异：

• macOS: ~/Library/Caches/go-build
• Windows: ~\AppData\Local\go-build

Rust项目

- uses: actions/cache@v4
  with:
    path: |
      ~/.cargo/bin/
      ~/.cargo/registry/
      target/
    key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}

高级缓存技巧

排除特定目录

- uses: actions/cache@v4
  with:
    path: |
      ~/.nuget/packages
      !~/.nuget/packages/unwanted  # 排除不需要的目录
    key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}

环境变量控制缓存位置

env:
  NUGET_PACKAGES: ${{ github.workspace }}/.nuget/packages
steps:
  - uses: actions/cache@v4
    with:
      path: ${{ github.workspace }}/.nuget/packages
      key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}

矩阵构建中的缓存策略

jobs:
  build:
    strategy:
      matrix:
        python-version: ["3.8", "3.9"]
    steps:
    - uses: actions/cache@v4
      with:
        path: ~/.cache/pip
        key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('**/requirements.txt') }}

常见问题解决方案

1. 缓存失效问题：确保key中使用的依赖文件（如lock文件）在构建过程中不会自动更新

2. 缓存命中检查：通过步骤输出检查缓存是否命中

- name: 检查缓存
  id: cache-check
  uses: actions/cache@v4
  with:
    path: ...

- name: 安装依赖
  if: steps.cache-check.outputs.cache-hit != 'true'
  run: ...

3. 大缓存问题：对于特别大的缓存，考虑分割或排除不必要的文件

通过合理配置actions/cache，可以显著减少CI/CD流水线的构建时间，特别是在依赖项较多的项目中效果更为明显。建议开发者根据项目特点选择最适合的缓存策略。

cache Cache dependencies and build outputs in GitHub Actions 项目地址: https://gitcode.com/gh_mirrors/cach/cache