基于Lerna/Nx的Monorepo微服务架构技术问询

你的方案不属于最佳实践，反而会引入依赖解析混乱、版本冲突难以排查等问题，原因及替代方案如下：

• 为什么不建议手动整合shared package.json和子包依赖？

  • 手动合并依赖会绕过包管理器的依赖解析逻辑，容易出现同一依赖多版本共存、peer依赖不兼容等问题，排查难度极大。
  • 微服务的运行环境可能存在差异，强行共享所有依赖可能导致某服务因依赖版本更新出现兼容性问题，牵连其他服务。

• 更规范的共享依赖管理方式：

  1. 利用包管理器的Workspace Hoisting机制
     直接在Monorepo根目录的package.json中声明所有共享依赖（如Express、Axios等），子包的package.json仅保留专属依赖（如特定业务SDK、Prisma Client）。npm/yarn/pnpm的Workspace模式会自动将共享依赖提升到根目录的node_modules，子包无需重复安装，更新根目录依赖即可同步所有子包。
  2. 封装共享依赖子包
     若需要严格控制共享依赖的版本和导出内容，可以创建一个shared-deps子包，在其package.json中声明所有共享依赖，然后让各微服务依赖这个子包。更新shared-deps的版本后，所有微服务只需升级该子包的依赖版本即可同步共享依赖，同时能避免版本冲突。
  3. 专属依赖的处理
     像Prisma Client这类与服务自身强绑定的依赖，必须放在对应子包的package.json中，因为它需要与子包内的Prisma Schema匹配，无法跨服务共享。

可以通过单个工作流实现按需构建，同时不建议将子包移到根目录，具体方案如下：

不建议移子包到根目录的弊端 #

• 根目录会充斥大量子包文件，结构混乱，后续扩展新服务时容易出现文件名冲突。
• 丢失Monorepo的模块化优势，难以维护子包之间的依赖关系和版本管理。
• CI/CD的缓存策略会失效，根目录的node_modules和构建产物无法按子包隔离，缓存命中率极低。

简洁版统一工作流实现 #

利用GitHub Actions的路径过滤+脚本判断受影响的包，示例工作流如下：

name: Monorepo CI
on:
  pull_request:
    branches: [main]

jobs:
  detect-changes:
    runs-on: ubuntu-latest
    outputs:
      changed-services: ${{ steps.filter.outputs.changed-services }}
      shared-changed: ${{ steps.filter.outputs.shared-changed }}
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0 # 拉取所有历史用于对比变更

      - name: Detect changed packages
        id: filter
        run: |
          # 检测shared目录是否变更
          if git diff --name-only ${{ github.base_ref }} ${{ github.head_ref }} | grep -q 'packages/shared/'; then
            echo "shared-changed=true" >> $GITHUB_OUTPUT
            # 若shared变更，所有服务都需要构建
            echo "changed-services=$(ls packages | grep -v shared | tr '\n' ',' | sed 's/,$//')" >> $GITHUB_OUTPUT
          else
            # 仅获取有变更的微服务
            changed=$(git diff --name-only ${{ github.base_ref }} ${{ github.head_ref }} | grep 'packages/' | cut -d'/' -f2 | uniq | tr '\n' ',' | sed 's/,$//')
            echo "changed-services=$changed" >> $GITHUB_OUTPUT
            echo "shared-changed=false" >> $GITHUB_OUTPUT
          fi

  build-and-deploy:
    needs: detect-changes
    runs-on: ubuntu-latest
    strategy:
      matrix:
        service: ${{ fromJson('["' + replace(needs.detect-changes.outputs.changed-services, ',', '","') + '"]') }}
    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
          cache: 'npm'

      - name: Install dependencies
        run: npm install # 根目录安装，利用Workspace hoisting

      - name: Build service
        run: cd packages/${{ matrix.service }} && npm run build

      # 这里添加部署步骤，比如docker build、推送到镜像仓库等
      - name: Deploy service
        run: |
          echo "Deploying ${{ matrix.service }}..."
          # 替换为你的部署命令

进阶版（基于NX/Lerna） #

如果你用的是NX，可以直接用官方的nx-affected命令自动检测受影响的包，无需手动写脚本：

name: NX Monorepo CI
on: pull_request

jobs:
  affected:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm install
      - name: Run affected builds
        run: npx nx affected --target=build --base=origin/main --head=HEAD
      - name: Run affected deployments
        run: npx nx affected --target=deploy --base=origin/main --head=HEAD

NX会自动分析代码变更，仅构建和部署受影响的服务；如果shared包变更，所有依赖它的服务都会被标记为受影响，自动触发构建。

内容的提问来源于stack exchange，提问作者aaacafe