Monorepo、Lerna、Yarn Workspaces、pnpm Workspaces 用法

Monorepo 介绍

Monorepo是一种方案，而非具体的工具。

Monorepo指的是将多个相关的项目或模块放在同一个代码仓库中进行管理的方式。这种方案有以下优点：

• 方便代码共享：不同项目或模块之间可以方便地共享代码、组件、工具函数等，避免了重复开发。
• 统一管理：对所有项目的依赖、构建、测试、发布等流程可以进行统一的配置和管理，提高了工作效率，减少了配置的重复性和不一致性。
• 便于版本控制：所有项目的版本历史都集中在一个仓库中，便于追溯和管理项目之间的依赖关系和版本演进。

实现Monorepo方案可以借助一些工具，如Lerna、Yarn Workspaces、pnpm Workspaces等，它们可以帮助开发者更高效地管理Monorepo中的多个项目，比如处理依赖管理、脚本执行、版本发布等任务。

Monorepo 的优缺点

Monorepo是一种将多个相关项目存放在同一个代码仓库中的管理方式，以下是其优缺点：

优点

• 代码共享便捷：多个项目位于同一仓库，不同项目或模块间可轻松共享代码、组件、工具函数等。例如，一个大型互联网公司开发多个前端应用，有通用的UI组件库，在Monorepo中，各应用可直接引用组件库代码，避免重复开发，提高开发效率。
• 统一管理高效：对所有项目的依赖、构建、测试、发布等流程能进行统一配置与管理。以一个包含多个微服务的后端项目为例，使用Monorepo可在根目录统一配置构建脚本、测试框架和发布流程，确保各微服务的构建和发布规范一致，减少配置错误和不一致性。
• 版本控制有序：所有项目的版本历史集中在一个仓库，便于追溯项目间的依赖关系和版本演进。如一个软件系统包含多个相互关联的模块，在Monorepo中，可清晰查看每个模块的版本变化以及它们之间的相互影响，便于进行版本管理和问题排查。
• 依赖管理优化：可在根目录统一管理公共依赖，避免多个项目重复安装相同依赖，节省磁盘空间和安装时间。例如，多个JavaScript项目都依赖React和Redux，在Monorepo中可在根目录安装这些公共依赖，各项目通过链接引用，减少了依赖安装的冗余。

缺点

• 仓库体积庞大：随着项目不断增加和代码量积累，仓库体积会迅速增大，导致克隆、拉取和推送代码的时间变长。对于一些网络条件不佳或本地存储有限的开发者，这会严重影响开发效率。例如，一个包含大量历史版本和大型文件的Monorepo，新开发者首次克隆仓库可能需要较长时间。
• 权限管理复杂：由于多个项目在同一仓库，权限管理需更精细。不同项目可能有不同的访问权限要求，设置和管理这些权限会比较复杂。比如，一个公司的Monorepo包含多个业务线的项目，不同业务线的开发人员对各自项目有读写权限，对其他项目只有只读权限，配置和维护这些权限规则较为繁琐。
• 构建和测试耗时：当一个项目发生变化时，可能需要重新构建和测试整个Monorepo中的所有项目，导致构建和测试时间过长。特别是对于包含多个大型项目的Monorepo，一次完整的构建和测试可能需要数十分钟甚至更长时间，影响开发效率和反馈速度。
• 学习成本较高：新开发者需要了解整个Monorepo的结构、配置和管理方式，学习成本相对较高。例如，新加入团队的开发者不仅要熟悉自己负责的项目，还需了解Monorepo的整体架构、依赖管理机制、脚本执行流程等，才能进行有效的开发和协作。

Lerna

Monorepo

定义

Monorepo 即单仓库，是一种项目管理策略，它将多个相关的项目或包存放在同一个代码仓库中。与之相对的是 Polyrepo（多仓库），即每个项目或包分别存放在独立的代码仓库。

特点

• 代码共享便捷：在 Monorepo 中，不同项目或包之间可以轻松地共享代码。例如，多个前端项目可能会共享一些通用的工具函数、组件等，将这些公共代码放在同一个仓库中，各个项目可以直接引用，避免了代码的重复编写和维护。
• 统一管理：所有项目的构建、测试、部署等流程可以进行统一管理。比如，使用相同的构建工具和配置，能减少因配置不一致导致的问题，提高开发效率。
• 版本一致性：由于所有项目都在同一个仓库中，可以更方便地保证各个项目之间的版本一致性。在进行版本升级或修复 bug 时，可以一次性对所有相关项目进行处理。

