白话文Maven中pom.xml笔记

现在由于Sping，SpringBoot，Maven等等框架的主流化，程序员的门槛越来越低。
但你会发现，很多程序员其实只会增删改查，很多基础的东西一问三不知。就比如Maven的配置

这篇文章跳过maven的安装，setting文件配置等。直接记录开发中接触最多的pom.xml文件的配置，标签的含义。

pom文件全局一览：

我们用idea创建一个新的spring boot
项目的时候，工程会默认生成一个简易的初始化的pom.xml文件；所以我们作为开发人员，在平时的工作中接触到的pom文件配置是很少的，下面是pom.xml全部的配置标签：

<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>

    <!-- 基本配置 -->
    <groupId>...</groupId>
    <artifactId>...</artifactId>
    <version>...</version>
    <packaging>...</packaging>
    
    <!-- 项目信息 -->
    <name>...</name>
    <description>...</description>
    <url>...</url>
    <inceptionYear>...</inceptionYear>
    <licenses>...</licenses>
    <organization>...</organization>
    <developers>...</developers>
    <contributors>...</contributors>


    <!-- 依赖配置 -->
    <dependencies>...</dependencies>
    <parent>...</parent>
    <dependencyManagement>...</dependencyManagement>
    <modules>...</modules>
    <properties>...</properties>

    <!-- 构建配置 -->
    <build>...</build>
    <reporting>...</reporting>


    <!-- 环境设置 -->
    <issueManagement>...</issueManagement>
    <ciManagement>...</ciManagement>
    <mailingLists>...</mailingLists>
    <scm>...</scm>
    <prerequisites>...</prerequisites>
    <repositories>...</repositories>
    <pluginRepositories>...</pluginRepositories>
    <distributionManagement>...</distributionManagement>
    <profiles>...</profiles>
</project>

下面把整个文件分成基本配置、项目信息、依赖配置、构建配置、环境设置五个模块进行解释。

1.基本配置

基本配置模块和项目信息模块基本上是放在一起的，这里先说基本配置模块。

<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>
    <groupId>...</groupId>
    <artifactId>...</artifactId>
    <version>...</version>
    <packaging>...</packaging>

最外层的<project>标签我们不用管它，是maven根据项目和maven版本默认的版本描述信息。

标签	含义
modelVersion	pom文件版本，不管
groupId	组id，表示当前pom所管辖的模块所属公司，如com.taobao
artifactId	项目id，表示当前pom所管辖的模块的名字。
version	当前项目的版本号，一般是：大版本.小版本.增量版本-限定版本号，SHAPSHOT意为快照，说明该项目还处于开发中。
packaging	项目的打包方式，常用可选值：pom, jar, ejb, maven-plugin, war, ear, rar, par等。

如：

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>war</packaging>

2.项目信息

    <!-- 项目信息 -->
    <name>...</name>
    <description>...</description>
    <url>...</url>
    <inceptionYear>...</inceptionYear>
    <licenses>...</licenses>
    <organization>...</organization>
    <developers>...</developers>
    <contributors>...</contributors>

标签	含义
name	项目名称，一般用于Maven生成的文档
description	项目的详细描述信息，能使用HTML格式描述时不建议使用纯文本来描述， 一般用于Maven生成的文档
url	项目主页的url，一般用于Maven生成的文档
inceptionYear	项目开始的年份，一般是4位数字，涉及到介绍情况时用作提供版权信息
licenses	当前项目所有的许可文件，每一个许可文件用一个许可元素来描述，然后描述额外的元素。 通常只列出适用于这个项目的许可文件，无需列出依赖项目的 许可文件列表。如果列出多个license，那么用户可以选择其中所需的，而不是接受所有的许可文件。
organization	组织相关信息
developers	开发者信息
contributors	其他开发者信息

其他的都好说，就是一些项目的描述信息，对于我们开发人员来说不重要也不会去专门编写；但中间的这个licenses是什么呢？感觉读不懂啊。

