Spring知识点学习（4）：Maven的使用及pom.xml文件配置

GitHub位置：https://github.com/SirLiuGang/Spring/blob/master/spring-pom/pom.xml

1. IDEA中Maven的使用

单击IDEA工程右边的Maven Projects选项卡，将弹出Maven项目的管理窗口：

单击左侧的刷新按钮，就可以列出当前所有的Maven模块。
每个模块包含两个子节点：Liefcycle和Dependencies
Liefcycle提供了常用的Maven操作命令，如清理、验证、编译、测试、打包、部署等；
Dependencies下列出了当前模块所有依赖的类库。

（一）选中clean和install，先点击跳过单元测试，然后点击运行按钮，进行Maven依赖的重新编译。如果不行，看下边的操作。

（二）选中如图所示按钮后，可以查看Maven依赖：

2. 修改POM文件

原有spring-pom项目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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.cn.lg</groupId>
    <artifactId>spring-pom</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-pom</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <modules>
        <module>../spring-threadpool</module>
    </modules>

</project>

原有spring-threadpool项目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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.cn.lg</groupId>
    <artifactId>spring-threadpool</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-threadpool</name>
    <description>Several ways to implement thread pools</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3. 让项目进行聚合和继承

目前有两个项目，pom和threadpool，现在threadpool继承pom，同时threadpool聚合到pom。然后pom和threadpool的目录结构如下：

这个时候，pom项目的pom.xml中需要定义它的packaging为pom，并且定义它的modules，所以pom项目的pom.xml应该这样定义：

	<!-- 打包的机制为pom -->
	<packaging>pom</packaging>

	<!-- 子模块 -->
	<modules>
        <module>../spring-threadpool</module>
    </modules>

而threadpool时继承pom项目的，所以我们需要修改threadpool的pom.xml文件parent元素，用于定义它继承的项目信息，新建的spring项目默认是继承了org.springframework.boot，需要修改为我们自己的pom项目：

	<!-- 继承我们自己的项目 -->
    <parent>
        <groupId>com.cn.lg</groupId>
        <artifactId>spring-pom</artifactId>
        <version>0.0.1</version>
        <relativePath>../spring-pom</relativePath>
    </parent>
    
	<groupId>com.cn.lg.spring</groupId>
    <artifactId>spring-threadpool</artifactId>
    <version>0.0.1</version>
    <name>spring-threadpool</name>
    <description>Several ways to implement thread pools</description>

在子项目中，能够继承父项目的如下配置：

• dependencies
• developers
• contributors
• plugin lists
• reports lists
• plugin executions with matching ids
• plugin configuration

所以子类pom.xml文件中重复的代码便可以删掉了

4. 修改后的pom.xml文件

修改后的spring-pom项目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 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <!-- 模型版本。maven2.0必须是这样写，现在是maven2唯一支持的版本 -->
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <!-- 打包的机制，如pom,jar, maven-plugin, ejb, war, ear, rar, par，默认为jar，这里由于是作为父类的pom文件，所以打包方式为pom -->
    <packaging>pom</packaging>

    <!-- 公司或者组织的唯一标志，并且配置时生成的路径也是由此生成， 如com.cn.lg，maven会将该项目打成的jar包放本地路径：/com/cn/lg -->
    <groupId>com.cn.lg</groupId>
    <!-- 本项目的唯一ID，一个groupId下面可能多个项目，就是靠artifactId来区分的 -->
    <artifactId>spring-pom</artifactId>
    <version>0.0.1</version>
    <name>spring-pom</name>
    <description>spring study</description>

    <!-- 为pom定义一些常量，在pom中的其它地方可以直接引用 使用方式 如下 ：${java.version} -->
    <properties>
        <java.version>1.8</java.version>
    </properties>

    <!-- 定义本项目的依赖关系 -->
    <dependencies>
        <!--一般情况下，maven是通过groupId、artifactId、version这三个元素值（俗称坐标）来检索该构件， 然后引入你的工程。如果别人想引用你现在开发的这个项目（前提是已开发完毕并发布到了远程仓库），-->
        <!--就需要在他的pom文件中新建一个dependency节点，将本项目的groupId、artifactId、version写入， maven就会把你上传的jar包下载到他的本地 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <!-- maven认为，程序对外部的依赖会随着程序的所处阶段和应用场景而变化，所以maven中的依赖关系有作用域(scope)的限制。 -->
            <!--scope包含如下的取值：compile（编译范围）、provided（已提供范围）、runtime（运行时范围）、test（测试范围）、system（系统范围） -->
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

    <!-- 子模块 -->
    <modules>
        <module>../spring-threadpool</module>
    </modules>

</project>

修改后的spring-threadpool项目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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <!-- 继承自己的项目 -->
    <parent>
        <groupId>com.cn.lg</groupId>
        <artifactId>spring-pom</artifactId>
        <version>0.0.1</version>
        <!-- relativePath给出父项目相对于子项目的路径，这样在构件子项目时首先从该相对路径查找父项目，如果没有才会从本地库或进而远程库中查找父项目。 -->
        <relativePath>../spring-pom</relativePath>
    </parent>

    <!-- 在子项目中，能够继承父项目的如下配置： -->
    <!-- dependencies -->
    <!-- developers -->
    <!-- contributors -->
    <!-- plugin lists -->
    <!-- reports lists -->
    <!-- plugin executions with matching ids -->
    <!-- plugin configuration -->

    <groupId>com.cn.lg.spring</groupId>
    <artifactId>spring-threadpool</artifactId>
    <version>0.0.1</version>
    <name>spring-threadpool</name>
    <description>Several ways to implement thread pools</description>

</project>

5. Maven操作

clean和install操作后的日志信息：两个模块被重新装载。

可以查看Maven依赖图，pom项目和threadpool项目是一样的，因为threadpool没有引入新的依赖包，全部继承pom项目。

总结

在实际项目中，一个项目一般划分成多个子模块。为了简化每个模块对第三方依赖的配置，在创建项目工程的时候，一般会创建一个Maven的根模块，用来管理每个子模块的公共配置，在各个子模块中直接继承根模块的配置即可。

本项目中spring-pom为根模块，负责写入一些公共的内容，相当于父类，而其他所有模块均继承该根模块，子类中再引入自己需要的依赖，将项目分开进行管理，而不是将配置文件都放到一起。