适用场景

• 大型项目或团队：对于大型的前端项目或者有多个相关项目的团队，采用 Monorepo 可以更好地管理代码和协调开发进度。例如，一个公司有多个前端应用，这些应用可能使用相同的技术栈和组件库，将它们放在同一个仓库中可以方便管理和维护。
• 需要频繁协作的项目：当多个项目之间需要频繁进行交互和协作时，Monorepo 可以提供更好的开发体验。开发人员可以在同一个仓库中对多个项目进行修改和测试，减少了跨仓库开发的复杂性。

Lerna

定义

Lerna 是一个用于管理包含多个包（package）的 JavaScript 项目的工具，专门为 Monorepo 设计。它可以帮助开发者更高效地管理 Monorepo 中的多个包，提供了一系列命令来处理包的版本管理、发布、依赖安装等操作。

主要功能

• 版本管理：Lerna 可以自动管理 Monorepo 中各个包的版本。当对某个包进行修改后，Lerna 可以根据修改的内容自动更新包的版本号，并生成相应的变更日志。例如，使用 lerna version 命令可以交互式地更新包的版本。
• 发布管理：Lerna 简化了包的发布流程。它可以自动将更新后的包发布到 npm 等包管理平台。通过 lerna publish 命令，Lerna 会自动检测哪些包有更新，然后依次发布这些包。
• 依赖管理：Lerna 可以帮助管理 Monorepo 中各个包之间的依赖关系。它支持在仓库内部的包之间建立软链接，使得在开发过程中可以实时看到依赖包的修改，无需频繁发布和安装依赖包。

工作模式

• 固定模式（Fixed/Locked Mode）：这是 Lerna 的默认模式。在这种模式下，所有包的版本号会保持一致。当对任何一个包进行修改并发布时，所有包的版本号都会更新。这种模式适合那些各个包之间紧密关联、需要保持版本同步的项目。
• 独立模式（Independent Mode）：在独立模式下，每个包可以有自己独立的版本号。开发者可以根据需要单独更新某个包的版本，而不会影响其他包的版本。这种模式适合那些各个包之间相对独立、版本更新频率不同的项目。

适用场景

• 管理多个相关的 npm 包：如果你的项目包含多个需要发布到 npm 的包，并且这些包之间存在一定的关联，Lerna 可以帮助你更方便地管理这些包的开发、版本和发布。
• 提高开发效率：对于大型的 Monorepo 项目，使用 Lerna 可以减少手动管理的工作量，提高开发效率。例如，自动处理版本更新、依赖安装和发布流程，让开发者可以更专注于代码的编写。

除了 Lerna，还有不少用于管理 Monorepo 的工具，以下为你介绍一些常见的：

Yarn Workspaces

• 简介：Yarn Workspaces 是 Yarn 包管理工具自带的功能，可用于管理包含多个包的 Monorepo。它借助 Yarn 的能力，实现依赖管理、脚本执行等功能。
• 特点
  • 简单集成：与 Yarn 深度集成，若项目本身使用 Yarn，就能直接使用 Workspaces，无需额外安装工具。
  • 高效依赖管理：能避免在 Monorepo 中重复安装相同的依赖，节省磁盘空间和安装时间。例如，多个子包依赖同一个版本的 React，Workspaces 只会安装一次。
  • 内部链接管理：自动在子包间创建符号链接，让包之间的引用更便捷。开发时修改一个包，其他依赖该包的子包能立即感知。
• 适用场景：适合已采用 Yarn 作为包管理工具，且希望以简单方式管理 Monorepo 依赖和项目结构的团队。

pnpm Workspaces

• 简介：pnpm 包管理工具提供的 Workspaces 功能，用于高效管理 Monorepo 项目。
• 特点
  • 节省磁盘空间：pnpm 采用硬链接和符号链接管理依赖，在 Workspaces 中能进一步优化磁盘使用，避免依赖重复存储。
  • 快速安装：基于 pnpm 的高效算法，依赖安装速度快，尤其是在大型 Monorepo 中优势明显。
  • 隔离性与一致性：保证每个子包的依赖隔离，同时能确保所有子包使用的依赖版本一致。