licenses：给我们的项目加上许可证信息。（我们只需要了解这么多就够了。）

3.依赖配置（常用）

    <!-- 依赖配置 -->
    <dependencies>...</dependencies>
    <parent>...</parent>
    <dependencyManagement>...</dependencyManagement>
    <modules>...</modules>
    <properties>...</properties>

这些标签是工作中用到比较多的，要重点记录一下。

标签	含义
dependencies	项目相关依赖，如果父项目中的依赖，会被子项目引用，所以一般在父项目中定义子项目中共有的依赖。并且如果有需要，子项目可以修改所依赖包的版本
parent	用于确定父项目的坐标位置。
dependencyManagement	用于帮助管理children的依赖
modules	Maven项目的一大特点就是以多模块著称，该标签就是用于指定当前项目所包含的模块，对该模块进行的Maven操作，会让所有子模块也进行相应的操作
properties	该标签用于定义pom文件中的常量，这样，在pom文件的任何地方，都可以通过${java.version}来引用该值。

3.1 dependencies

开发人员用的最多的标签了。<dependencies>算是一个父标签，描述了当前的pom文件将要引用哪些第三方的包和库（这里默认为jar包）。

<dependencies>的结构：

<dependencies>
    <dependency>
        <groupId>com.alibaba.china.shared</groupId>
        <artifactId>alibaba.apollo.webx</artifactId>
        <version>2.5.0</version>
        <scope>test</scope>
        <exclusions>
          <exclusion>
            <artifactId>org.slf4j.slf4j-api</artifactId>
            <groupId>com.alibaba.external</groupId>
          </exclusion>
        </exclusions>
    </dependency>
   				.......
</dependencies>

一个<dependencies>包含多个<dependency>，每个<dependency>都描述了将要引入的依赖的具体信息：

标签	含义
groupId	创建项目的组织或团体的唯一 Id.可视为公司名
artifactId	项目的唯一 Id, 可视为项目名 .
version	jar包的版本号
scope	为jar包作用范围。参数有4种：test、compile、provided、runtime（默认compile）
exclusions	exclusions和exclusion属性，用于移除项目依赖相关，如果项目X需要A，而A包含B依赖，那么X可以声明不要B依赖，只要在exclusions中声明exclusion，将B从依赖树中删除即可。这一般用于解决jar包冲突的问题。

<scope>4种参数的含义：

1. test：test范围指的是测试范围有效，在编译和打包时都不会使用这个依赖
2. compile：compile范围指的是编译范围有效，在编译和打包时都会将依赖存储进去
3. provided：在编译和测试的过程有效，最后生成war包时不会加入
4. runtime：untime在运行的时候依赖，在编译的时候不依赖

3.2 parent

<parent>标签用于确定父项目的坐标位置。
怎么理解呢？

好，假如我现在有一个项目A,A的pom文件里面依赖了Redis的jar包。
现在我有新建了两个模块B和C，每个模块都有一个自己的pom文件，并且这两个模块都要用Redis的jar包。
我们一般就会指定B和C的pom文件依赖A的pom，就是认A做父。 这样B和C就是A的儿子，继承了A里面的所有依赖。
还不清楚可以看看这里: https://www.cnblogs.com/chensisi/p/13343602.html.

<parent>的结构：

<parent>
    <groupId>com.learnPro</groupId>
    <artifactId>SIP-parent</artifactId>
    <relativePath></relativePath>
    <version>0.0.1-SNAPSHOT</version>
</parent>

标签	含义
groupId	父工程公司名
artifactId	父工程名
relativePath	Maven首先在当前项目中找父项目的pom，然后在文件系统的这个位置（relativePath）查找，然后在本地仓库查找，再在远程仓库找。
version	父工程的版本号

3.3 dependencyManagement

用于帮助管理children的依赖。例如如果parent使用dependencyManagement定义了一个junit:junit4.0，那么它的children就可以只引用 groupId和artifactId，而version就可以直接使用父模块的，如果有需要，我们也可以设置version，这样的好处就是可以集中管理依赖的详情，并且也更灵活。
  不过dependencyManagement里只是声明依赖，并不实现引入，因此子项目需要显示的声明需要用的依赖。配置同dependencies类似

