Turborepo Caching

Turborepo 缓存

Turborepo 构建优化的生产级模式。

不适用场景

• 任务与 Turborepo 缓存无关
• 需要本范围外的其他领域或工具

使用说明

• 明确目标、约束和所需输入
• 应用相关最佳实践并验证结果
• 提供可执行的步骤和验证方法
• 如需详细示例，请打开 resources/implementation-playbook.md

适用场景

• 设置新的 Turborepo 项目
• 配置构建流水线
• 实现远程缓存
• 优化 CI/CD 性能
• 从其他 monorepo 工具迁移
• 调试缓存未命中问题

核心概念

1. Turborepo 架构

Workspace Root/
├── apps/
│   ├── web/
│   │   └── package.json
│   └── docs/
│       └── package.json
├── packages/
│   ├── ui/
│   │   └── package.json
│   └── config/
│       └── package.json
├── turbo.json
└── package.json

2. 流水线概念

模板

模板 1：turbo.json 配置

{
  "$schema": "https://turbo.build/schema.json",
  "globalDependencies": [
    ".env",
    ".env.local"
  ],
  "globalEnv": [
    "NODE_ENV",
    "VERCEL_URL"
  ],
  "pipeline": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": [
        "dist/**",
        ".next/**",
        "!.next/cache/**"
      ],
      "env": [
        "API_URL",
        "NEXT_PUBLIC_*"
      ]
    },
    "test": {
      "dependsOn": ["build"],
      "outputs": ["coverage/**"],
      "inputs": [
        "src/**/*.tsx",
        "src/**/*.ts",
        "test/**/*.ts"
      ]
    },
    "lint": {
      "outputs": [],
      "cache": true
    },
    "typecheck": {
      "dependsOn": ["^build"],
      "outputs": []
    },
    "dev": {
      "cache": false,
      "persistent": true
    },
    "clean": {
      "cache": false
    }
  }
}

模板 2：包级流水线配置

// apps/web/turbo.json
{
  "$schema": "https://turbo.build/schema.json",
  "extends": ["//"],
  "pipeline": {
    "build": {
      "outputs": [".next/**", "!.next/cache/**"],
      "env": [
        "NEXT_PUBLIC_API_URL",
        "NEXT_PUBLIC_ANALYTICS_ID"
      ]
    },
    "test": {
      "outputs": ["coverage/**"],
      "inputs": [
        "src/**",
        "tests/**",
        "jest.config.js"
      ]
    }
  }
}

模板 3：使用 Vercel 的远程缓存

# 登录 Vercel
npx turbo login

# 关联 Vercel 项目
npx turbo link

# 使用远程缓存运行
turbo build --remote-only

# CI 环境变量
TURBO_TOKEN=your-token
TURBO_TEAM=your-team

# .github/workflows/ci.yml
name: CI

on:
  push:
    branches: [main]
  pull_request:

env:
  TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
  TURBO_TEAM: ${{ vars.TURBO_TEAM }}

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Build
        run: npx turbo build --filter='...[origin/main]'

      - name: Test
        run: npx turbo test --filter='...[origin/main]'

模板 4：自托管远程缓存

// 自定义远程缓存服务器 (Express)
import express from 'express';
import { createReadStream, createWriteStream } from 'fs';
import { mkdir } from 'fs/promises';
import { join } from 'path';

const app = express();
const CACHE_DIR = './cache';

// 获取产物
app.get('/v8/artifacts/:hash', async (req, res) => {
  const { hash } = req.params;
  const team = req.query.teamId || 'default';
  const filePath = join(CACHE_DIR, team, hash);

  try {
    const stream = createReadStream(filePath);
    stream.pipe(res);
  } catch {
    res.status(404).send('Not found');
  }
});

// 存储产物
app.put('/v8/artifacts/:hash', async (req, res) => {
  const { hash } = req.params;
  const team = req.query.teamId || 'default';
  const dir = join(CACHE_DIR, team);
  const filePath = join(dir, hash);

  await mkdir(dir, { recursive: true });

  const stream = createWriteStream(filePath);
  req.pipe(stream);

  stream.on('finish', () => {
    res.json({ urls: [`${req.protocol}://${req.get('host')}/v8/artifacts/${hash}`] });
  });
});

