全面详解Maven的配置文件pom.xml
转载地址:https://www.cnblogs.com/mountainstudy/p/17953638
一、什么是pom.xml
pom.xml是Maven项目的核心配置文件,它是 项目对象模型 - Project Object Model(POM)的缩写。POM定义了项目的所有属性,包括项目的名称、版本、依赖关系、构建配置等。使用pom.xml,我们可以轻松地管理项目的构建和依赖关系,让我们能够更专注于业务逻辑的开发。
二、pom.xml的结构
我们先看一个简单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 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>example-proj</artifactId>
<version>1.0.0</version>
<name>Example Project</name>
<description>This is an example Maven project.</description>
<url>http://www.example.com/</url>
<licenses> <!-- 许可证 -->
<license>
<name>The Apache Software License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
<distribution>repo</distribution>
</license>
</licenses>
<developers> <!-- 开发者信息 -->
<developer>
<id>developer1</id>
<name>Developer One</name>
<email>developer1@example.com</email>
<organization>Example Organizations Inc.</organization>
<organizationUrl>http://www.example-organizations.com/</organizationUrl>
<roles>
<role>developer</role>
</roles>
<timezone>-5</timezone>
</developer>
</developers>
<dependencies> <!-- 依赖项 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.2.1.RELEASE</version>
</dependency>
</dependencies>
<build> <!-- 项目构建 -->
<plugins> <!-- 插件配置 -->
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<mainClass>com.example.App</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
</plugins>
</build>
</project>
其中<modelVersion>
指定了pom.xml文件使用的XML schema版本,目前,其最新的版本是4.0.0。其他部分我们会在下面进行详解
三、项目的基本信息
与项目的基本信息相关的标签有很多,以下算必填项:
-
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.parent</groupId>
<artifactId>parent-project</artifactId>
<version>1.0.0</version>
<packaging>pom</packaging>
<modules>
<module>child1</module>
<module>child2</module>
<module>child3</module>
</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.child</groupId>
<artifactId>child-project</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<parent>
<groupId>com.example.parent</groupId>
<artifactId>parent-project</artifactId>
<version>1.0.0</version>
<relativePath>../parent-project/pom.xml</relativePath>
</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>
<!-- 指定连接到SCM的URL,可以使用HTTP或者SSH协议 -->
<connection>scm:git:git://github.com/username/repo.git</connection>
<!-- 指定开发者连接到SCM的URL,通常使用SSH协议 -->
<developerConnection>scm:git:ssh://github.com/username/repo.git</developerConnection>
<!-- 指定SCM的web页面URL,方便开发者查看SCM信息 -->
<url>http://github.com/username/repo/tree/master</url>
<!-- 当前Maven构件的版本在SCM中对应的标记 -->
<tag>1.0.0</tag>
</scm>
developerConnection 与 connection 有些许不同,connection 可以指向一个本地文件系统路径,也可以是一个远程代码仓库的URL;developerConnection 则是开发者使用的版本控制系统的连接URL,例如connection指向只读代码仓库,而developerConnection则指向可写代码仓库。
通过在POM文件中添加scm标签,Maven可以获取源代码并构建项目,同时还可以自动将构建生成的文件提交到版本控制系统中,方便管理代码版本和协同开发
4、properties
properties
严格来说,并不一定是项目本身的信息,而是人为设置的属性或者说宏,这个标签用来定义和管理项目中所需要的属性,其作用有以下几个:
- 统一管理项目中的常用属性,比如版本号、路径、插件版本等,方便统一修改和管理。
- 可以在配置过程中使用 ${…}占位符引用这些属性,使得配置更加灵活和便捷。
- 避免硬编码,提高代码的可维护性和可读性
比如说我们可以这么配:
<properties>
<project.name>demo-project</project.name>
<project.version>1.0.0</project.version>
<jdk.version>1.8</jdk.version>
</properties>
....省略其余部分
<dependency>
<groupId>com.example.demo</groupId>
<artifactId>${project.name}-api</artifactId>
<version>${project.version}</version>
</dependency>
四、项目的依赖列表
1、dependency
与项目的依赖列表相关的标签最外层由 <dependencies>
来囊括,内部包含了各种具体的依赖<dependency>
,该标签用于指定一个依赖项,它包含以下几个子标签
<groupId>
:指定依赖项的groupId,项目的组名<artifactId>
:指定依赖项的artifactId,项目的唯一标识符<version>
:指定依赖项的版本号。<scope>
:指定依赖项在项目中的使用范围。
其中的 <scope>
一般包含以下几种范围:常用的有compile、test、provided 和 runtime:
- compile:依赖库默认的 scope,表示该依赖库在编译、测试、运行时均需要使用。
- provided:表示该依赖库只在编译和测试时需要使用,而在运行时已经被系统或者容器提供,所以不需要打包到最终的应用程序中。
- runtime:表示该依赖库只在运行时需要使用,而在编译和测试时则不需要。
- test:表示该依赖库只在测试时需要使用,而在编译和运行时则不需要。
比如说我们引入了 junit 包,但显然这个包我们不需要在打包时包含,只是用于测试,那么我们就可以将 junit 的 scope 设置为 test。
2、repository
当然,我们还能在pom文件中支持指定Maven仓库,即使用 <repositories>
和 <repository>
标签,<repository>
用于指定一个Maven仓库,它包含以下几个子标签:
<id>
:指定Maven仓库的ID。<name>
:指定Maven仓库的名称。<url>
:指定Maven仓库的URL
五、 项目的构建配置
项目的构建配置信息,包括编译器版本、插件列表、源代码目录等,接下来我们慢慢来讲
1、build
build
用于定义项目的构建配置,包括源代码目录、资源目录、插件等,其中代码部分的设置如下
<project>
.... 省略其他部分
<build>
<sourceDirectory>src/main/java</sourceDirectory>
<resources>
<resource>
<directory>src/main/resources</directory>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins>
</build>
</project>
需要注意的是,像资源目录这种路径是没有默认值的,但根据Maven的约定优于配置原则(Convention over Configuration),Maven会使用默认的目录结构去查找源代码和测试代码。默认的目录结构如下:
|--src
|--main
|--java // Java主源代码目录
|--resources // 资源文件目录
|--test
|--java // 测试主代码目录
|--resources // 测试资源文件目录
因此,在一个标准的Maven项目中,sourceDirectory默认值应该是src/main/java。如果有自定义的代码目录结构,需要显式地设置sourceDirectory元素的值。例如,如果有一个名为“core”的子目录作为项目的主源代码目录,可以按以下方式进行配置:
<build>
<sourceDirectory>core</sourceDirectory>
...
</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.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
<encoding>UTF-8</encoding>
<showWarnings>true</showWarnings>
<compilerArgs>
<arg>-Xlint:unchecked</arg>
<arg>-Xlint:deprecation</arg>
</compilerArgs>
</configuration>
</plugin>
</plugins>
</build>
各子标签的作用如下:
<source>
:指定Java源代码的版本,例如1.8表示Java 8。<target>
:指定编译后的字节码版本,例如1.8表示Java 8。<encoding>
:指定源代码的编码格式。<showWarnings>
:是否显示编译警告信息,true表示显示,false表示不显示。<compilerArgs>
:可选参数,可以添加多个编译器参数,例如-Xlint选项用来启用编译器警告检查。
如果我们按示例中配置,我们就指定了编译器的源和目标版本为1.8,当我们使用 mvn compile
命令的时候,这个插件将会编译我们的 Java 代码,并将编译后的 class 文件放置在 target 目录下
maven-surefire-plugin
maven-surefire-plugin插件是Maven中的一个测试框架,用于执行Java单元测试和集成测试。它的主要作用是在构建过程中运行测试,并生成测试报告,在pom.xml中的配置如下:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.0.0-M4</version>
<configuration>
<skipTests>true</skipTests>
<forkCount>2</forkCount>
<useSystemClassLoader>false</useSystemClassLoader>
<reuseForks>true</reuseForks>
<includes>
<include>**/*Test.java</include>
<include>**/*Tests.java</include>
</includes>
<systemProperties>
<property>
<name>testProp1</name>
<value>value1</value>
</property>
<property>
<name>testProp2</name>
<value>value2</value>
</property>
</systemProperties>
</configuration>
</plugin>
</plugins>
</build>
其中几个子标签的作用分别如下:
-
<skipTests>
:设置是否跳过测试,默认值为false。 -
<forkCount>
:设置并行运行测试的JVM进程数。 -
<useSystemClassLoader>
:设置是否使用系统类加载器加载测试类。 -
<reuseForks>
:设置是否重用已经启动的JVM进程。 -
<includes>
:设置测试文件的过滤规则,支持通配符。 -
<systemProperties>
:设置传递给测试环境的系统属性,可以在测试代码中通过System.getProperty()方法获取
maven-jar-plugin
maven-jar-plugin 用于将项目打包为JAR文件,在这个例子中,我们告诉Maven将com.example.MyApp作为JAR文件的主类,那么在pom.xml中的配置如下:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
<mainClass>com.example.MyApp</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
</plugins>
</build>
<archive>
:JAR文件的归档配置信息<manifest>
:MANIFEST.MF文件的配置信息<addClasspath>
:是否将依赖项添加到Class-Path条目中<mainClass>
:定义可执行JAR文件的入口类
maven-install-plugin
当执行mvn instal
命令时,maven-install-plugin 用于将一个特定的文件安装到本地Maven仓库中,以便其他项目可以使用它,例如在pom.xml中的配置如下:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<version>3.0.0-M1</version>
<configuration>
<file>${project.build.directory}/example.jar</file>
<groupId>com.example</groupId>
<artifactId>example</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
</configuration>
</plugin>
-
<file>
:用来指定要安装到本地Maven仓库中的文件的路径。该标签的值应该是一个文件的绝对或相对路径。 -
<groupId>
:通过该标签设置所安装文件的groupId,通常表示项目的组织或组织部门的标识符。 -
<artifactId>
:同样是通过该标签设置所安装文件的artifactId,通常是指该文件的名称。 -
<version>
:通过该标签设置所安装文件的版本号,通常采用三级版本号的格式,例如"1.0.0"。 -
<packaging>
:通过该标签来指定所安装文件的打包类型,通常是jar或war。
需要注意的是,<file>
标签必须与<groupId>
、<artifactId>
和<version>
标签一起使用,才能正确将该文件安装到本地Maven仓库中,并在其他项目中使用,除了以上的配置,还有一些可选的配置项:
:通过该标签指定所安装文件的分类器,例如"sources"或"javadoc"等,默认为null。
:通过该标签指定本地仓库的路径,默认为Maven默认的本地仓库路径。
:是否在安装文件时创建SHA-1校验和,默认为true。
:是否跳过该插件的运行,默认为false,即不跳过。
maven-clean-plugin
maven-clean-plugin 用于清理Maven项目中的目标文件和构建临时文件,以便重新构建项目。它通常被用于在构建之前清理项目,以确保在构建时使用最新的代码和资源ar文件,在pom.xml中的配置如下:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
<executions>
<execution>
<id>clean-all</id>
<phase>clean</phase>
<goals>
<goal>clean</goal>
</goals>
<configuration>
<excludeDefaultDirectories>true</excludeDefaultDirectories>
<filesets>
<fileset>
<directory>target</directory>
<includes>
<include>**/*</include>
</includes>
</fileset>
</filesets>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
该配置中,maven-clean-plugin的版本号是3.1.0,它在clean阶段(phase标签指定)执行,使用的目标是clean。下面是各个子标签的作用:
-
<excludeDefaultDirectories>
:默认值为false,如果设置为true,则禁用清理操作中默认清理的目录(如target、bin等)。 -
<filesets>
:文件集合,可以指定多个文件或文件夹需要被清理。 -
<fileset>
:单个的文件或文件夹。 -
<directory>
:需要清理的文件夹路径。 -
<includes>
:需要包含的文件或文件夹,支持通配符。 -
<excludes>
:需要排除的文件或文件夹,支持通配符
至于通配符,使用规则如下:
* 匹配零个或多个字符
** 匹配零个或多个目录
需要注意的是,Maven的通配符仅支持*和**,不支持其他通配符,例如?。同时,通配符匹配的范围是相对于构建目录的,也就是默认情况下是相对于pom.xml文件的目录
maven-release-plugin
maven-release-plugin 可以帮助我们在代码库中创建一个稳定的发布版本,并将其发布到Maven仓库中,同时更新开发版本号,以便于下次开发版本的迭代,它可以做如下配置
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.2</version>
<configuration>
<tagNameFormat>v@{project.version}</tagNameFormat>
<tagBase>http://svn.example.com/tags</tagBase>
<autoVersionSubmodules>true</autoVersionSubmodules>
<releaseProfiles>release</releaseProfiles>
<branchBase>http://svn.example.com/branches</branchBase>
</configuration>
</plugin>
</plugins>
</build>
-
<tagNameFormat>
: 指定发布版本的标签格式,@{project.version}会被替换为项目的版本号。在上面的配置中,标签格式为v@{project.version}。 -
<tagBase>
: 用于指定打标签的位置,默认值为 ${project.scm.url},即和项目的 SCM 地址相同。 -
<autoVersionSubmodules>
: 是否自动更新子模块的版本号。如果设置为true,则子模块的版本号会自动更新为父模块的版本号。 -
<releaseProfiles>
: 指定触发发布的Maven profile。只有在激活该profile后才会触发发布操作。在上面的配置中,只有当profile名称为release时,才会触发发布操作,关于profile,我们下面会讲 -
<branchBase>
:用于指定创建分支的位置,默认值同 tagBase,即和项目的 SCM 地址相同。
3、profiles
profiles
用于定义 Maven 运行时的不同配置环境,比如开发环境、测试环境、生产环境等,可以在不同的环境中使用不同的配置,比如我们做了如下配置
<profiles>
<profile>
<id>prod</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<release>11</release>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
-
<id>
标签指定profile的唯一标识符。 -
<activation>
标签指定何时使用该profile。在示例中,activeByDefault设置为true表示默认启用该profile。0 -
<build>
标签包含一组构建配置,这些配置将在激活profile时覆盖默认配置。在示例中,它定义了maven-compiler-plugin插件的版本和为Java 11设置编译器版本。
在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等信息。插件可以帮助我们处理各种构建任务,比如编译代码、生成文档、打包文件等。
七、Maven 生命周期和插件
Maven 的构建过程是由一系列的生命周期和插件来管理的。了解Maven的生命周期和插件,有助于理解项目的构建过程,以及在构建过程中可以执行哪些任务。
Maven 生命周期
Maven生命周期是一系列阶段的集合,定义了项目的构建过程。常用的生命周期包括:
-
clean: 清理项目,删除
target
目录。 -
validate: 验证项目是否正确。
-
compile: 编译项目的源代码。
-
test: 使用单元测试框架运行测试。
-
package: 将编译好的代码打包成可分发的格式,比如JAR。
-
verify: 对集成测试的结果进行验证,以保证质量。
-
install: 将打包好的项目发布到本地仓库。
-
deploy: 将项目发布到远程仓库。
这些生命周期是顺序执行的,你可以在某一个生命周期的阶段执行自定义的插件任务。
<build>
<!--扫描文件资源-->
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
</resources>
<!--插件-->
<pluginManagement><!-- lock down plugins versions to avoid
using Maven defaults (may be moved to parent pom) -->
<plugins>
<!-- clean lifecycle, see https://maven.apache.org/ref/current
/maven-core/lifecycles.html#clean_Lifecycle -->
<plugin>
<artifactId>maven-clean-plugin</artifactId>
<version>3.1.0</version>
</plugin>
<!-- default lifecycle, jar packaging: see
https://maven.apache.org/ref/current/maven-core/default-
bindings.html#Plugin_bindings_for_jar_packaging -->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.0</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
</plugin>
<plugin>
<artifactId>maven-jar-plugin</artifactId>
<version>3.0.2</version>
</plugin>
<plugin>
<artifactId>maven-install-plugin</artifactId>
<version>2.5.2</version>
</plugin>
<plugin>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
<!-- site lifecycle, see https://maven.apache.org/ref/current/
maven-core/lifecycles.html#site_Lifecycle -->
<plugin>
<artifactId>maven-site-plugin</artifactId>
<version>3.7.1</version>
</plugin>
<plugin>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>3.0.0</version>
</plugin>
</plugins>
</pluginManagement>
</build>
Maven 插件
Maven 插件是执行构建任务的工具,它们与生命周期和阶段相关联。常见的插件包括:
-
maven-compiler-plugin: 用于编译Java源代码。
-
maven-surefire-plugin: 用于执行单元测试。
-
maven-jar-plugin: 用于打包JAR文件。
-
maven-failsafe-plugin: 用于执行集成测试。
在 pom.xml
文件中,可以通过配置插件来定制项目的构建过程。以下是一个例子,使用 maven-compiler-plugin
插件配置Java编译器版本:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins>
</build>
这里,我们配置了 maven-compiler-plugin
插件,指定了Java源代码和目标字节码的版本。
八、Maven 多模块项目
Maven支持多模块项目,通过模块化的方式组织代码和资源。多模块项目的结构类似于单模块项目,但包含了额外的父模块和子模块。
创建父模块
首先,创建一个父模块的Maven项目,用于管理子模块。在命令行中执行:
mvn archetype:generate -DgroupId=com.example -DartifactId=my-parent-module -DarchetypeArtifactId=maven-archetype-pom -DinteractiveMode=false
这个命令使用了 maven-archetype-pom
模板,生成了一个空的父模块项目。
创建子模块
在父模块的目录下,创建两个子模块的Maven项目:
mkdir my-child-module1
cd my-child-module1
mvn archetype:generate -DgroupId=com.example -DartifactId=my-child-module1 -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
cd ..
mkdir my-child-module2
cd my-child-module2
mvn archetype:generate -DgroupId=com.example -DartifactId=my-child-module2 -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
cd ..
这样,我们得到了一个父模块和两个子模块的多模块项目结构。
父模块的 pom.xml
在父模块的 pom.xml
文件中,使用 <modules>
元素列出所有子模块:
<modules>
<module>my-child-module1</module>
<module>my-child-module2</module>
</modules>
这个配置告诉Maven父模块下有哪些子模块。
子模块的 pom.xml
在每个子模块的 pom.xml
文件中,需要指定父模块的信息。例如:
<parent>
<groupId>com.example</groupId>
<artifactId>my-parent-module</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>my-child-module1</artifactId>
这样,每个子模块都知道它们的父模块是谁,以及从父模块继承的信息。
构建多模块项目
在父模块的目录下执行Maven命令:
mvn clean install
这个命令将递归构建所有子模块,并将它们安装到本地仓库。你可以在每个子模块中执行单独的Maven命令,或者在父模块中执行命令。
cd my-parent-module
mvn clean install
这样,就完成了一个简单的多模块Maven项目的创建和构建。
九、Maven 高级特性
Maven 插件配置
在Maven中,插件配置是非常灵活的。你可以为插件定义各种配置参数,以满足项目的需求。
<build>
<plugins>
<!-- Maven Compiler 插件配置 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<!-- Maven Surefire 插件配置 -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
<configuration>
<skipTests>false</skipTests>
<testFailureIgnore>true</testFailureIgnore>
</configuration>
</plugin>
</plugins>
</build>
在这个例子中,我们为 maven-compiler-plugin
和 maven-surefire-plugin
插件配置了一些参数,比如Java版本和测试配置。
Maven Profiles
Maven允许使用profiles来定义一组构建配置,以便根据不同的环境或需求执行不同的构建。在 pom.xml
文件中,可以通过 <profiles>
元素定义不同的profile。
<profiles>
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<environment>dev</environment>
</properties>
</profile>
<profile>
<id>prod</id>
<properties>
<environment>prod</environment>
</properties>
</profile>
</profiles>
在这个例子中,我们定义了两个profile,一个是dev,一个是prod。在执行Maven命令时,可以通过 -P
参数指定要激活的profile。
mvn clean install -P prod
这样,可以根据不同的profile执行不同的构建逻辑。
Maven 插件编写
Maven插件是Maven项目的基础。如果你有特定的构建需求,而现有的插件无法满足,你可以考虑编写自己的Maven插件。
插件编写涉及到Java编程和Maven插件的结构。通常,一个Maven插件项目包含以下几个部分:
-
Mojo(目标): 插件的基本执行单元,定义了插件的一个具体任务。
-
Plugin: 插件的配置和描述,定义了插件的名称、目标等。
-
PluginDescriptor: 插件的描述信息,包括插件的目标、参数等。
-
PluginManager: 插件的管理器,用于加载和执行插件。
这里只是简单提及插件编写的主要部分,具体的插件编写涉及到更多的细节和实践。
推荐几个好的 Maven 常用仓库网址:
http://mvnrepository.com/
http://search.maven.org/
http://repository.sonatype.org/content/groups/public/
http://people.apache.org/repo/m2-snapshot-repository/
http://people.apache.org/repo/m2-incubating-repository/
十、pom.xml文件的其他参数详解
参考:https://blog.csdn.net/weixin_47061482/article/details/109817802
<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">
<!--父项目的坐标。如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值。 坐标包括group ID,artifact ID和 version。 -->
<parent>
<!--被继承的父项目的构件标识符 -->
<artifactId />
<!--被继承的父项目的全球唯一标识符 -->
<groupId />
<!--被继承的父项目的版本 -->
<version />
<!--父项目的pom.xml文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。Maven首先在构建当前项目的地方寻找父项目的pom,其次在文件系统的这个位置(relativePath位置),然后在本地仓库,最后在远程仓库寻找父项目的pom。 -->
<relativePath />
</parent>
<!--声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的,这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。 -->
<modelVersion>4.0.0</modelVersion>
<!--项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成, 如com.mycompany.app生成的相对路径为:/com/mycompany/app -->
<groupId>asia.banseon</groupId>
<!--构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID和groupID;在某个特定的group
ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven为项目产生的构件包括:JARs,源码,二进制发布和WARs等。 -->
<artifactId>banseon-maven2</artifactId>
<!--项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型 -->
<packaging>jar</packaging>
<!--项目当前版本,格式为:主版本.次版本.增量版本-限定版本号 -->
<version>1.0-SNAPSHOT</version>
<!--项目的名称, Maven产生的文档用 -->
<name>banseon-maven</name>
<!--项目主页的URL, Maven产生的文档用 -->
<url>http://www.baidu.com/banseon</url>
<!--项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略,就可以包含HTML标签),
不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档。 -->
<description>A maven project to study maven.</description>
<!--描述了这个项目构建环境中的前提条件。 -->
<prerequisites>
<!--构建该项目或使用该插件所需要的Maven的最低版本 -->
<maven />
</prerequisites>
<!--项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL,本例为 jira -->
<issueManagement>
<!--问题管理系统(例如jira)的名字, -->
<system>jira</system>
<!--该项目使用的问题管理系统的URL -->
<url>http://jira.xxxx.com/xxxx</url>
</issueManagement>
<!--项目持续集成信息 -->
<ciManagement>
<!--持续集成系统的名字,例如continuum -->
<system />
<!--该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。 -->
<url />
<!--构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告) -->
<notifiers>
<!--配置一种方式,当构建中断时,以该方式通知用户/开发者 -->
<notifier>
<!--传送通知的途径 -->
<type />
<!--发生错误时是否通知 -->
<sendOnError />
<!--构建失败时是否通知 -->
<sendOnFailure />
<!--构建成功时是否通知 -->
<sendOnSuccess />
<!--发生警告时是否通知 -->
<sendOnWarning />
<!--不赞成使用。通知发送到哪里 -->
<address />
<!--扩展配置项 -->
<configuration />
</notifier>
</notifiers>
</ciManagement>
<!--项目创建年份,4位数字。当产生版权信息时需要使用这个值。 -->
<inceptionYear />
<!--项目相关邮件列表信息 -->
<mailingLists>
<!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->
<mailingList>
<!--邮件的名称 -->
<name>Demo</name>
<!--发送邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->
<post>Demo@126.com</post>
<!--订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->
<subscribe>Demo@126.com</subscribe>
<!--取消订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->
<unsubscribe>Demo@126.com</unsubscribe>
<!--你可以浏览邮件信息的URL -->
<archive>http://localhost:8080/demo/dev/</archive>
</mailingList>
</mailingLists>
<!--项目开发者列表 -->
<developers>
<!--某个项目开发者的信息 -->
<developer>
<!--SCM里项目开发者的唯一标识符 -->
<id>HELLO WORLD</id>
<!--项目开发者的全名 -->
<name>youname</name>
<!--项目开发者的email -->
<email>youname@qq.com</email>
<!--项目开发者的主页的URL -->
<url />
<!--项目开发者在项目中扮演的角色,角色元素描述了各种角色 -->
<roles>
<role>Project Manager</role>
<role>Architect</role>
</roles>
<!--项目开发者所属组织 -->
<organization>demo</organization>
<!--项目开发者所属组织的URL -->
<organizationUrl>http://www.xxx.com/</organizationUrl>
<!--项目开发者属性,如即时消息如何处理等 -->
<properties>
<dept>No</dept>
</properties>
<!--项目开发者所在时区, -11到12范围内的整数。 -->
<timezone>+8</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>
<!--license用于法律上的名称 -->
<name>Apache 2</name>
<!--官方的license正文页面的URL -->
<url>http://www.xxxx.com/LICENSE-2.0.txt</url>
<!--项目分发的主要方式: repo,可以从Maven库下载 manual, 用户必须手动下载和安装依赖 -->
<distribution>repo</distribution>
<!--关于license的补充信息 -->
<comments>A business-friendly OSS license</comments>
</license>
</licenses>
<!--SCM(Source Control Management)标签允许你配置你的代码库,供Maven web站点和其它插件使用。 -->
<scm>
<!--SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情,请看SCMs提供的URL格式和列表。该连接只读。 -->
<connection>
scm:svn:http://svn.xxxx.com/maven/xxxxx-maven2-trunk(dao-trunk)
</connection>
<!--给开发者使用的,类似connection元素。即该连接不仅仅只读 -->
<developerConnection>
scm:svn:http://svn.xxxx.com/maven/dao-trunk
</developerConnection>
<!--当前代码的标签,在开发阶段默认为HEAD -->
<tag />
<!--指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。 -->
<url>http://svn.xxxxx.com/</url>
</scm>
<!--描述项目所属组织的各种属性。Maven产生的文档用 -->
<organization>
<!--组织的全名 -->
<name>demo</name>
<!--组织主页的URL -->
<url>http://www.xxxxxx.com/</url>
</organization>
<!--构建项目需要的信息 -->
<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>
<!--在列的项目构建profile,如果被激活,会修改构建处理 -->
<profiles>
<!--根据环境参数或命令行参数激活某个构建处理 -->
<profile>
<!--构建配置的唯一标识符。即用于命令行激活,也用于在继承时合并具有相同标识符的profile。 -->
<id />
<!--自动触发profile的条件逻辑。Activation是profile的开启钥匙。profile的力量来自于它 能够在某些特定的环境中自动使用某些特定的值;这些环境通过activation元素指定。activation元素并不是激活profile的唯一方式。 -->
<activation>
<!--profile默认是否激活的标志 -->
<activeByDefault />
<!--当匹配的jdk被检测到,profile被激活。例如,1.4激活JDK1.4,1.4.0_2,而!1.4激活所有版本不是以1.4开头的JDK。 -->
<jdk />
<!--当匹配的操作系统属性被检测到,profile被激活。os元素可以定义一些操作系统相关的属性。 -->
<os>
<!--激活profile的操作系统的名字 -->
<name>Windows XP</name>
<!--激活profile的操作系统所属家族(如 'windows') -->
<family>Windows</family>
<!--激活profile的操作系统体系结构 -->
<arch>x64</arch>
<!--激活profile的操作系统版本 -->
<version>6.1.7100</version>
</os>
<!--如果Maven检测到某一个属性(其值可以在POM中通过${名称}引用),其拥有对应的名称和值,Profile就会被激活。如果值 字段是空的,那么存在属性名称字段就会激活profile,否则按区分大小写方式匹配属性值字段 -->
<property>
<!--激活profile的属性的名称 -->
<name>mavenVersion</name>
<!--激活profile的属性的值 -->
<value>2.0.3</value>
</property>
<!--提供一个文件名,通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在,如果不存在则激活 profile。另一方面,exists则会检查文件是否存在,如果存在则激活profile。 -->
<file>
<!--如果指定的文件存在,则激活profile。 -->
<exists>/usr/local/xxxx/xxxx-home/tomcat/maven-guide-zh-to-production/workspace/
</exists>
<!--如果指定的文件不存在,则激活profile。 -->
<missing>/usr/local/xxxx/xxxx-home/tomcat/maven-guide-zh-to-production/workspace/
</missing>
</file>
</activation>
<!--构建项目所需要的信息。参见build元素 -->
<build>
<defaultGoal />
<resources>
<resource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</resource>
</resources>
<testResources>
<testResource>
<targetPath />
<filtering />
<directory />
<includes />
<excludes />
</testResource>
</testResources>
<directory />
<finalName />
<filters />
<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>
</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>
<!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 -->
<modules />
<!--发现依赖和扩展的远程仓库列表。 -->
<repositories>
<!--参见repositories/repository元素 -->
<repository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<id />
<name />
<url />
<layout />
</repository>
</repositories>
<!--发现插件的远程仓库列表,这些插件用于构建和报表 -->
<pluginRepositories>
<!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素 -->
<pluginRepository>
<releases>
<enabled />
<updatePolicy />
<checksumPolicy />
</releases>
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<id />
<name />
<url />
<layout />
</pluginRepository>
</pluginRepositories>
<!--该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。 -->
<dependencies>
<!--参见dependencies/dependency元素 -->
<dependency>......</dependency>
</dependencies>
<!--不赞成使用. 现在Maven忽略该元素. -->
<reports />
<!--该元素包括使用报表插件产生报表的规范。当用户执行“mvn site”,这些报表就会运行。 在页面导航栏能看到所有报表的链接。参见reporting元素 -->
<reporting>......</reporting>
<!--参见dependencyManagement元素 -->
<dependencyManagement>
<dependencies>
<!--参见dependencies/dependency元素 -->
<dependency>......</dependency>
</dependencies>
</dependencyManagement>
<!--参见distributionManagement元素 -->
<distributionManagement>......</distributionManagement>
<!--参见properties元素 -->
<properties />
</profile>
</profiles>
<!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 -->
<modules />
<!--发现依赖和扩展的远程仓库列表。 -->
<repositories>
<!--包含需要连接到远程仓库的信息 -->
<repository>
<!--如何处理远程仓库里发布版本的下载 -->
<releases>
<!--true或者false表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->
<enabled />
<!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳。这里的选项是:always(一直),daily(默认,每日),interval:X(这里X是以分钟为单位的时间间隔),或者never(从不)。 -->
<updatePolicy />
<!--当Maven验证构件校验文件失败时该怎么做:ignore(忽略),fail(失败),或者warn(警告)。 -->
<checksumPolicy />
</releases>
<!--如何处理远程仓库里快照版本的下载。有了releases和snapshots这两组配置,POM就可以在每个单独的仓库中,为每种类型的构件采取不同的策略。例如,可能有人会决定只为开发目的开启对快照版本下载的支持。参见repositories/repository/releases元素 -->
<snapshots>
<enabled />
<updatePolicy />
<checksumPolicy />
</snapshots>
<!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->
<id>banseon-repository-proxy</id>
<!--远程仓库名称 -->
<name>banseon-repository-proxy</name>
<!--远程仓库URL,按protocol://hostname/path形式 -->
<url>http://10.10.10.123:8080/repository/</url>
<!--用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认的布局;然而,Maven
1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。 -->
<layout>default</layout>
</repository>
</repositories>
<!--发现插件的远程仓库列表,这些插件用于构建和报表 -->
<pluginRepositories>
<!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素 -->
<pluginRepository>......</pluginRepository>
</pluginRepositories>
<!--该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。 -->
<dependencies>
<dependency>
<!--依赖的group ID -->
<groupId>org.apache.maven</groupId>
<!--依赖的artifact ID -->
<artifactId>maven-artifact</artifactId>
<!--依赖的版本号。 在Maven 2里, 也可以配置成版本号的范围。 -->
<version>3.8.1</version>
<!--依赖类型,默认类型是jar。它通常表示依赖的文件的扩展名,但也有例外。一个类型可以被映射成另外一个扩展名或分类器。类型经常和使用的打包方式对应,尽管这也有例外。一些类型的例子:jar,war,ejb-client和test-jar。如果设置extensions为
true,就可以在plugin里定义新的类型。所以前面的类型的例子不完整。 -->
<type>jar</type>
<!--依赖的分类器。分类器可以区分属于同一个POM,但不同构建方式的构件。分类器名被附加到文件名的版本号后面。例如,如果你想要构建两个单独的构件成JAR,一个使用Java
1.4编译器,另一个使用Java 6编译器,你就可以使用分类器来生成两个单独的JAR构件。 -->
<classifier></classifier>
<!--依赖范围。在项目发布过程中,帮助决定哪些构件被包括进来。欲知详情请参考依赖机制。 - compile :默认范围,用于编译 - provided:类似于编译,但支持你期待jdk或者容器提供,类似于classpath
- runtime: 在执行时需要使用 - test: 用于test任务时使用 - system: 需要外在提供相应的元素。通过systemPath来取得
- systemPath: 仅用于范围为system。提供相应的路径 - optional: 当项目自身被依赖时,标注依赖是否传递。用于连续依赖时使用 -->
<scope>test</scope>
<!--仅供system范围使用。注意,不鼓励使用这个元素,并且在新的版本中该元素可能被覆盖掉。该元素为依赖规定了文件系统上的路径。需要绝对路径而不是相对路径。推荐使用属性匹配绝对路径,例如${java.home}。 -->
<systemPath></systemPath>
<!--当计算传递依赖时, 从依赖构件列表里,列出被排除的依赖构件集。即告诉maven你只依赖指定的项目,不依赖项目的依赖。此元素主要用于解决版本冲突问题 -->
<exclusions>
<exclusion>
<artifactId>spring-core</artifactId>
<groupId>org.springframework</groupId>
</exclusion>
</exclusions>
<!--可选依赖,如果你在项目B中把C依赖声明为可选,你就需要在依赖于B的项目(例如项目A)中显式的引用对C的依赖。可选依赖阻断依赖的传递性。 -->
<optional>true</optional>
</dependency>
</dependencies>
<!--不赞成使用. 现在Maven忽略该元素. -->
<reports></reports>
<!--该元素描述使用报表插件产生报表的规范。当用户执行“mvn site”,这些报表就会运行。 在页面导航栏能看到所有报表的链接。 -->
<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>
<!--继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖(必须描述group ID和artifact
ID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过group ID和artifact ID匹配到这里的依赖,并使用这里的依赖信息。 -->
<dependencyManagement>
<dependencies>
<!--参见dependencies/dependency元素 -->
<dependency>......</dependency>
</dependencies>
</dependencyManagement>
<!--项目分发信息,在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。 -->
<distributionManagement>
<!--部署项目产生的构件到远程仓库需要的信息 -->
<repository>
<!--是分配给快照一个唯一的版本号(由时间戳和构建流水号)?还是每次都使用相同的版本号?参见repositories/repository元素 -->
<uniqueVersion />
<id>xxx-maven2</id>
<name>xxx maven2</name>
<url>file://${basedir}/target/deploy</url>
<layout />
</repository>
<!--构件的快照部署到哪里?如果没有配置该元素,默认部署到repository元素配置的仓库,参见distributionManagement/repository元素 -->
<snapshotRepository>
<uniqueVersion />
<id>xxx-maven2</id>
<name>xxx-maven2 Snapshot Repository</name>
<url>scp://svn.xxxx.com/xxx:/usr/local/maven-snapshot</url>
<layout />
</snapshotRepository>
<!--部署项目的网站需要的信息 -->
<site>
<!--部署位置的唯一标识符,用来匹配站点和settings.xml文件里的配置 -->
<id>banseon-site</id>
<!--部署位置的名称 -->
<name>business api website</name>
<!--部署位置的URL,按protocol://hostname/path形式 -->
<url>
scp://svn.baidu.com/xxx:/var/www/localhost/web
</url>
</site>
<!--项目下载页面的URL。如果没有该元素,用户应该参考主页。使用该元素的原因是:帮助定位那些不在仓库里的构件(由于license限制)。 -->
<downloadUrl />
<!--如果构件有了新的group ID和artifact ID(构件移到了新的位置),这里列出构件的重定位信息。 -->
<relocation>
<!--构件新的group ID -->
<groupId />
<!--构件新的artifact ID -->
<artifactId />
<!--构件新的版本号 -->
<version />
<!--显示给用户的,关于移动的额外信息,例如原因。 -->
<message />
</relocation>
<!--给出该构件在远程仓库的状态。不得在本地项目中设置该元素,因为这是工具自动更新的。有效的值有:none(默认),converted(仓库管理员从Maven
1 POM转换过来),partner(直接从伙伴Maven 2仓库同步过来),deployed(从Maven 2实例部署),verified(被核实时正确的和最终的)。 -->
<status />
</distributionManagement>
<!--以值替代名称,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml配置文件里activation元素的说明)。格式是<name>value</name>。 -->
<properties />
</project>