好，假如我现在有一个项目A,A的pom文件里面依赖了Redis的jar包和Mysql的jar包。
现在我有新建了两个模块B和C，每个模块都有一个自己的pom文件，B模块需要Redis和Mysql的jar包。
但C模块只需要Mysql的jar包。
我们一般就会指定B和C的pom文件依赖A的pom（<parent>），就是认A做父。 这样B和C就是A的儿子，继承了A里面的所有依赖。但如果A模块的<dependencies>被<dependencyManagement>标签包裹了。
那么B和C的pom就需要显示的写出想要依赖的jar包（不用写version）。

这样的话就更加灵活配置。

还不清楚可以看看这里: https://www.cnblogs.com/chensisi/p/13343602.html.

3.4 modules

一般存在于父pom，用于表示整个工程要加载哪些模块：

<modules>
   <module>{子模块的模块名：artifactId}</>
   <module>com-b</>
   <module>com-c</>
<modules/>

3.5 properties

一般存在于父pom，用于声明常量，方便一处改动处处生效。常用来定义版本号：

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

4.构建配置

顾名思义，这里管理的是项目构建打包时候的事情。
这里有两个顶级标签：<build>，<reporting>。

4.1 build

所谓的build，也就是项目构建。在构建配置的过程中，一般包含两个部分，一个是<build>，另一个是<reporting>；而在Maven的pom.xml中build又分为两种，一种被称为Project Build，也就是<project>下的直接子元素，另一种<build>被称为Profile Build，即是<profile>的直接子元素。Profile Build包含了基本的build元素，而Project Build还包含两个特殊的元素，即各种<...Directory>和<extensions>。

