全面详解Maven的配置文件pom.xml（含常用plugin）
系列文章目录
手把手教你maven的安装与配置(windows)
全面详解Maven的配置文件pom.xml（含常用plugin）
- 系列文章目录
- 一、什么是pom.xml
- 二、pom.xml的结构
- 三、项目的基本信息
-
- 1.modules
- 2.parent
- 3.scm
- 4.properties
- 四、项目的依赖列表
-
- 1.dependency
- 2.repository
- 五、 项目的构建配置
-
- 1.build
- 2.plugins
-
- maven-compiler-plugin
- maven-surefire-plugin
- maven-jar-plugin
- maven-install-plugin
- maven-clean-plugin
- maven-release-plugin
- 3.profiles
- 六、pom.xml的使用
上一次，我们讲解了Maven的安装与配置，那么这次我们就讲讲pom.xml，在Maven中，pom.xml是必不可少的配置文件，它定义了项目的各种属性和依赖关系。接下来，我们将全面解析pom.xml，了解其结构和属性，以及如何使用它来管理项目
作者简介：战斧，从事金融IT行业，有着多年一线开发、架构经验；爱好广泛，乐于分享，致力于创作更多高质量内容
本文收录于 Maven专栏 ，有需要者，可直接订阅专栏实时获取更新
高质量专栏 云原生、RabbitMQ、Spring全家桶、 GIT 等仍在更新，欢迎指导
Zookeeper Redis kafka docker netty等诸多框架，以及架构与分布式专题即将上线，敬请期待
一、什么是pom.xml
pom.xml是Maven项目的核心配置文件，它是 项目对象模型 - Project Object Model（POM）的缩写。POM定义了项目的所有属性，包括项目的名称、版本、依赖关系、构建配置等。使用pom.xml，我们可以轻松地管理项目的构建和依赖关系，让我们能够更专注于业务逻辑的开发。
二、pom.xml的结构
我们先看一个简单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/maven-v4_0_0.xsd">
<modelVersion>4.0.0modelVersion>
<groupId>com.examplegroupId>
<artifactId>example-projartifactId>
<version>1.0.0version>
<name>Example Projectname>
<description>This is an example Maven project.description>
<url>http://www.example.com/url>
<licenses>
<license>
<name>The Apache Software License, Version 2.0name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txturl>
<distribution>repodistribution>
license>
licenses>
<developers>
<developer>
<id>developer1id>
<name>Developer Onename>
<email>[email protected]email>
<organization>Example Organizations Inc.organization>
<organizationUrl>http://www.example-organizations.com/organizationUrl>
<roles>
<role>developerrole>
roles>
<timezone>-5timezone>
developer>
developers>
<dependencies>
<dependency>
<groupId>junitgroupId>
<artifactId>junitartifactId>
<version>4.12version>
<scope>testscope>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-coreartifactId>
<version>5.2.1.RELEASEversion>
dependency>
dependencies>
<build>
<plugins>
<plugin>
<artifactId>maven-compiler-pluginartifactId>
<version>3.8.1version>
<configuration>
<source>1.8source>
<target>1.8target>
configuration>
plugin>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-jar-pluginartifactId>
<version>3.2.0version>
<configuration>
<archive>
<manifest>
<addClasspath>trueaddClasspath>
<mainClass>com.example.AppmainClass>
manifest>
archive>
configuration>
plugin>
plugins>
build>
project>
其中
三、项目的基本信息
与项目的基本信息相关的标签有很多，以下算必填项
groupId：项目的组名，通常是反转的域名，比如com.example。artifactId：项目的唯一标识符，通常是项目的名称。version：项目的版本号。packaging：项目的打包方式，通常是jar、war或pom，如果没有指定packaging，默认值是jar。
除了上面的几个标签，还有一些项目相关，但非必填的内容：
name：项目名，可选项，提供项目的简短名称description：项目描述，可选项，提供项目的详细描述。version：项目主页，可选项，提供项目的网址。licenses： 许可证声明，可选项，声明项目所使用的一种或多种许可证developers：开发者信息，可选项，列出项目的开发人员。url：项目主页，可选项，提供项目的网址
当然，还有一些在我们示例中没有出现的标签，比如说 modules 和 parent
1.modules
modules 标签用于声明当前 Maven 项目包含的模块子项目，每个子项目都是一个独立的 Maven 项目，具有自己的 pom.xml 文件，可以进行独立构建和测试。在父项目的 pom.xml 文件中，使用 标签来列出所有子项目的名称，如下所示：
<project>
<groupId>com.example.parentgroupId>
<artifactId>parent-projectartifactId>
<version>1.0.0version>
<packaging>pompackaging>
<modules>
<module>child1module>
<module>child2module>
<module>child3module>
modules>
project>
上述代码表示当前项目是一个 Maven 的多模块项目：它包含了三个子项目 child1、child2 和 child3，这三个子项目与 parent-project 有相同的 groupId 和 version，但是 artifactId 不同，它们的 pom.xml 都位于 parent-project 的根目录下。当使用 Maven 命令在 parent-project 下执行构建时，Maven 会对每个子模块执行构建，最终生成子项目的构件并复制到 parent-project 的 target 目录下
2.parent
parent 标签用于声明当前 Maven 项目的父项目，它可以将若干个 Maven 项目组织成一个整体，指定版本号，插件版本号等，便于管理和维护，在一个 Maven 项目中，使用标签来引用父项目，如下所示：
<project>
<groupId>com.example.childgroupId>
<artifactId>child-projectartifactId>
<version>1.0.0version>
<packaging>jarpackaging>
<parent>
<groupId>com.example.parentgroupId>
<artifactId>parent-projectartifactId>
<version>1.0.0version>
<relativePath>../parent-project/pom.xmlrelativePath>
parent>
project>
上述代码表示当前项目 child-project 是 parent-project 的子项目，它的 groupId 和 version 都继承自 parent-project。元素是一个可选项，它的值是父项目 pom.xml 文件到子项目 pom.xml 文件的相对路径，如果子项目 pom.xml 和父项目 pom.xml 在同一目录下，则可以省略此元素。
3.scm
scm 又叫 Software Configuration Management,即软件配置管理， 与我们以前提到过的版本控制有关，是Maven中用于指定源代码版本控制信息的标签。它可以帮助Maven获取源代码并将构建生成的二进制文件提交到版本控制系统中。scm标签通常用于指定源代码管理系统的类型、URL、开发者连接等详细信息。示例如下：
<scm>
<connection>scm:git:git://github.com/username/repo.gitconnection>
<developerConnection>scm:git:ssh://github.com/username/repo.gitdeveloperConnection>
<url>http://github.com/username/repo/tree/masterurl>
<tag>1.0.0tag>
scm>
developerConnection 与 connection 有些许不同，connection 可以指向一个本地文件系统路径，也可以是一个远程代码仓库的URL；developerConnection 则是开发者使用的版本控制系统的连接URL，例如connection指向只读代码仓库，而developerConnection则指向可写代码仓库。
通过在POM文件中添加scm标签，Maven可以获取源代码并构建项目，同时还可以自动将构建生成的文件提交到版本控制系统中，方便管理代码版本和协同开发
4.properties
properties 严格来说，并不一定是项目本身的信息，而是人为设置的属性或者说宏，这个标签用来定义和管理项目中所需要的属性，其作用有以下几个：
- 统一管理项目中的常用属性，比如版本号、路径、插件版本等，方便统一修改和管理。
- 可以在配置过程中使用 ${…}占位符引用这些属性，使得配置更加灵活和便捷。
- 避免硬编码，提高代码的可维护性和可读性
比如说我们可以这么配
<properties>
<project.name>demo-projectproject.name>
<project.version>1.0.0project.version>
<jdk.version>1.8jdk.version>
properties>
....省略其余部分
<dependency>
<groupId>com.example.demogroupId>
<artifactId>${project.name}-apiartifactId>
<version>${project.version}version>
dependency>
四、项目的依赖列表
1.dependency
与项目的依赖列表相关的标签最外层由
-
-
-
-
其中的
-
compile：依赖库默认的 scope，表示该依赖库在编译、测试、运行时均需要使用。
-
provided：表示该依赖库只在编译和测试时需要使用，而在运行时已经被系统或者容器提供，所以不需要打包到最终的应用程序中。
-
runtime：表示该依赖库只在运行时需要使用，而在编译和测试时则不需要。
-
test：表示该依赖库只在测试时需要使用，而在编译和运行时则不需要。
比如说我们引入了 junit 包，但显然这个包我们不需要在打包时包含，只是用于测试，那么我们就可以将 junit 的 scope 设置为 test。
2.repository
当然，我们还能在pom文件中支持指定Maven仓库，即使用
-
-
-
五、 项目的构建配置
项目的构建配置信息，包括编译器版本、插件列表、源代码目录等，接下来我们慢慢来讲
1.build
build用于定义项目的构建配置，包括源代码目录、资源目录、插件等，其中代码部分的设置如下
<project>
.... 省略其他部分
<build>
<sourceDirectory>src/main/javasourceDirectory>
<resources>
<resource>
<directory>src/main/resourcesdirectory>
resource>
resources>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-compiler-pluginartifactId>
<version>3.8.1version>
<configuration>
<source>1.8source>
<target>1.8target>
configuration>
plugin>
plugins>
build>
project>
需要注意的是，像资源目录这种路径是没有默认值的，但根据Maven的约定优于配置原则（Convention over Configuration），Maven会使用默认的目录结构去查找源代码和测试代码。默认的目录结构如下
project
|--src
|--main
|--java // Java主源代码目录
|--resources // 资源文件目录
|--test
|--java // 测试主代码目录
|--resources // 测试资源文件目录
因此，在一个标准的Maven项目中，sourceDirectory默认值应该是src/main/java。如果有自定义的代码目录结构，需要显式地设置sourceDirectory元素的值。例如，如果有一个名为“core”的子目录作为项目的主源代码目录，可以按以下方式进行配置：
<build>
<sourceDirectory>coresourceDirectory>
...
build>
2.plugins
plugins的作用是定义 Maven 插件， plugins 主要用于扩展 Maven 的功能，帮助开发人员更方便地构建、打包、发布项目。插件可以通过 Maven 的插件中心或者自己构建的私有仓库来使用，能在构建过程中执行特定的任务，比如编译、打包、测试等。
插件的配置可以分为两种方式：全局配置和项目配置。全局配置是在 Maven 安装目录下的 conf/settings.xml 文件中进行配置，可以被所有的项目使用。项目配置则是在项目的 pom.xml 文件中进行配置，只对当前项目生效。
插件的使用主要分为以下几个步骤：
- 在 pom.xml 中声明插件依赖
- 配置插件的参数
- 运行插件命令
而常用的Maven Plugin有不少，我们一一来说一下：
maven-compiler-plugin
比方说，最常用的编译功能，我们可以在pom里面这么写
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-compiler-pluginartifactId>
<version>3.8.1version>
<configuration>
<source>1.8source>
<target>1.8target>
<encoding>UTF-8encoding>
<showWarnings>trueshowWarnings>
<compilerArgs>
<arg>-Xlint:uncheckedarg>
<arg>-Xlint:deprecationarg>
compilerArgs>
configuration>
plugin>
plugins>
build>
各子标签的作用如下：
如果我们按示例中配置，我们就指定了编译器的源和目标版本为1.8，当我们使用 mvn compile 命令的时候，这个插件将会编译我们的 Java 代码，并将编译后的 class 文件放置在 target 目录下
maven-surefire-plugin
maven-surefire-plugin插件是Maven中的一个测试框架，用于执行Java单元测试和集成测试。它的主要作用是在构建过程中运行测试，并生成测试报告，在pom.xml中的配置如下：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-surefire-pluginartifactId>
<version>3.0.0-M4version>
<configuration>
<skipTests>trueskipTests>
<forkCount>2forkCount>
<useSystemClassLoader>falseuseSystemClassLoader>
<reuseForks>truereuseForks>
<includes>
<include>**/*Test.javainclude>
<include>**/*Tests.javainclude>
includes>
<systemProperties>
<property>
<name>testProp1name>
<value>value1value>
property>
<property>
<name>testProp2name>
<value>value2value>
property>
systemProperties>
configuration>
plugin>
plugins>
build>
其中几个子标签的作用分别如下
maven-jar-plugin
maven-jar-plugin 用于将项目打包为JAR文件，在这个例子中，我们告诉Maven将com.example.MyApp作为JAR文件的主类，那么在pom.xml中的配置如下：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-jar-pluginartifactId>
<version>3.1.0version>
<configuration>
<archive>
<manifest>
<addClasspath>trueaddClasspath>
<mainClass>com.example.MyAppmainClass>
manifest>
archive>
configuration>
plugin>
plugins>
build>
maven-install-plugin
当执行mvn instal命令时，maven-install-plugin 用于将一个特定的文件安装到本地Maven仓库中，以便其他项目可以使用它，例如在pom.xml中的配置如下：
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-install-pluginartifactId>
<version>3.0.0-M1version>
<configuration>
<file>${project.build.directory}/example.jarfile>
<groupId>com.examplegroupId>
<artifactId>exampleartifactId>
<version>1.0.0version>
<packaging>jarpackaging>
configuration>
plugin>
需要注意的是，
maven-clean-plugin
maven-clean-plugin 用于清理Maven项目中的目标文件和构建临时文件，以便重新构建项目。它通常被用于在构建之前清理项目，以确保在构建时使用最新的代码和资源ar文件，在pom.xml中的配置如下：
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-clean-pluginartifactId>
<version>3.1.0version>
<executions>
<execution>
<id>clean-allid>
<phase>cleanphase>
<goals>
<goal>cleangoal>
goals>
<configuration>
<excludeDefaultDirectories>trueexcludeDefaultDirectories>
<filesets>
<fileset>
<directory>targetdirectory>
<includes>
<include>**/*include>
includes>
fileset>
filesets>
configuration>
execution>
executions>
plugin>
plugins>
build>
该配置中，maven-clean-plugin的版本号是3.1.0，它在clean阶段（phase标签指定）执行，使用的目标是clean。下面是各个子标签的作用：
至于通配符，使用规则如下：
* 匹配零个或多个字符
** 匹配零个或多个目录
需要注意的是，Maven的通配符仅支持*和**，不支持其他通配符，例如?。同时，通配符匹配的范围是相对于构建目录的，也就是默认情况下是相对于pom.xml文件的目录
maven-release-plugin
maven-release-plugin 可以帮助我们在代码库中创建一个稳定的发布版本，并将其发布到Maven仓库中，同时更新开发版本号，以便于下次开发版本的迭代，它可以做如下配置
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-release-pluginartifactId>
<version>2.5.2version>
<configuration>
<tagNameFormat>v@{project.version}tagNameFormat>
<tagBase>http://svn.example.com/tagstagBase>
<autoVersionSubmodules>trueautoVersionSubmodules>
<releaseProfiles>releasereleaseProfiles>
<branchBase>http://svn.example.com/branchesbranchBase>
configuration>
plugin>
plugins>
build>
3.profiles
profiles用于定义 Maven 运行时的不同配置环境，比如开发环境、测试环境、生产环境等，可以在不同的环境中使用不同的配置，比如我们做了如下配置
<profiles>
<profile>
<id>prodid>
<activation>
<activeByDefault>trueactiveByDefault>
activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.pluginsgroupId>
<artifactId>maven-compiler-pluginartifactId>
<version>3.8.1version>
<configuration>
<release>11release>
configuration>
plugin>
plugins>
build>
profile>
profiles>
在Maven中，使用以下命令激活特定的profile：
mvn clean install -Pprod
这将激活prod profile，覆盖默认构建配置。
六、pom.xml的使用
经过了上面的学习，不难发现，使用pom.xml可以轻松地管理项目的构建和依赖关系，其主要用法其实有三种：
- 添加依赖：在dependencies标签下添加依赖，包括groupId、artifactId、version、scope等信息。
- 修改打包方式：在packaging标签下修改项目的打包方式，通常是jar、war或pom。
- 配置插件：在build标签下配置插件，包括groupId、artifactId、version等信息。插件可以帮助我们处理各种构建任务，比如编译代码、生成文档、打包文件等。