git submodule简单使用

git submodule简单使用

好处： 允许一个git仓库，作为另一个git仓库的子目录，并且保持父项目和子项目相互独立。
1、提取公共的方法或样式，作为私有库给公司各项目使用
2、当项目过大时可以拆分为多个子模块，子模块之间相互独立。
本次主要是从新建项目到上传git，再到submodule的使用
首先是创建项目并上传git

//vue 2.X版本创建项目
vue init webpack  项目名称
//vue 3.创建版本
vue create 项目名称

git上新建项目并上传我们刚才创建的项目。git上创建项目仓库就不写了，网上百度都是的。接下来是将刚创建的项目上传到git上的仓库中
git的简单操作参考

cd 项目文件夹
git init
git add .
git commit -m 修改内容
git branch -M main
git push -uf origin main 

哦吼 基本上这个时间问题就来了 提交不成功报错，为啥子呢 因为main分支权限的问题。可以重新创建分支也可以修改权限。我们选择第一个创建分支

git branch 分支名称
git checkout 分支名称
git add .
git commit -m 修改内容
git remote add origin https://..........
git push -u origin 分支名称

接下来是重点啦，在项目中使用submodule
1、直接添加子模块

git submodule add https://gitlab.com/zcy_hehe/git-tool.git git-tool

2、添加子模块并指定分支

git submodule add -b <branch> <url> <path>
//比如：
git submodule add -b dev https://gitlab.com/zcy_hehe/shop-module.git shop-module

项目中会多出一个git-tool、shop-module以及.gitmodules文件

公共js的使用方式跟日常的文件一致 通过import引入

子页面的使用方法也跟平时一样使用路由

页面效果达到预期~~ 完美

看一下git上有什么变化：

项目的仓库中多了个git-tool和shop-module的仓库地址。可点击
作为同组的小伙伴怎么使用带有submodule子模块的项目呢。
先clone父项目，再初始化submodule，最后更新submodule，初始化只需要做一次，之后每次只需要直接update就可以了，需要注意submodule默认是不在任何分支上的，它指向父项目存储的submodule commit id。

git clone https://github.com/***/mainProject.git mainProject
cd mainProject
git submodule init
git submodule update

更新子模块不成功的时候试一下

git submodule update --init --recursive

修改submodule并更新
1、在主项目中修改submodule：可以看到下图，submodule自身会有个修改内容提交。主项目中有个关于submodule变化的提交。把这些都push到仓库中，其他小伙伴通过以下方式进行更新

git submodule update --init --recursive

2、不在主项目中修改submodule，会发现使用git submodule update --init --recursive进行更新的时候没有用。
方法：从父仓库进入到modules目录（这个目录是submodule生成的比如我的项目是git-tool），调用

git pull //更新当前的子组件

这个时候，打开我们的主项目会发现

然后把这个变化提交并push到仓库里，就能实现子模块的更新。
3、遇到使用分支的子模块更新不成功时,在主项目中查看子模块的当前分支

cd 子模块的文件夹

查看当前子模块的分支发现是在main分支上，跟当前我们引入的分支不同，所以切换分支后再进行更新~~

删除submodule
当工程中不再需要子模块 git-tool时，可以执行以下命令：

git submodule deinit -f git-tool

然后清除缓存

git rm --cached git-tool

最后push到仓库