• 适用场景：适用于磁盘空间有限、对依赖安装速度有高要求的 Monorepo 项目，特别是前端项目。

Turborepo

• 简介：一个高性能的构建系统，专注于加速 Monorepo 中的构建和测试流程。
• 特点
  • 并行执行：分析任务依赖关系，并行执行不相互依赖的任务，显著缩短构建时间。例如，多个子包的构建任务可同时进行。
  • 缓存机制：对任务执行结果进行缓存，下次执行相同任务时，若输入未变，可直接使用缓存结果，避免重复工作。
  • 跨语言支持：不仅支持 JavaScript 和 TypeScript 项目，还能与其他编程语言和工具集成，适用范围广。
• 适用场景：适合有大量构建和测试任务的大型 Monorepo 项目，尤其是需要频繁进行代码构建和测试的场景。

Rush

• 简介：由微软开发的用于管理大型 Monorepo 的工具，旨在解决企业级项目中的复杂依赖和构建问题。
• 特点
  • 严格的版本控制：提供精细的版本控制机制，确保所有子包的依赖版本一致，避免版本冲突。
  • 安全可靠：在处理依赖安装和更新时，有严格的安全检查机制，降低引入不安全依赖的风险。
  • 可扩展性：支持自定义插件和脚本，能根据企业的特定需求进行扩展和定制。
• 适用场景：适用于企业级的大型 Monorepo 项目，对代码质量、安全性和版本控制有严格要求的场景。
  Monorepo 是一种将多个项目放在一个代码仓库进行管理的模式，以下几种工具及模式在管理多项目方面和 Monorepo 有相似之处，但也各有特点：

有类似Monorepo 的方案吗

1. Polyrepo（多仓库模式）

• 简介：和 Monorepo 相反，Polyrepo 将每个项目单独存放在不同的代码仓库中。每个项目有自己独立的版本控制、依赖管理和构建流程。
• 特点
  • 独立性强：各个项目相互隔离，一个项目的问题不会影响其他项目。例如，一个前端项目和一个后端项目分别存放在不同仓库，前端项目的构建失败不会影响后端项目的开发和部署。
  • 权限管理灵活：可以针对每个仓库设置不同的访问权限，适合不同团队或角色对不同项目进行管理。
  • 依赖管理分散：每个项目需要单独管理自己的依赖，可能会导致依赖版本不一致的问题。
• 适用场景：适用于项目之间关联性较弱、需要不同开发团队独立管理的场景。

2. Bazel

• 简介：由 Google 开发的开源构建和测试工具，支持多种编程语言，可用于管理大型代码库和多个项目。
• 特点
  • 高效构建：采用增量构建和缓存机制，只有当代码发生变化时才会重新构建受影响的部分，大大提高了构建效率。
  • 跨语言支持：支持多种编程语言，如 Java、Python、C++ 等，可以在一个项目中混合使用不同语言进行开发。
  • 可扩展性：可以通过编写自定义规则来扩展其功能，满足不同项目的需求。
• 适用场景：适用于大型的、跨语言的项目，特别是对构建速度和效率有较高要求的项目。

3. Buck

• 简介：Facebook 开发的一款快速构建系统，主要用于 Android 和 iOS 应用的开发，但也支持其他编程语言。
• 特点
  • 快速构建：通过并行构建和增量构建技术，能够快速编译和打包项目。
  • 依赖分析：可以精确分析项目之间的依赖关系，只构建受影响的部分。
  • 与 Facebook 生态集成：在 Facebook 内部广泛使用，与 Facebook 的其他工具和库有良好的集成。
• 适用场景：适用于移动应用开发项目，特别是基于 Android 和 iOS 平台的项目。

4. Gradle

• 简介：一种强大的构建自动化工具，广泛用于 Java、Kotlin 等项目的构建和依赖管理。它也可以用于管理多个子项目。
• 特点
  • 灵活配置：使用 Groovy 或 Kotlin 作为配置语言，允许开发者根据项目需求进行灵活的配置。
  • 依赖管理：支持多种依赖管理方式，包括 Maven 和 Ivy 仓库。
  • 多项目构建：可以轻松管理多个子项目，定义项目之间的依赖关系和构建顺序。
• 适用场景：适用于 Java 和 Kotlin 项目，特别是需要管理多个模块或子项目的大型项目。