Monorepo(单体仓库)与MultiRepo(多仓库): Monorepo 单体仓库开发策略与实践指南

简介: Monorepo(单体仓库)与MultiRepo(多仓库): Monorepo 单体仓库开发策略与实践指南

🌟 引言

软件开发的浩瀚宇宙里,选择合适的代码管理方式是构建高效开发环境的关键一步。今天,我们将深入探讨两大策略——Monorepo(单体仓库)与MultiRepo(多仓库),并通过使用现代化的包管理工具 pnpm,手把手搭建一个功能完善的 Monorepo 仓库。✨

🌱 Monorepo 与 MultiRepo:各显神通

上图为MultirepoMonorepo对比图,从图中我们可以简要归纳:

  • Multirepo是由多个仓库组成的项目管理方式,每个仓库有着独立的工作流、组件与配置
  • Monorepo则将不同仓库整合成为一个仓库,并共享工作流、组件与配置。

🌲 Monorepo:统一即是力量

Monorepo——如同一棵枝繁叶茂的智慧之树,每个分支(项目或模块)紧紧依附于主干,共享着同一片沃土(基础配置)与养分供给(依赖库)👑

  • 🌈 优点
  • 集中的管理: 🤝 统一的依赖、工具链,简化维护与升级。
  • 代码共享: 🔄 跨项目复用代码,减少重复劳动。
  • 协同作战: 👥 提升团队间的并行开发效率与代码审查质量。
  • 🔥 挑战
  • 仓库膨胀: 📦 随着项目增多,仓库体积可能庞大,影响克隆速度。
  • 权限分层: 🔒 需精细权限控制,防止信息误触。

🌳 MultiRepo:独立自主的花园

MultiRepo——设想一系列精致的花坛,每一处都是独立的世界,拥有自己的气候(配置)与植被(代码)。🌸

  • 🌟 优点
  • 清晰边界: 🛡️ 每个项目界限分明,便于独立管理和部署。
  • 轻便灵活: 💨 小型仓库,克隆快,利于新手上手。
  • 工具自由: 🛠️ 各项目可选最适合的工具链和流程。
  • 🔥 挑战
  • 依赖分歧: 💔 版本不一致,管理复杂度上升。
  • 共享难题: 🔀 共享代码需额外机制,如私有包管理。

选择Monorepo还是MultiRepo,犹如在协作效率与独立灵活性之间寻找平衡点。🎯

总结来说,monorepo倾向于**增强协作和代码一致性,而multirepo则更强调项目独立性和简单性**。选择哪种模式取决于具体团队规模、项目间关联程度、基础设施支持等因素。

在github上我们可以看见无论是element plusAnt design以及vue,以及其他社区开源的项目都是使用的monorepo 方案来管理他们的项目


📊 Monorepo 目录结构概览

一个健康的Monorepo,其目录结构应清晰有序,如下所示:

root
├── .husky       # Git钩子,自动化代码检查
├── node_modules # 依赖存放
├── packages     # 各项目或包的集合
│   ├── proj1    # 项目1
│   ├── proj2    # 项目2
│   └── ...
├── docs     # 文档
├── ...   # 其他包
├── .cz-config.js # 提交信息格式化
├── .gitignore   # Git忽略规则
├── .prettierrc.js # Prettier格式化配置
├── pnpm-workspace.yaml # pnpm工作区配置
└── README.md    # 项目总览

🛠️ 搭建 Monorepo

🚀 pnpm-原生支持Workspaces

选用pnpm作为Monorepo项目中的包管理器主要有以下几个理由:

🎯 硬链接与缓存机制

  • pnpm使用硬链接和符号链接(软链接)来避免在磁盘上重复存储同一依赖的不同副本,显著减少存储空间占用。
  • 它还引入了内容寻址存储(CAS)的概念,只存储唯一的内容块,从而优化了存储和下载效率。

🎯 更快的速度与更低的磁盘占用

  • 由于依赖的共享和链接机制,安装和更新依赖时的速度更快,尤其是对于包含大量重复依赖的Monorepo项目,优势更加明显。
  • 即使在大型项目中,也能保持良好的性能和较低的磁盘占用。

🎯 原生支持Workspace

  • pnpm natively支持Workspaces(类似于yarn workspaces),只需简单的配置就可以轻松管理多个包或项目,这些项目可以在一个仓库中共享依赖。

🎯 扁平化依赖结构

  • pnpm保证了依赖树的扁平化,但同时也保持了依赖包之间的隔离,降低了版本冲突的可能性。

🎯 简洁的CLI工具

  • pnpm提供的 CLI 工具对于Monorepo的日常管理任务(如安装、更新、清理依赖)十分友好,可以直接在多个项目中执行命令。

🎯 生态系统兼容性

  • pnpmnpm生态系统的兼容性很高,能够无缝对接大部分支持npm/yarn的工具和流程。

因此,在构建和维护Monorepo时,pnpm凭借其高效的空间利用、快速的依赖管理以及对多项目工作区的良好支持,成为了一个理想的选择。尤其在需要频繁交互和更新多个项目共享依赖的场景下,pnpm的优势尤为突出。