// 检查产物是否存在
app.head('/v8/artifacts/:hash', async (req, res) => {
  const { hash } = req.params;
  const team = req.query.teamId || 'default';
  const filePath = join(CACHE_DIR, team, hash);

  try {
    await fs.access(filePath);
    res.status(200).end();
  } catch {
    res.status(404).end();
  }
});

app.listen(3000);

// 自托管缓存的 turbo.json 配置
{
  "remoteCache": {
    "signature": false
  }
}

# 使用自托管缓存
turbo build --api="http://localhost:3000" --token="my-token" --team="my-team"

模板 5：过滤与作用域

# 构建指定包
turbo build --filter=@myorg/web

# 构建包及其依赖
turbo build --filter=@myorg/web...

# 构建包及其依赖方
turbo build --filter=...@myorg/ui

# 构建自 main 以来变更的包
turbo build --filter='...[origin/main]'

# 构建目录下的包
turbo build --filter='./apps/*'

# 组合过滤条件
turbo build --filter=@myorg/web --filter=@myorg/docs

# 排除包
turbo build --filter='!@myorg/docs'

# 包含变更的依赖
turbo build --filter='...[HEAD^1]...'

模板 6：高级流水线配置

{
  "$schema": "https://turbo.build/schema.json",
  "pipeline": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": ["dist/**"],
      "inputs": [
        "$TURBO_DEFAULT$",
        "!**/*.md",
        "!**/*.test.*"
      ]
    },
    "test": {
      "dependsOn": ["^build"],
      "outputs": ["coverage/**"],
      "inputs": [
        "src/**",
        "tests/**",
        "*.config.*"
      ],
      "env": ["CI", "NODE_ENV"]
    },
    "test:e2e": {
      "dependsOn": ["build"],
      "outputs": [],
      "cache": false
    },
    "deploy": {
      "dependsOn": ["build", "test", "lint"],
      "outputs": [],
      "cache": false
    },
    "db:generate": {
      "cache": false
    },
    "db:push": {
      "cache": false,
      "dependsOn": ["db:generate"]
    },
    "@myorg/web#build": {
      "dependsOn": ["^build", "@myorg/db#db:generate"],
      "outputs": [".next/**"],
      "env": ["NEXT_PUBLIC_*"]
    }
  }
}

模板 7：根 package.json 配置

{
  "name": "my-turborepo",
  "private": true,
  "workspaces": [
    "apps/*",
    "packages/*"
  ],
  "scripts": {
    "build": "turbo build",
    "dev": "turbo dev",
    "lint": "turbo lint",
    "test": "turbo test",
    "clean": "turbo clean && rm -rf node_modules",
    "format": "prettier --write \"**/*.{ts,tsx,md}\"",
    "changeset": "changeset",
    "version-packages": "changeset version",
    "release": "turbo build --filter=./packages/* && changeset publish"
  },
  "devDependencies": {
    "turbo": "^1.10.0",
    "prettier": "^3.0.0",
    "@changesets/cli": "^2.26.0"
  },
  "packageManager": "npm@10.0.0"
}

缓存调试

# 干运行查看将执行的任务
turbo build --dry-run

# 带哈希的详细输出
turbo build --verbosity=2

# 显示任务依赖图
turbo build --graph

# 强制禁用缓存
turbo build --force

# 显示缓存状态
turbo build --summarize

# 调试特定任务
TURBO_LOG_VERBOSITY=debug turbo build --filter=@myorg/web

最佳实践

推荐做法

• 定义明确的 inputs — 避免缓存失效
• 使用 workspace 协议 — "@myorg/ui": "workspace:*"
• 启用远程缓存 — 在 CI 和本地之间共享
• 在 CI 中过滤 — 仅构建受影响的包
• 缓存构建产物 — 而非源文件

避免做法

• 不要缓存开发服务器 — 使用 persistent: true
• 不要在 env 中包含密钥 — 使用运行时环境变量
• 不要忽略 dependsOn — 会导致竞态条件
• 不要过度过滤 — 可能遗漏依赖

参考资源

• Turborepo 文档
• 缓存指南
• 远程缓存

限制说明

• 仅在任务明确匹配上述范围时使用本技能
• 不要将输出视为环境特定验证、测试或专家审查的替代品
• 如果缺少所需输入、权限、安全边界或成功标准，请停下来请求澄清