Git和Maven的子模块简单实践

什么是Git子模块

Git子模块（Git submodules）顾名思义就是一个Git仓库的子目录，可以跟随父目录的开发进度更新。子模块可以使得多个项目分享一些公共代码，同时保证这些公共代码可以被父项目和子项目独立管理，并不会在父项目或子项目中重复存储。

Git子模块的使用

1. 在父项目中添加子模块

git submodule add <子模块URL> <子模块路径>

以上命令将会在父项目中添加一个子模块，其中<子模块URL>表示子模块的远程仓库地址，<子模块路径>表示子模块在父项目中的相对路径。

1. 初始化子模块

git submodule init

以上命令会从远程仓库克隆子模块到父项目的本地。

1. 更新子模块

git submodule update

以上命令会更新子模块的代码，使得子模块中的代码和远程仓库中的代码一致。

Git子模块和Maven项目的组合使用

1. 在Maven项目中添加Git子模块

git submodule add <子模块URL> <你的Maven项目>/src/main/java/com/yourcompany/yourmodule

以上命令将会在Maven项目的源代码目录src/main/java/com/yourcompany/yourmodule/下添加一个子模块，并将子模块与Maven项目一起提交到远程仓库。

1. 在Maven项目中引入Git子模块

在Maven项目的pom.xml文件中添加以下代码：

<dependency>
    <groupId>com.yourcompany</groupId>
    <artifactId>yourmodule</artifactId>
    <version>1.0</version>
    <scope>compile</scope>
</dependency>

以上代码中的com.yourcompany和yourmodule分别对应子模块的groupId和artifactId。

1. 构建和发布Maven项目

执行以下命令构建和发布Maven项目：

mvn clean install

此时Maven项目会自动下载并编译子模块，将子模块打包到Maven项目的jar文件中。

示例 1：在一个Spring Boot项目中添加一个Git子模块

1. 在Spring Boot项目中添加一个Git子模块

git submodule add https://github.com/junit-team/junit.git src/main/java/com/example/junit

以上命令将在Spring Boot项目的源代码目录src/main/java/com/example/junit/下添加一个Git子模块，并将子模块与Spring Boot项目一起提交到远程仓库。

1. 在Spring Boot项目中引入Git子模块

在Spring Boot项目的pom.xml文件中添加以下代码：

<dependency>
    <groupId>org.junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13.2</version>
    <scope>test</scope>
</dependency>

以上代码中的org.junit和junit分别对应子模块的groupId和artifactId。

1. 构建和启动Spring Boot项目

执行以下命令构建和启动Spring Boot项目：

mvn spring-boot:run

此时Spring Boot项目会自动下载并编译子模块，并将子模块打包到Spring Boot项目的jar文件中。

示例 2：在一个Java Web项目中添加一个Git子模块

1. 在Java Web项目中添加一个Git子模块

git submodule add https://github.com/google/gson.git src/main/java/com/example/gson

以上命令将在Java Web项目的源代码目录src/main/java/com/example/gson/下添加一个Git子模块，并将子模块与Java Web项目一起提交到远程仓库。

1. 在Java Web项目中引入Git子模块

在Java Web项目的pom.xml文件中添加以下代码：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.8</version>
    <scope>compile</scope>
</dependency>

以上代码中的com.google.code.gson和gson分别对应子模块的groupId和artifactId。

1. 构建和部署Java Web项目

执行以下命令构建和部署Java Web项目：

mvn clean package

此时Java Web项目会自动下载并编译子模块，并将子模块打包到Java Web项目的war文件中，可以将war文件部署到Tomcat等Web服务器中。