基于lerna与git submodule的monorepo和multirepo的混合开发模式

背景

我们在以前通常情况下，都是采用多代码库管理代码。不同类型，不同项目的代码放在不同的仓库里面，互不影响。我们在解决这类问题，采用了基于lerna monorepo和git submodue混合搭建管理的形式，可以极大提高整体开发协作的效率。

几个重要的概念

Multirepo

是比较传统的做法，即每一个 package 都单独用一个仓库来进行管理。

Monorepo

的全称是 monolithic repository，即单体式仓库，是一种将所有相关的package放在一个repo中的代码管理模式。monorepo的使用场景是多模块相互依赖，或者多个模块有共同依赖的场景。摒弃了传统的多个package多个repo的模式。目前 Babel, React, Angular, Jest等许多开源项目都使用该种模式来管理代码。它解决了多个repo不容易管理，某个模块升级，依赖该模块的其他模块需要手动升级。可以选择公用的npm包安装模块的依赖，减少硬盘占用量。也可以每个模块独立安装npm包依赖。但Monorepo也带来了一些相应的问题，所有package代码集中在一个项目，项目比较大，而且代码都在一起，不想关注不相关代码的人，也能拿到所有的代码，对于非开源项目也存在一定的安全隐患。

Lerna

是一个管理多个 npm 模块的工具，是 Babel 自己用来维护自己的 Monorepo 并开源出的一个项目。优化维护多包的工作流，解决多个包互相依赖，且发布需要手动维护多个包的问题。Lerna 现在已经被很多著名的项目组织使用，如：Babel, React, Vue, Angular, Ember, Meteor, Jest 。

Git submodule

子模块允许你将一个 Git 仓库作为另一个 Git 仓库的子目录。 它能让你将另一个仓库克隆到自己的项目中，同时还保持提交的独立。

常见的几种做法

Multirepo带来的问题

随着公司业务的扩大，相似的业务不断出现，这时常采用的做法是将相似的功能拆成独立的公共组件，不同的业务引用相同的组件。

相似文件修改效率低

对于multirepo一旦项目多起来，就会遇到一些更复杂的情况。即使为代码库创建了脚手架，在一些相似内容的修改上（比如同样的错误处理、同样的多语言文案、同样的 eslint 和 prettier 处理等），也会花费很大的时间，导致效率低下。

项目分散，不便于维护

每次创建一个新项目，这些项目会过于分散，不便管理。

浪费硬盘资源

它们通常会有一些相似的依赖，装在本地，占用大量的磁盘空间（node_module目录通常很大）。

调试麻烦

组件以npm包的形式管理。但是在组件包本身也处于不断的迭代中，开发组件包和独立业务项目的人是同一个人维护，或者独立业务项目依赖多个正在维护的组件包时，会有很差的开发的体验。如果采用npm的方式调试，一旦模块更新，依赖该npm包的项目都需要调试更新。如果在本地进行调试，但这个项目依赖了另一个项目，可以用 npm link 的方式将它 link 到需要调试的项目里面。但是，一旦 link 的项目多了，手动去管理这些 link 操作比较容易出错。

Git submodules

submodules 确实可以解决版本或者迭代更新时，及时拿到代码的问题，但是不足以解决前面说的重复安装依赖的问题。

单一代码库

在项目开发的初期，我们大都用一个代码库。但是随着业务的不断迭代，业务代码会不断的变多，代码库的体积会不断的变大，这时编译会变慢。即使拆开，采用多包管理的情况，从某种程度上解决了代码复用的部分问题，但是还是解决不了代码库本身逐渐变大的问题。代码库权限也不好控制，不管开发多大的功能，所有的代码都需要下载维护。基于lerna的管理可以借助lerna的package管理方式，多个资源共享

总结

一个理想的开发环境可以抽象成这样：“只关注业务，不关注复用方式，调试时所有代码都在源码中。”

实践的具体操作步骤

- 安装lerna

npm install -g lerna

- 创建一个新的git repository

git init lerna-repo && cd lerna-repo

- 初始化一个lerna的仓库

lerna init

- 将该仓库和远程仓库关联（如果有远程仓库，执行这一步）

git remote add origin {git repo}

- 将远程项目作为子模块关联到该项目。所有依赖的组件库都需要变为子模块。

git submodule add {git repo} packages/{folder name}

- 拉取远程仓库代码

git submodule init

- 分别进入每个子模块的开发目录，子模块切换到相应的开发分支上，比如开发分支是dev。

git chekcout dev

- 如果各个包的版本独立管理，需要检查lerna.json文件中version的值时independent。

{ "packages": [ "packages/*" ], "version": "independent" }

- 在lerna项目主目录下，执行建立npm关联

lerna bootstrap

-如果需要各个模块的依赖包统一管理，需要执行加上参数hoist。

lerna bootstrap --hoist

模版项目这时可以用组件库代码中的东西了。如果有些包的内容，不想使用子模块的模式，我们也可以作为普通的模块项目，比如从另外一个项目导入到该项目中

lerna import <pathToRepo>

导入完成后，需要继续执行

lerna bootstrap

总结

子模块和非子模块的项目可以混合在lerna项目中使用，Lerna 还有更多的功能等待着你去发掘，还有很多可以结合 Lerna 一起使用的工具。构建一套完善的仓库管理机制，可能在日常的工作中极大的提高工作效率，节省大量的人力成本。由于大家各自的业务不同，需求点也不尽相同，大家可以前面的分析以及项目的具体需求选择使用，不必千篇一律。