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

2024-05-05 01:36

本文主要是介绍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
│   └── ...
├── .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": "","...": "..."
    }
    
  • 根目录新建packages目录

    mkdir packages
    
  • 新建pnpm-workspace.yaml文件

    touch pnpm-workspace.yaml
    
  • 声明对应的工作区

    # pnpm-workspace.yaml
    packages:# 存放所有项目的目录- 'project/*'# 存放组件的目录- 'components/*'# 组件库使用的示例代码- 'examples/*'# 存放文档- 'docs/**'# 存放公共库(配置文件、工具函数、模版等)- 'shared/**'
    
  • packages目录创建相应的工作区目录以及示例项目

    # 进入`packages`目录
    cd packages
    # 新建`project`工作区
    mkdir project
    # 新建`components`工作区
    mkdir components
    # 新建`examples`工作区
    pnpm create vite examples
    # ...
    
  • 将所有项目用到的共同依赖的dependenciesdevDependencies添加到根目录的package.json中,并在根目录下载依赖到仓库全局锁定,后面创建的项目将沿用这套依赖

    pnpm install -w
    

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


🎯 总结

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


🔐 相关链接

  • pnpm的安装与配置: pnpm的安装与配置(Windows/macOS)

这篇关于Monorepo(单体仓库)与MultiRepo(多仓库): Monorepo 单体仓库开发策略与实践指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/960540

相关文章

redis过期key的删除策略介绍

《redis过期key的删除策略介绍》:本文主要介绍redis过期key的删除策略,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录第一种策略:被动删除第二种策略:定期删除第三种策略:强制删除关于big key的清理UNLINK命令FLUSHALL/FLUSHDB命

Maven如何手动安装依赖到本地仓库

《Maven如何手动安装依赖到本地仓库》:本文主要介绍Maven如何手动安装依赖到本地仓库问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、下载依赖二、安装 JAR 文件到本地仓库三、验证安装四、在项目中使用该依赖1、注意事项2、额外提示总结一、下载依赖登

CentOS7更改默认SSH端口与配置指南

《CentOS7更改默认SSH端口与配置指南》SSH是Linux服务器远程管理的核心工具,其默认监听端口为22,由于端口22众所周知,这也使得服务器容易受到自动化扫描和暴力破解攻击,本文将系统性地介绍... 目录引言为什么要更改 SSH 默认端口?步骤详解:如何更改 Centos 7 的 SSH 默认端口1

SpringBoot多数据源配置完整指南

《SpringBoot多数据源配置完整指南》在复杂的企业应用中,经常需要连接多个数据库,SpringBoot提供了灵活的多数据源配置方式,以下是详细的实现方案,需要的朋友可以参考下... 目录一、基础多数据源配置1. 添加依赖2. 配置多个数据源3. 配置数据源Bean二、JPA多数据源配置1. 配置主数据

python中各种常见文件的读写操作与类型转换详细指南

《python中各种常见文件的读写操作与类型转换详细指南》这篇文章主要为大家详细介绍了python中各种常见文件(txt,xls,csv,sql,二进制文件)的读写操作与类型转换,感兴趣的小伙伴可以跟... 目录1.文件txt读写标准用法1.1写入文件1.2读取文件2. 二进制文件读取3. 大文件读取3.1

SpringBoot中配置Redis连接池的完整指南

《SpringBoot中配置Redis连接池的完整指南》这篇文章主要为大家详细介绍了SpringBoot中配置Redis连接池的完整指南,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以... 目录一、添加依赖二、配置 Redis 连接池三、测试 Redis 操作四、完整示例代码(一)pom.

Java Optional的使用技巧与最佳实践

《JavaOptional的使用技巧与最佳实践》在Java中,Optional是用于优雅处理null的容器类,其核心目标是显式提醒开发者处理空值场景,避免NullPointerExce... 目录一、Optional 的核心用途二、使用技巧与最佳实践三、常见误区与反模式四、替代方案与扩展五、总结在 Java

Linux内核参数配置与验证详细指南

《Linux内核参数配置与验证详细指南》在Linux系统运维和性能优化中,内核参数(sysctl)的配置至关重要,本文主要来聊聊如何配置与验证这些Linux内核参数,希望对大家有一定的帮助... 目录1. 引言2. 内核参数的作用3. 如何设置内核参数3.1 临时设置(重启失效)3.2 永久设置(重启仍生效

Python列表去重的4种核心方法与实战指南详解

《Python列表去重的4种核心方法与实战指南详解》在Python开发中,处理列表数据时经常需要去除重复元素,本文将详细介绍4种最实用的列表去重方法,有需要的小伙伴可以根据自己的需要进行选择... 目录方法1:集合(set)去重法(最快速)方法2:顺序遍历法(保持顺序)方法3:副本删除法(原地修改)方法4:

Spring Boot循环依赖原理、解决方案与最佳实践(全解析)

《SpringBoot循环依赖原理、解决方案与最佳实践(全解析)》循环依赖指两个或多个Bean相互直接或间接引用,形成闭环依赖关系,:本文主要介绍SpringBoot循环依赖原理、解决方案与最... 目录一、循环依赖的本质与危害1.1 什么是循环依赖?1.2 核心危害二、Spring的三级缓存机制2.1 三