🔥 Monorepo中pnpm常用命令

  • 安装/添加依赖
# 在所有工作区内安装全局依赖
pnpm add <dependency> -w
# 在单个工作区内安装依赖
pnpm add <dependency> -w <workspace-name>
# 安装本地工作区间的依赖
pnpm add <workspace-package>@workspace:<workspace-name>
  • 更新依赖
# 更新所有工作区的依赖
pnpm update -w
# 更新单个工作区的依赖
pnpm update -w <workspace-name>
  • 清理无用依赖
# 移除未在package.json中声明的依赖
pnpm prune -w
# 清理缓存
pnpm cache clean
  • 列出工作区依赖
# 显示所有工作区及其依赖关系
pnpm list -a
# 显示单个工作区的依赖树
pnpm list -w <workspace-name>

🔩 创建Monorepo

  • 初始化
pnpm init
  • 修改package.json的信息
{
    "name": "仓库名称",
    "version": "1.0.0",
    "description": "",
    "...": "..."
}
  • 新建pnpm-workspace.yaml文件
touch pnpm-workspace.yaml
  • 声明对应的工作区
# pnpm-workspace.yaml
packages:
  # 主包 存放所有项目的目录
  - 'packages/**'
    # 存放组件的目录
    - 'components/*'
    # 组件库使用的示例代码
    - 'examples/*'
    # 存放文档
    - 'docs/**'
    # 存放公共库(配置文件、工具函数、模版等)
    - 'shared/**'
  • 在根目录创建相应的工作区目录以及示例项目
# 新建`packages`目录
mkdir packages
# 新建`project`工作区
mkdir project
# 新建`components`工作区
mkdir components
# 新建`examples`工作区
pnpm create vite examples
# ...
  • 将所有项目用到的共同依赖的dependenciesdevDependencies添加到根目录的package.json中,并在根目录下载依赖到仓库全局锁定,后面创建的项目将沿用这套依赖
pnpm install -w

到此,monorepo已经准备就绪,接下来就可以进行仓库的eslintprettiercommitlinthusky等代码规范以及提交规范的配置了。


🎯 总结

Monorepo策略通过pnpm的高效管理,实现了代码库的集中与共享,极大提升了大型项目或团队的协同效率。从目录结构规划到依赖管理,每一步都旨在构建一个既强大又灵活的开发环境。无论你是初创项目还是成熟团队,掌握Monorepo的构建与管理,都将是你软件开发之旅的强大助力。🚀


🔐 相关链接

目录
相关文章
|
6月前
|
供应链
怎么样才能更好的管理仓库?
在数字化转型的趋势下,仓库管理方面迎来智能化改革。作为现代供应链管理中重要的一环,传统的仓库管理模式也要紧跟时代步伐,实现仓配一体化,有效控制仓库风险,提升企业精益化管理水平,创造更大的价值。
41 1
|
5月前
|
前端开发 Java 开发工具
JeecgBoot v3.7.0 all 版本发布,前后端合并一个仓库
合并前端源码和后端源码到一个 git 仓库,修复几个已知严重 bug。
67 2
|
Cloud Native 数据安全/隐私保护 Docker
微服务轮子项目(41) -Docker私有镜像仓库
微服务轮子项目(41) -Docker私有镜像仓库
119 0
|
6月前
|
JavaScript Java API
云效问题之流水线使用npm制品仓库构建拉取依赖特别慢如何解决
云效仓库是阿里云提供的代码托管和版本控制服务,支持Git等多种版本管理工具;本合集聚焦于云效仓库的使用技巧、团队协作流程以及常见问题解答,旨在帮助开发者更高效地进行代码管理和协作开发。
331 0
|
jenkins 网络安全 持续交付
微服务轮子项目(44) -GitLab代码仓库
微服务轮子项目(44) -GitLab代码仓库
103 0
|
网络协议 Java 应用服务中间件
Docker实战 | 第二篇:IDEA集成Docker插件实现一键自动打包部署微服务项目,一劳永逸的技术手段值得一试
Docker实战 | 第二篇:IDEA集成Docker插件实现一键自动打包部署微服务项目,一劳永逸的技术手段值得一试
|
运维 供应链 前端开发
化繁为简,如何快速实现企业级私有 npm 包依赖管理服务?
化繁为简,如何快速实现企业级私有 npm 包依赖管理服务?
134 0
|
前端开发 测试技术 持续交付
基于 Git 的开发工作流——主干开发特性总结
基于 Git 的开发工作流——主干开发特性总结
290 0
|
前端开发 Java 关系型数据库
【Docker】基于实例项目的集群部署(二)部署项目实例介绍与搭建 | 前后端分离项目
【Docker】基于实例项目的集群部署(二)部署项目实例介绍与搭建 | 前后端分离项目
180 0
【Docker】基于实例项目的集群部署(二)部署项目实例介绍与搭建 | 前后端分离项目
|
Java Maven 微服务
微服务项目中maven依赖引入失败爆红问题解决方案
微服务中maven中标签dependencyManagement依赖引入失败的原因解决方案
645 0
微服务项目中maven依赖引入失败爆红问题解决方案