maven构建多模块项目

一、问题描述

很多时候后端的项目都会拆分成多模块:api、service、mapper、pojo、common,所以需要使用maven构建多模块项目，由于惯于使用gradle而不熟悉maven，在构建多模块的项目时出现很多问题，一并书之

二、 过程

1. 创建maven项目(直接创建个文件夹加个pom.xml也行)，作为业务模块的父模块，并聚合所有模块
   pom.xml如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--因为是springboot项目，所有继承springboot提供的父项目-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.originit</groupId>
    <artifactId>product</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>product</name>
    <description>商品服务</description>
    <packaging>pom</packaging>

	<!--定义相关的常量-->
    <properties>
        <java.version>1.8</java.version>
        <kotlin.version>1.3.71</kotlin.version>
        <spring-cloud.version>Hoxton.SR4</spring-cloud.version>
    </properties>

	<!--所有业务模块以来common模块-->
    <dependencies>
        <dependency>
            <groupId>com.originit</groupId>
            <artifactId>product-common</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

	<!--这里是项目使用了spring-cloud,对springcloud的以来版本进行统一管理-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

	
    <modules>
        <module>api</module>
        <module>service</module>
        <module>mapper</module>
        <module>pojo</module>
        <module>common</module>
    </modules>

</project>

以上配置聚合了所有模块，同时可以将业务模块的公共依赖加入dependencies，而不需要每一个都写一遍，spring相关的配置可以忽略，如果对dependencyManagement有疑问，可以参考该文章

2. 创建业务模块和common模块，并编写pom.xml
   需要注意，common模块一般不继承外部的父项目，当然也可以去继承，
   其他的模块也是根据需求去选择是否继承
   pom.xml如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<!-- 如果继承这里就有 -->
	  <parent>
        <groupId>com.originit</groupId>
        <artifactId>product</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.originit</groupId>
    <artifactId>product-common</artifactId>
    <name>product-common</name>
    <version>0.0.1-SNAPSHOT</version>
    <description>商品服务公共模块</description>

	<!--需要用到的依赖 -->
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.10</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
    </dependencies>

</project>

将所有模块创建完成之后就可以了，可以最后在父项目的根目录执行一下以下命令:

mvn clean install

三、个人理解

1. 继承与聚合

• 首先继承的目的是为了复用和统一，复用一些公共依赖，比如lombok。统一则在springboot项目中使用较多，统一springboot各个starter的版本号，如果不需要这两者，则无需继承
• 聚合则是将几个项目聚在一起，一起操作，比如执行clean命令，这么多个模块，一个个执行，肯定是很浪费时间的，聚合之后直接在父项目执行，即可让几个项目都执行，这在install的时候特别好用

2. 安装(install)
   我以前是使用gradle的，gradle没有install的概念，可以直接依赖其他项目，但是maven需要先将项目打包，放到本地的maven仓库，其他项目才能够通过dependency依赖，同时如果被依赖的项目有更新，更新并不会同步到依赖他的项目，只有重新执行install才能获得更新
3. 模块化的疑问

• 这种模式的模块化相对来讲个人认为非常的不合理，因为各模块之间的依赖太严重了，我依赖你，你依赖他。
• 如果是多人合作，即使各模块都面向接口编程并使用mockito测试去保证正确性，沟通的成本也大大增加，而且如果没有严格的单元测试，错误的概率也会大很多。
• 如果是个人写项目，单模块他不香吗？多模块打开个文件夹都要点半天…
• 我是学安卓过来的，在安卓中，是直接按功能去拆分模块，一个整体的功能就是一个模块，一个人去单独完成，比如购物网站，有个人信息模块、订单模块、商品模块等等，各模块互不影响,而springcloud的思想就类似于此