Maven之pom.xml配置文件详解
前言
setting.xml主要用于配置maven的运行环境等一系列通用的属性，是全局级别的配置文件；
pom.xml主要描述项目的maven坐标，依赖关系，开发者需要遵循的规则，缺陷管理系统，组织和licenses，是项目级别的配置文件。
一、基础配置
一个典型的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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">
<!-- 模型版本(固定的) -->
<modelVersion>4.0.0</modelVersion>
<!-- 组织名称,一般是公司域名 -->
<groupId>com.winner.trade</groupId>
<!-- 项目id,一个公司下面有很多项目,用这个项目id区分公司内的项目 -->
<artifactId>trade-core</artifactId>
<version>1.0.0-SNAPSHOT</version>
<!-- 打包的机制，如pom,jar, maven-plugin, ejb, war, ear, rar, par，默认为jar -->
<packaging>jar</packaging>
<!-- 分类器:同一个项目可能产出很多个jar包,比如有的是针对jdk8有的是jdk11,这个时候就用这个标签 -->
<classifier>...</classifier>
<!-- 项目依赖管理 -->
<dependencies>
<dependency>
<groupId>com.winner.trade</groupId>
<artifactId>trade-test</artifactId>
<version>1.0.0-SNAPSHOT</version>
<!-- maven认为程序对外部的依赖会随着程序的所处阶段和应用场景而变化，所以maven中的依赖关系有作用域(scope)的限制。scope包含如下的取值：compile（编译时存在）、provided（开发时存在）、runtime（运行时存在）、test（测试时存在）、system（系统范围） -->
<scope>test</scope>
<!-- 指的是父子工程，父工程中设置依赖是否可选，默认为false,即子项目不需要显式的声明添加就可以默认继承这个依赖。当为true时,则子项目必需显示的引入才能使用 -->
<optional>false</optional>
<!-- 排除这个依赖的 某个依赖。 比如项目中使用的libA依赖hutool的1.0版，libB依赖hutool的2.0版，现在想统一使用2.0版，就应该屏蔽掉对1.0版的依赖 -->
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<!-- 定义本项目的一些属性，在pom中的其它地方可以直接引用 使用方式 如下 ：${file.encoding} -->
<properties>
<file.encoding>UTF-8</file.encoding>
<java.source.version>8</java.source.version>
<java.target.version>8</java.target.version>
</properties>
</project>
classifier元素用来帮助定义构件输出的一些附属构件。附属构件与主构件对应，比如主构件是 kimi-app-2.0.0.jar，该项目可能还会通过使用一些插件生成 如kimi-app-2.0.0-javadoc.jar （Java文档）、 kimi-app-2.0.0-sources.jar（Java源代码） 这样两个附属构件。这时候，javadoc、sources就是这两个附属构件的classifier，这样附属构件也就拥有了自己唯一的坐标。
classifier的用途在于:
-
maven download javadoc / sources jar包的时候，需要借助classifier指明要下载那个附属构件
-
引入依赖的时候，有时候仅凭groupId、artifactId、version无法唯一的确定某个构件，需要借助classifier来进一步明确目标。比如JSON-lib，有时候会同一个版本会提供多个jar包，在JDK1.5环境下是一套，在JDK1.3环境下是一套：
引用它的时候就要注明JDK版本，否则maven不知道你到底需要哪一套jar包：
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib</artifactId>
<version>2.4</version>
<classifier>jdk15</classifier>
</dependency>
二、构建配置
<build>
<!-- 最终编译后产物的名称，默认${artifactId}-${version}。 -->
<finalName>myPorjectName</finalName>
<!-- 编译后文件的输出目录,默认为${basedir}/target -->
<directory>${basedir}/target</directory>
<!--当项目没有规定目标（Maven2叫做阶段（phase））时的默认值， -->
<!--必须跟命令行上的参数相同例如jar:jar，或者与某个阶段（phase）相同例如install、compile等 -->
<defaultGoal>install</defaultGoal>
<!--当filtering开关打开时，使用到的过滤器属性文件列表。 -->
<!--项目配置信息中诸如${spring.version}之类的占位符会被属性文件中的实际值替换掉 -->
<filters>
<filter>../filter.properties</filter>
</filters>
<!-- 编译时管理项目资源 -->
<resources>
<resource>
<!-- 配置资源编译后的相对target/classes输出路径。例如${project.build.outputDirectory} -->
<targetPath>resources</targetPath>
<!--是否使用参数值代替参数名。参数值取自properties元素或者文件里配置的属性，文件在filters元素里列出。 -->
<filtering>true</filtering>
<!--描述存放资源的目录，该路径相对POM路径 -->
<directory>src/main/resources</directory>
<!-- 编译时包含哪些资源 -->
<includes>
<include>**/*.properties</include>
<include>**/*.xml</include>
</includes>
<!-- 编译时排除哪些资源 如果<include>与<exclude>划定的范围存在冲突，以<exclude>为准 -->
<excludes>
<exclude>jdbc.properties</exclude>
</excludes>
</resource>
</resources>
<!-- 单元测试相关的资源处理方式，配置方法与resources类似 -->
<testResources>
<testResource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</testResource>
</testResources>
<!-- 指定源码所在的目录 -->
<sourceDirectory>${basedir}\src\main\java</sourceDirectory>
<!-- 指定脚本目录，该目录下的内容会被"拷贝"到输出目录(因为脚本是被解释执行的，编译后可能出现脚本无法执行的问题) -->
<scriptSourceDirectory>${basedir}\src\main\scripts
</scriptSourceDirectory>
<!-- 指定单元测试的源码目录 -->
<testSourceDirectory>${basedir}\src\test\java</testSourceDirectory>
<!-- 编译源码的输出路径 -->
<outputDirectory>${basedir}\target\classes</outputDirectory>
<!-- 编译测试class文件存放的目录 -->
<testOutputDirectory>${basedir}\target\test-classes
</testOutputDirectory>
<!-- 构建扩展,它们是一系列build过程中要使用的产品，会包含在running bulid‘s classpath里面。 -->
<!-- 可以开启extensions，也可以通过提供条件来激活plugins，简单来讲 extensions 是在 build 过程被激活的产品 -->
<extensions>
<!--例如，通常情况下，程序开发完成后部署到线上Linux服务器，可能需要经历打包、 -->
<!--将包文件传到服务器、SSH连上服务器、敲命令启动程序等一系列繁琐的步骤。 -->
<!--实际上这些步骤都可以通过Maven的一个插件 wagon-maven-plugin 来自动完成 -->
<!--下面的扩展插件wagon-ssh用于通过SSH的方式连接远程服务器， -->
<!--类似的还有支持ftp方式的wagon-ftp插件 -->
<extension>
<groupId>org.apache.maven.wagon</groupId>
<artifactId>wagon-ssh</artifactId>
<version>2.8</version>
</extension>
</extensions>
<!--使用的插件列表 。 -->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.3.0</version>
<!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->
<executions>
<execution>
<!-- 唯一标识，或者匹配继承过程中需要合并的执行目标 -->
<id>assembly</id>
<!-- 指定插件执行动作时时要绑定的maven构建阶段 -->
<phase>package</phase>
<!-- 指定插件执行的动作 -->
<goals>
<goal>single</goal>
</goals>
<!--配置是否被传播到子POM -->
<inherited>false</inherited>
</execution>
</executions>
<!-- 插件行为配置 -->
<configuration>
<finalName>${finalName}</finalName>
<appendAssemblyId>false</appendAssemblyId>
<descriptor>assembly.xml</descriptor>
</configuration>
<!--是否从该插件下载Maven扩展（例如打包和类型处理器）， -->
<!--由于性能原因，只有在真需要下载时，该元素才被设置成true。 -->
<extensions>false</extensions>
<!--项目引入插件所需要的额外依赖 -->
<dependencies>
<dependency>
<groupId>org.ailun</groupId>
<artifactId>json</artifactId>
<version>2.4</version>
<classifier>jdk123</classifier>
</dependency>
</dependencies>
<!-- 任何配置是否被传播到子项目 -->
<inherited>true</inherited>
</plugin>
</plugins>
<!--主要定义插件的共同元素、扩展元素集合，类似于dependencyManagement， -->
<!--所有继承于此项目的子项目都能使用。该插件配置项直到被引用时才会被解析或绑定到生命周期。 -->
<!--给定插件的任何本地配置都会覆盖这里的配置 -->
<pluginManagement>
<plugins>...</plugins>
</pluginManagement>
</build>
三、发布配置
pom里面的仓库与setting.xml里的仓库功能是一样的。主要的区别在于，pom里的仓库是个性化的。比如一家大公司里的setting文件是公用的，所有项目都用一个setting文件，但各个子项目却会引用不同的第三方库，所以就需要在pom里设置自己需要的仓库地址。
<!-- 描述jar包要发布到目标仓库的配置,mvn deploy 触发 -->
<distributionManagement>
<repository>
<!-- 是分配给快照一个唯一的版本号（由时间戳和构建流水号），还是每次都使用相同的版本号 -->
<!-- 参见repositories/repository元素 -->
<uniqueVersion>true</uniqueVersion>
<id> 与setting.xml文件中的server对象id保持一致，可以取出下方url站点需要的登录令牌 </id>
<name> repo-name</name>
<url>file://${basedir}/target/deploy</url>
<!-- 仓库布局，默认是G/A/V按照这种目录顺序查找，一般都是默认 -->
<layout/>
</repository>
<!--构件的快照部署到哪里,如果没有配置该元素，默认部署到repository元素配置的仓库 -->
<snapshotRepository>
<uniqueVersion/>
<id/>
<name/>
<url/>
<layout/>
</snapshotRepository>
<!--部署项目的网站需要的信息 -->
<site>
<!--部署位置的唯一标识符，用来匹配站点和settings.xml文件里的配置 -->
<id> site-id </id>
<!--部署位置的名称 -->
<name> site-name</name>
<!--部署位置的URL，按protocol://hostname/path形式 -->
<url>scp://svn.baidu.com/banseon:/var/www/localhost/banseon-web </url>
</site>
<!-- 项目下载页面的URL。如果没有该元素，用户应该参考主页。 -->
<!-- 使用该元素的原因是：帮助定位那些不在仓库里的构件（由于license限制）。 -->
<downloadUrl/>
<!-- 如果项目有了新的groupID和artifact ID(移到了新的位置)，这里列出新的定位信息。 -->
<relocation>
<groupId/>
<artifactId/>
<version/>
<!--显示给用户的，关于移动的额外信息，例如原因。 -->
<message/>
</relocation>
<!--
给出该构件在远程仓库的状态。不得在本地项目中设置该元素，因为这是工具自动更新的。
有效的值有：none（默认），converted（仓库管理员从Maven 1 POM转换过来），
partner（直接从伙伴Maven 2仓库同步过来），deployed（从Maven 2实例部署），verified（被核实时正确的和最终的）。
-->
<status/>
</distributionManagement>
四、远程仓库配置
<!-- 用于管理从远程仓库(jar仓库)配置信息 -->
<repositories>
<!-- 一个远程仓库描述对象 -->
<repository>
<!-- 远程仓库里发布版本的jar包下载策略 -->
<releases>
<!-- 开关 -->
<enabled/>
<!--
定时比较策略。Maven会比较本地POM和远程POM的时间戳。
可选项：always（一直），daily（默认，每日），
interval：X（间隔分钟），或者never（从不）。
-->
<updatePolicy/>
<!--
当Maven验证构件校验文件失败时该怎么做：
可选项：ignore（忽略）、fail（失败）、warn（警告
-->
<checksumPolicy/>
</releases>
<!--
远程仓库里快照版本的jar包下载策略
POM可以在每个单独的仓库中，为每种类型的构件采取不同的策略。
例如，可能有人会决定只为开发目的开启对快照版本下载的支持
-->
<snapshots>
<enabled/>
<updatePolicy/>
<checksumPolicy/>
</snapshots>
<!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->
<id> repo-id </id>
<!-- 用于描述这个仓库，无实际作用 -->
<name> repo-name</name>
<!-- 远程仓库URL,最好是http协议 -->
<url>http://192.168.1.169:9999/repository/ </url>
<!--
用于定位和排序构件的仓库布局类型-可以是default（默认）或者legacy（遗留）。
Maven 2为其仓库提供了一个默认的布局；然而在Maven1.x有一种不同的布局。
我们可以使用该元素指定布局是default（默认）还是legacy（遗留）。
默认布局就是G/A/V(就指的是jar包存放在仓库中位置描述的规则),比如groupId/artifactId/version
-->
<layout> default</layout>
</repository>
</repositories>
<!-- 管理插件仓库配置信息 -->
<pluginRepositories>
<!-- 包含需要连接到远程插件仓库的信息.参见repositories/repository元素 -->
<pluginRepository />
</pluginRepositories>
五、profile配置
<!-- 配置片段列表 -->
<profiles>
<!-- 一个配置片段对象的描述 -->
<profile>
<!-- 自动激活当前配置片段的条件 -->
<activation>
<!-- 是否默认激活这个配置片段 -->
<activeByDefault>false</activeByDefault>
<!-- 含义：检测到是java8就激活这个配置片段 -->
<jdk>8</jdk>
<!-- 含义：检测当前操作系统信息，匹配到了就激活这个片段 -->
<os>
<!-- 检测操作系统的名字是否为 Windows XP -->
<name>Windows XP</name>
<!-- 检测操作系统所属家族(如 'windows') -->
<family>Windows</family>
<!-- 检测操作系统cpu位数 -->
<arch>x86</arch>
<!-- 检测操作系统版本 -->
<version>5.1.2600</version>
</os>
<!-- 含义：根据pom.xml中是否存在指定的属性去激活配置片段 -->
<property>
<!--
含义：当pom.xml中存在<mavenVersion>2.0.3</mavenVersion>的属性定义时激活这个配置片段
-->
<name>mavenVersion</name>
<value>2.0.3</value>
</property>
<!-- 含义：通过检测指定文件是否存在决定是否激活配置片段。 -->
<file>
<!-- 含义：检测指定文件存在则激活配置片段 -->
<exists>/workspace/a.txt</exists>
<!-- 与exists正相反 -->
<missing>/workspace/a.txt</missing>
</file>
</activation>
<id/>
<build/>
<modules/>
<repositories/>
<pluginRepositories/>
<dependencies/>
<reporting/>
<dependencyManagement/>
<distributionManagement/>
<properties/>
</profile>
setting.xml文件中也有profile配置，但却是pom.xml中profile元素的裁剪版本，仅包含id，activation, repositories, pluginRepositories和 properties元素，原因是setting.xml只关心构建系统这个整体（这正符合settings.xml文件是全局配置文件的角色定位），而非单独的项目对象模型设置。如果一个settings中的profile被激活，它的值会覆盖任何其它定义在POM中或者profile.xml中的带有相同id的profile。
pom.xml中的profile可以看做pom.xml的副本，拥有与pom.xml相同的子元素与配置方法。它包含可选的activation（profile的触发器）和一系列的配置片段。例如test过程可能会指向不同的数据库（相对最终的deployment）或者不同的dependencies或者不同的repositories，并且是根据不同的JDK来改变的。只需要其中一个成立就可以激活profile。
六、报表配置
<!-- 描述使用报表插件产生报表的规范,特定的maven 插件能输出相应的定制和配置报表 -->
<!-- 当用户执行“mvn site”，这些报表就会运行,在页面导航栏能看到所有报表的链接。 -->
<reporting>
<!-- true，则网站不包括默认的报表。这包括“项目信息”菜单中的报表。 -->
<excludeDefaults/>
<!--所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 -->
<outputDirectory/>
<!--使用的报表插件和插件的配置。 -->
<plugins>
<plugin>
<groupId/>
<artifactId/>
<version/>
<inherited/>
<configuration>
<links>
<link>http://java.sun.com/j2se/1.5.0/docs/api/</link>
</links>
</configuration>
<!--一组报表的多重规范，每个规范可能有不同的配置。 -->
<!--一个规范（报表集）对应一个执行目标 。例如，有1，2，3，4，5，6，7，8，9个报表。 -->
<!--1，2，5构成A报表集，对应一个执行目标。2，5，8构成B报表集，对应另一个执行目标 -->
<reportSets>
<!--表示报表的一个集合，以及产生该集合的配置 -->
<reportSet>
<!--报表集合的唯一标识符，POM继承时用到 -->
<id>sunlink</id>
<!--产生报表集合时，被使用的报表的配置 -->
<configuration />
<!--配置是否被继承到子POMs -->
<inherited />
<!--这个集合里使用到哪些报表 -->
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
七、持续集成与问题管理配置
<!-- 项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL，本例为 jira -->
<issueManagement>
<!--问题管理系统（例如jira）的名字 -->
<system> jira </system>
<!--该项目使用的问题管理系统的URL -->
<url> http://jira.clf.com/</url>
</issueManagement>
<!--项目持续集成信息 -->
<ciManagement>
<!--持续集成系统的名字，例如continuum -->
<system/>
<!--该项目使用的持续集成系统的URL（如果持续集成系统有web接口的话）。 -->
<url/>
<!--构建完成时，需要通知的开发者/用户的配置项。包括被通知者信息和通知条件（错误，失败，成功，警告） -->
<notifiers>
<!--配置一种方式，当构建中断时，以该方式通知用户/开发者 -->
<notifier>
<!--传送通知的途径 -->
<type/>
<!--发生错误时是否通知 -->
<sendOnError/>
<!--构建失败时是否通知 -->
<sendOnFailure/>
<!--构建成功时是否通知 -->
<sendOnSuccess/>
<!--发生警告时是否通知 -->
<sendOnWarning/>
<!--不赞成使用。通知发送到哪里 -->
<address/>
<!--扩展配置项 -->
<configuration/>
</notifier>
</notifiers>
</ciManagement>
八、项目信息配置
<!-- 项目的名称, Maven产生的文档用 -->
<name>banseon-maven</name>
<!--项目主页的URL, Maven产生的文档用 -->
<url>http://www.clf.com/ </url>
<!-- 项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时 -->
<!--（例如，CDATA中的文本会被解析器忽略，就可以包含HTML标签），不鼓励使用纯文本描述。 -->
<!-- 如果你需要修改产生的web站点的索引页面，你应该修改你自己的索引页文件，而不是调整这里的文档。 -->
<description>A maven project to study maven. </description>
<!--描述了这个项目构建环境中的前提条件。 -->
<prerequisites>
<!--构建该项目或使用该插件所需要的Maven的最低版本 -->
<maven/>
</prerequisites>
<!--项目创建年份，4位数字。当产生版权信息时需要使用这个值。 -->
<inceptionYear/>
<!--项目相关邮件列表信息 -->
<mailingLists>
<!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->
<mailingList>
<!--邮件的名称 -->
<name> Demo </name>
<!--发送邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
<post> clf@126.com</post>
<!--订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
<subscribe> clf@126.com</subscribe>
<!--取消订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
<unsubscribe> clf@126.com</unsubscribe>
<!--你可以浏览邮件信息的URL -->
<archive> http:/hi.clf.com/</archive>
</mailingList>
</mailingLists>
<!-- 项目主要开发者列表 -->
<developers>
<!-- 某个项目开发者的信息 -->
<developer>
<!--SCM里项目开发者的唯一标识符 -->
<id> HELLO WORLD </id>
<!--项目开发者的全名 -->
<name> banseon </name>
<!--项目开发者的email -->
<email> banseon@126.com</email>
<!--项目开发者的主页的URL -->
<url/>
<!--项目开发者在项目中扮演的角色，角色元素描述了各种角色 -->
<roles>
<role> Project Manager</role>
<role>Architect </role>
</roles>
<!--项目开发者所属组织 -->
<organization> demo</organization>
<!--项目开发者所属组织的URL -->
<organizationUrl>http://hi.clf.com/ </organizationUrl>
<!--项目开发者属性，如即时消息如何处理等 -->
<properties>
<dept> No </dept>
</properties>
<!--项目开发者所在时区， -11到12范围内的整数。 -->
<timezone> -5</timezone>
</developer>
</developers>
<!-- 项目的其他贡献者列表 -->
<contributors>
<!--项目的其他贡献者。参见developers/developer元素 -->
<contributor>
<name/>
<email/>
<url/>
<organization/>
<organizationUrl/>
<roles/>
<timezone/>
<properties/>
</contributor>
</contributors>
<!--该元素描述了项目所有License列表。应该只列出该项目的license列表，不要列出依赖项目的license列表。 -->
<!--如果列出多个license，用户可以选择它们中的一个而不是接受所有license。 -->
<licenses>
<!--
描述了项目的license，用于生成项目的web站点的license页面，其他一些报表和validation也会用到该元素。
-->
<license>
<!-- 项目使用的版权协议 -->
<name> Apache 2 </name>
<!--官方的license正文页面的URL -->
<url>http://www.clf.com/LICENSE-2.0.txt </url>
<!--项目分发的主要方式： repo，可以从Maven库下载 manual， 用户必须手动下载和安装依赖 -->
<distribution>repo</distribution>
<!--关于license的补充信息 -->
<comments> Abusiness-friendly OSS license </comments>
</license>
</licenses>
<!--SCM(Source Control Management)标签允许你配置你的代码库，供Maven web站点和其它插件使用。 -->
<scm>
<!--
SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情，请看SCMs提供的URL格式和列表。该连接只读。
-->
<connection>scm:svn:http://svn.baidu.com/banseon/maven/</connection>
<!--给开发者使用的，类似connection元素。即该连接不仅仅只读 -->
<developerConnection>
scm:svn:http://svn.baidu.com/banseon/maven/
</developerConnection>
<!--当前代码的标签，在开发阶段默认为HEAD -->
<tag/>
<!--指向项目的可浏览SCM库（例如ViewVC或者Fisheye）的URL。 -->
<url> http://svn.baidu.com/banseon</url>
</scm>
<!--描述项目所属组织的各种属性。Maven产生的文档用 -->
<organization>
<!--组织的全名 -->
<name> demo </name>
<!--组织主页的URL -->
<url> http://www.clf.com/</url>
</organization>
