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

相关文章

JDK21对虚拟线程的几种用法实践指南

《JDK21对虚拟线程的几种用法实践指南》虚拟线程是Java中的一种轻量级线程,由JVM管理,特别适合于I/O密集型任务,:本文主要介绍JDK21对虚拟线程的几种用法,文中通过代码介绍的非常详细,... 目录一、参考官方文档二、什么是虚拟线程三、几种用法1、Thread.ofVirtual().start(

从基础到高级详解Go语言中错误处理的实践指南

《从基础到高级详解Go语言中错误处理的实践指南》Go语言采用了一种独特而明确的错误处理哲学,与其他主流编程语言形成鲜明对比,本文将为大家详细介绍Go语言中错误处理详细方法,希望对大家有所帮助... 目录1 Go 错误处理哲学与核心机制1.1 错误接口设计1.2 错误与异常的区别2 错误创建与检查2.1 基础

一文详解Python如何开发游戏

《一文详解Python如何开发游戏》Python是一种非常流行的编程语言,也可以用来开发游戏模组,:本文主要介绍Python如何开发游戏的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、python简介二、Python 开发 2D 游戏的优劣势优势缺点三、Python 开发 3D

基于Python开发Windows自动更新控制工具

《基于Python开发Windows自动更新控制工具》在当今数字化时代,操作系统更新已成为计算机维护的重要组成部分,本文介绍一款基于Python和PyQt5的Windows自动更新控制工具,有需要的可... 目录设计原理与技术实现系统架构概述数学建模工具界面完整代码实现技术深度分析多层级控制理论服务层控制注

前端缓存策略的自解方案全解析

《前端缓存策略的自解方案全解析》缓存从来都是前端的一个痛点,很多前端搞不清楚缓存到底是何物,:本文主要介绍前端缓存的自解方案,文中通过代码介绍的非常详细,需要的朋友可以参考下... 目录一、为什么“清缓存”成了技术圈的梗二、先给缓存“把个脉”:浏览器到底缓存了谁?三、设计思路:把“发版”做成“自愈”四、代码

springboot依靠security实现digest认证的实践

《springboot依靠security实现digest认证的实践》HTTP摘要认证通过加密参数(如nonce、response)验证身份,避免明文传输,但存在密码存储风险,相比基本认证更安全,却因... 目录概述参数Demopom.XML依赖Digest1Application.JavaMyPasswo

使用Java填充Word模板的操作指南

《使用Java填充Word模板的操作指南》本文介绍了Java填充Word模板的实现方法,包括文本、列表和复选框的填充,首先通过Word域功能设置模板变量,然后使用poi-tl、aspose-words... 目录前言一、设置word模板普通字段列表字段复选框二、代码1. 引入POM2. 模板放入项目3.代码

分析 Java Stream 的 peek使用实践与副作用处理方案

《分析JavaStream的peek使用实践与副作用处理方案》StreamAPI的peek操作是中间操作,用于观察元素但不终止流,其副作用风险包括线程安全、顺序混乱及性能问题,合理使用场景有限... 目录一、peek 操作的本质:有状态的中间操作二、副作用的定义与风险场景1. 并行流下的线程安全问题2. 顺

Java 结构化并发Structured Concurrency实践举例

《Java结构化并发StructuredConcurrency实践举例》Java21结构化并发通过作用域和任务句柄统一管理并发生命周期,解决线程泄漏与任务追踪问题,提升代码安全性和可观测性,其核心... 目录一、结构化并发的核心概念与设计目标二、结构化并发的核心组件(一)作用域(Scopes)(二)任务句柄

Java中的Schema校验技术与实践示例详解

《Java中的Schema校验技术与实践示例详解》本主题详细介绍了在Java环境下进行XMLSchema和JSONSchema校验的方法,包括使用JAXP、JAXB以及专门的JSON校验库等技术,本文... 目录1. XML和jsON的Schema校验概念1.1 XML和JSON校验的必要性1.2 Sche