SST框架中的Monorepo项目配置指南

什么是Monorepo架构

Monorepo(单一代码仓库)是一种软件开发策略，它将多个相关项目的代码存储在同一个版本控制仓库中。与传统的多仓库(multi-repo)方法相比，Monorepo提供了诸多优势：

1. 代码共享更便捷：不同项目间可以轻松共享公共代码和工具
2. 依赖管理简化：所有项目使用相同版本的依赖项，避免版本冲突
3. 跨项目变更更安全：修改可以同时应用于多个项目，并确保一致性
4. 统一构建和测试：可以设置统一的CI/CD流程

为什么在SST中使用Monorepo

SST(Serverless Stack Toolkit)是一个用于构建无服务器应用的框架。在复杂应用中，我们经常需要将前端、后端、基础设施等不同部分组织在一起。使用Monorepo可以：

• 保持前后端代码同步更新
• 简化跨服务的基础设施配置
• 实现端到端的本地开发和测试
• 统一发布流程

SST Monorepo项目结构

一个典型的SST Monorepo项目结构如下：

monorepo/
├── packages/
│   ├── frontend/      # 前端应用
│   ├── backend/       # 后端服务
│   └── core/         # 共享代码
├── services/         # SST基础设施定义
│   └── my-service/
│       ├── stacks/    # SST堆栈定义
│       └── sst.config.ts
├── package.json      # 根package.json
└── turbo.json        # Turborepo配置

配置SST Monorepo的步骤

1. 初始化项目

使用SST提供的Monorepo模板快速开始：

npx create-sst@latest --template monorepo

2. 配置工作区

在根目录的package.json中定义工作区：

{
  "workspaces": [
    "packages/*",
    "services/*"
  ]
}

3. 设置SST配置

在服务目录下的sst.config.ts中配置：

import { SSTConfig } from "sst";
import { API } from "./stacks/MyStack";

export default {
  config(_input) {
    return {
      name: "my-monorepo",
      region: "us-east-1",
    };
  },
  stacks(app) {
    app.stack(API);
  }
} satisfies SSTConfig;

4. 配置构建工具

推荐使用Turborepo进行Monorepo构建优化。在turbo.json中：

{
  "pipeline": {
    "build": {
      "dependsOn": ["^build"],
      "outputs": ["dist/**"]
    },
    "deploy": {
      "dependsOn": ["build"],
      "env": ["AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY"]
    }
  }
}

开发工作流

本地开发

启动SST本地开发环境：

cd services/my-service
npx sst dev

运行前端

在另一个终端中启动前端开发服务器：

cd packages/frontend
npm run dev

构建和发布

使用Turborepo运行构建和发布：

npx turbo run build deploy

最佳实践

1. 清晰的包边界：明确定义每个包的职责范围
2. 最小化共享：只共享真正需要复用的代码
3. 版本控制：考虑使用changesets管理包版本
4. 依赖管理：定期更新依赖并保持一致性
5. 测试策略：设置端到端测试确保跨包变更的安全性

常见问题解决

依赖冲突

如果遇到依赖冲突，可以：

1. 提升冲突依赖到根package.json
2. 使用resolutions字段强制特定版本
3. 重构代码减少依赖耦合

构建性能

优化构建性能的方法：

1. 使用Turborepo缓存
2. 并行化构建任务
3. 增量构建
4. 按需构建

通过合理配置Monorepo，可以显著提升SST项目的开发效率和可维护性，特别适合中大型无服务器应用项目。