<build>
    <!--该元素设置了项目源码目录，当构建项目的时候，构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。-->
    <sourceDirectory/>
    <!--该元素设置了项目脚本源码目录，该目录和源码目录不同：绝大多数情况下，该目录下的内容 会被拷贝到输出目录(因为脚本是被解释的，而不是被编译的)。-->
    <scriptSourceDirectory/>
    <!--该元素设置了项目单元测试使用的源码目录，当测试项目的时候，构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。-->
    <testSourceDirectory/>
    <!--被编译过的应用程序class文件存放的目录。-->
    <outputDirectory/>
    <!--被编译过的测试class文件存放的目录。-->
    <testOutputDirectory/>
    <!--使用来自该项目的一系列构建扩展-->
    <extensions>
        <!--描述使用到的构建扩展。-->
        <extension>
            <!--构建扩展的groupId-->
            <groupId/>
            <!--构建扩展的artifactId-->
            <artifactId/>
            <!--构建扩展的版本-->
            <version/>
        </extension>
    </extensions>
    <!--当项目没有规定目标（Maven2 叫做阶段）时的默认值-->
    <defaultGoal/>
    <!--这个元素描述了项目相关的所有资源路径列表，例如和项目相关的属性文件，这些资源被包含在最终的打包文件里。-->
    <resources>
        <!--这个元素描述了项目相关或测试相关的所有资源路径-->
        <resource>
            <!-- 描述了资源的目标路径。该路径相对target/classes目录（例如${project.build.outputDirectory}）。举个例 子，如果你想资源在特定的包里(org.apache.maven.messages)，你就必须该元素设置为org/apache/maven /messages。然而，如果你只是想把资源放到源码目录结构里，就不需要该配置。-->
            <targetPath/>
            <!--是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性，文件在filters元素里列出。-->
            <filtering/>
            <!--描述存放资源的目录，该路径相对POM路径-->
            <directory/>
            <!--包含的模式列表，例如**/*.xml.-->
            <includes/>
            <!--排除的模式列表，例如**/*.xml-->
            <excludes/>
        </resource>
    </resources>
    <!--这个元素描述了单元测试相关的所有资源路径，例如和单元测试相关的属性文件。-->
    <testResources>
        <!--这个元素描述了测试相关的所有资源路径，参见build/resources/resource元素的说明-->
        <testResource>
            <targetPath/>
            <filtering/>
            <directory/>
            <includes/>
            <excludes/>
        </testResource>
    </testResources>
    <!--构建产生的所有文件存放的目录-->
    <directory/>
    <!--产生的构件的文件名，默认值是${artifactId}-${version}。-->
    <finalName/>
    <!--当filtering开关打开时，使用到的过滤器属性文件列表-->
    <filters/>
    <!--子项目可以引用的默认插件信息。该插件配置项直到被引用时才会被解析或绑定到生命周期。给定插件的任何本地配置都会覆盖这里的配置-->
    <pluginManagement>
        <!--使用的插件列表 。-->
        <plugins>
            <!--plugin元素包含描述插件所需要的信息。-->
            <plugin>
                <!--插件在仓库里的group ID-->
                <groupId/>
                <!--插件在仓库里的artifact ID-->
                <artifactId/>
                <!--被使用的插件的版本（或版本范围）-->
                <version/>
                <!--是否从该插件下载Maven扩展（例如打包和类型处理器），由于性能原因，只有在真需要下载时，该元素才被设置成enabled。-->
                <extensions/>
                <!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。-->
                <executions>
                    <!--execution元素包含了插件执行需要的信息-->
                    <execution>
                        <!--执行目标的标识符，用于标识构建过程中的目标，或者匹配继承过程中需要合并的执行目标-->
                        <id/>
                        <!--绑定了目标的构建生命周期阶段，如果省略，目标会被绑定到源数据里配置的默认阶段-->
                        <phase/>
                        <!--配置的执行目标-->
                        <goals/>
                        <!--配置是否被传播到子POM-->
                        <inherited/>
                        <!--作为DOM对象的配置-->
                        <configuration/>
                    </execution>
                </executions>
                <!--项目引入插件所需要的额外依赖-->
                <dependencies>
                    <!--参见dependencies/dependency元素-->
                    <dependency>
                        ......
                    </dependency>
                </dependencies>
                <!--任何配置是否被传播到子项目-->
                <inherited/>
                <!--作为DOM对象的配置-->
                <configuration/>
            </plugin>
        </plugins>
    </pluginManagement>
    <!--使用的插件列表-->
    <plugins>
        <!--参见build/pluginManagement/plugins/plugin元素-->
        <plugin>
            <groupId/>
            <artifactId/>
            <version/>
            <extensions/>
            <executions>
                <execution>
                    <id/>
                    <phase/>
                    <goals/>
                    <inherited/>
                    <configuration/>
                </execution>
            </executions>
            <dependencies>
                <!--参见dependencies/dependency元素-->
                <dependency>
                    ......
                </dependency>
            </dependencies>
            <goals/>
            <inherited/>
            <configuration/>
        </plugin>
    </plugins>
</build>

想更清楚了解可以看看这里: https://blog.csdn.net/u010010606/article/details/79727438/.
详细解释可以看: https://zhuanlan.zhihu.com/p/305816099.

4.2 reporting（了解）

<reporting>
    <!--true，则网站不包括默认的报表。这包括“项目信息”菜单中的报表。-->
    <excludeDefaults/>
    <!--所有产生的报表存放到哪里。默认值是${project.build.directory}/site。-->
    <outputDirectory/>
    <!--使用的报表插件和他们的配置。-->
    <plugins>
        <!--plugin元素包含描述报表插件需要的信息-->
        <plugin>
            <!--报表插件在仓库里的group ID-->
            <groupId/>
            <!--报表插件在仓库里的artifact ID-->
            <artifactId/>
            <!--被使用的报表插件的版本（或版本范围）-->
            <version/>
            <!--任何配置是否被传播到子项目-->
            <inherited/>
            <!--报表插件的配置-->
            <configuration/>
            <!--一组报表的多重规范，每个规范可能有不同的配置。一个规范（报表集）对应一个执行目标 。
              例如，有1，2，3，4，5，6，7，8，9个报表。1，2，5构成A报表集，对应一个执行目标。
              2，5，8构成B报表集，对应另一个执行目标-->
            <reportSets>
                <!--表示报表的一个集合，以及产生该集合的配置-->
                <reportSet>
                    <!--报表集合的唯一标识符，POM继承时用到-->
                    <id/>
                    <!--产生报表集合时，被使用的报表的配置-->
                    <configuration/>
                    <!--配置是否被继承到子POMs-->
                    <inherited/>
                    <!--这个集合里使用到哪些报表-->
                    <reports/>
                </reportSet>
            </reportSets>
        </plugin>
    </plugins>
</reporting>

5. 环境配置

这里我只说几个常用的：

5.1 repositories

依赖和扩展的远程仓库列表；pom里面的仓库与setting.xml里的仓库功能是一样的。主要的区别在于，pom里的仓库是个性化的。比如一家大公司里的setting文件是公用 的，所有项目都用一个setting文件，但各个子项目却会引用不同的第三方库，所以就需要在pom里设置自己需要的仓库地址。

<repositories>
    <repository>
      <releases>
        <enabled>false</enabled>
        <updatePolicy>always</updatePolicy>
        <checksumPolicy>warn</checksumPolicy>
      </releases>
      <snapshots>
        <enabled>true</enabled>
        <updatePolicy>never</updatePolicy>
        <checksumPolicy>fail</checksumPolicy>
      </snapshots>
      <id>codehausSnapshots</id>
      <name>Codehaus Snapshots</name>
      <url>http://snapshots.maven.codehaus.org/maven2</url>
      <layout>default</layout>
    </repository>
  </repositories>

标签	含义
releases，snapshots	这是各种构件的策略，release或者snapshot，这两个集合，POM就可以根据独立仓库任意类型的依赖改变策略。如：一个人可能只激活下载snapshot用来开发。
enable	true或者false，决定仓库是否对于各自的类型激活(release 或者 snapshot)。
updatePolicy	这个元素决定更新频率。maven将比较本地pom的时间戳（存储在仓库的maven数据文件中）和远程的。有以下选择: always, daily (默认), interval:X (x是代表分钟的整型) ， never。
checksumPolicy	当Maven向仓库部署文件的时候，它也部署了相应的校验和文件。可选的为：ignore，fail，warn，或者不正确的校验和。
layout	在上面描述仓库的时候，提到他们有统一的布局。Maven 2有它仓库默认布局。然而，Maven 1.x有不同布局。使用这个元素来表明它是default还是legacy。

5.2 profiles

POM 4.0的一个新特性是一个项目能够根据所构建的环境改变设置。通过profiles，我们可以指定构建的环境是开发，测试，UAT，生产等环境；

  <profiles>
    <profile>
      <id>test</id>
      <activation>...</activation>
      <build>...</build>
      <modules>...</modules>
      <repositories>...</repositories>
      <pluginRepositories>...</pluginRepositories>
      <dependencies>...</dependencies>
      <reporting>...</reporting>
      <dependencyManagement>...</dependencyManagement>
      <distributionManagement>...</distributionManagement>
    </profile>
  </profiles>
</project>

如：

  <profiles>
    <profile>
      <id>test</id>
      <activation>
        <activeByDefault>false</activeByDefault>
        <jdk>1.5</jdk>
        <os>
          <name>Windows XP</name>
          <family>Windows</family>
          <arch>x86</arch>
          <version>5.1.2600</version>
        </os>
        <property>
          <name>sparrow-type</name>
          <value>African</value>
        </property>
        <file>
          <exists>${basedir}/file2.properties</exists>
          <missing>${basedir}/file1.properties</missing>
        </file>
      </activation>
      ...
    </profile>
  </profiles>
</project>

详细解释可以看: https://zhuanlan.zhihu.com/p/305816099.