• 已删除用户
Administrator
发布于 2021-08-11 / 8 阅读
0

Maven POM 文件详解

在Maven中,pom.xml是必不可少的配置文件,它定义了项目的各种属性和依赖关系。

一、什么是POM

pom.xml 是 Maven 项目的核心配置文件,它是 项目对象模型 - Project Object Model(POM)的缩写。POM定义了项目的所有属性,包括项目的名称、版本、依赖关系、构建配置等。使用pom.xml,我们可以轻松地管理项目的构建和依赖关系,让我们能够更专注于业务逻辑的开发。

二、元素详解

2.1 项目必要信息

2.1.1 parent

父项目的坐标。如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值。

<parent>
  <!--被继承的父项目的构件标识符-->
  <artifactId/>
  <!--被继承的父项目的全球唯一标识符-->
  <groupId/>
  <!--被继承的父项目的版本-->
  <version/>
  <!-- 父项目的 pom.xml 文件的相对路径。相对路径允许你选择一个不同的路径。默认值是../pom.xml。Maven首先在构建当前项目的地方寻找父项目的pom,其次在文件系统的这个位置(relativePath位置),然后在本地仓库,最后在远程仓库寻找父项目的pom。-->
  <relativePath/>
</parent>

2.1.2 modelVersion

声明项目描述符遵循哪一个POM模型版本。模型本身的版本很少改变,虽然如此,但它仍然是必不可少的,这是为了当Maven引入了新的特性或者其他模型变更的时候,确保稳定性。

<modelVersion>4.0.0</modelVersion>

2.1.3 groupId

项目的全球唯一标识符,通常使用全限定的包名区分该项目和其他项目。并且构建时生成的路径也是由此生成, 如com.mycompany.app生成的相对路径为:/com/mycompany/app。

<groupId>com.mycompany</groupId>

2.1.4 artifactId

构件的标识符,它和group ID一起唯一标识一个构件。换句话说,你不能有两个不同的项目拥有同样的artifact ID和groupID;在某个 特定的group ID下,artifact ID也必须是唯一的。构件是项目产生的或使用的一个东西,Maven为项目产生的构件包括:JARs,源码,二进制发布和WARs等。

<artifactId>banseon-maven2</artifactId>

2.1.5 packaging

项目产生的构件类型,例如jar、war、ear、pom。插件可以创建他们自己的构件类型,所以前面列的不是全部构件类型。

<packaging>jar</packaging>

2.1.6 version

项目当前版本,格式为:主版本.次版本.增量版本-限定版本号。

<version>1.0-SNAPSHOT</version>

2.2 项目可选信息

2.2.1 name

项目的名称, Maven产生的文档用。

<name>banseon-maven</name>

2.2.2 url

项目主页的URL, Maven产生的文档用。

<url>http://www.baidu.com</url>

2.2.3 description

项目的详细描述, Maven 产生的文档用。 当这个元素能够用HTML格式描述时(例如,CDATA中的文本会被解析器忽略,就可以包含HTML标 签), 不鼓励使用纯文本描述。如果你需要修改产生的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档。

<description>A maven project to study maven.</description>

2.2.4 organization

描述项目所属组织的各种属性。Maven产生的文档用。

<organization>
 	<!--组织的全名-->
    <name>demo</name>
    <!--组织主页的URL-->
    <url>xxxxxx</url>
</organization>

2.2.5 issueManagement

项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL。

<issueManagement>  
  <!--问题管理系统(例如jira)的名字,-->   
  <system>jira</system>   
  <!--该项目使用的问题管理系统的URL-->  
  <url>http://jira.baidu.com/banseon</url>   
</issueManagement>

2.2.6 developers

项目开发者列表。

<developers>
	<!--某个项目开发者的信息-->
    <developer>
        <!--SCM里项目开发者的唯一标识符-->
        <id>HELLO WORLD</id>
        <!--项目开发者的全名-->
        <name>zhangqin</name>
        <!--项目开发者的email-->
        <email>xxxxxx</email>
        <!--项目开发者的主页的URL-->
        <url/>
        <!--项目开发者在项目中扮演的角色,角色元素描述了各种角色-->
        <roles>
            <role>Project Manager</role>
            <role>Architect</role>
        </roles>
        <!--项目开发者所属组织-->
        <organization>demo</organization>
        <!--项目开发者所属组织的URL-->
   		<organizationUrl>xxxxxx</organizationUrl>
        <!--项目开发者属性,如即时消息如何处理等-->
        <properties>
            <dept>No</dept>
        </properties>
        <!--项目开发者所在时区,-11到12范围内的整数。-->
        <timezone>-5</timezone>
    </developer>
</developers>

2.2.7 contributors

项目的其他贡献者列表。

<contributors>
	<!--项目的其他贡献者。参见developers/developer元素-->
	<contributor>
  		<name/>
		<email/>
		<url/>
		<organization/>
		<organizationUrl/>
		<roles/>
		<timezone/>
		<properties/>
	</contributor>
</contributors>

2.2.8 licenses

该元素描述了项目所有License列表。 应该只列出该项目的license列表,不要列出依赖项目的 license列表。如果列出多个license,用户可以选择它们中的一个而不是接受所有license。

<licenses>
 	<!--描述了项目的license,用于生成项目的web站点的license页面,其他一些报表和validation也会用到该元素。-->
    <license>
     	<!--license用于法律上的名称-->
        <name>Apache 2</name>
        <!--官方的license正文页面的URL-->
        <url>http://www.baidu.com/banseon/LICENSE-2.0.txt</url>
        <!--项目分发的主要方式:
          repo,可以从Maven库下载
          manual, 用户必须手动下载和安装依赖-->
        <distribution>repo</distribution>
        <!--关于license的补充信息-->
        <comments>A business-friendly OSS license</comments>
    </license>
</licenses>

2.2.9 scm

SCM(Source Control Management)标签允许你配置你的代码库,供Maven web站点和其它插件使用。

<scm>
    <!--SCM的URL,该URL描述了版本库和如何连接到版本库。欲知详情,请看SCMs提供的URL格式和列表。该连接只读。-->
    <connection>
		scm:svn:xxxxxx
    </connection>
    <!--给开发者使用的,类似connection元素。即该连接不仅仅只读-->
    <developerConnection>
        scm:svn:xxxxxx
    </developerConnection>
    <!--当前代码的标签,在开发阶段默认为HEAD-->
    <tag/>
    <!--指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。-->
    <url>http://svn.baidu.com/banseon</url>
</scm>

2.3 核心元素信息

2.3.1 properties

属性信息,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml配置文件里activation元素的说明)。格式是<name>value</name>。

2.3.2 distributionManagement

项目分发信息,在执行mvn deploy后表示要发布的位置。有了这些信息就可以把网站部署到远程服务器或者把构件部署到远程仓库。

<distributionManagement>
  <!--部署项目产生的构件到远程仓库需要的信息-->
  <repository>
    <uniqueVersion/>
    <id>xxxxxx</id>
    <name>xxxxxx</name>
    <url>xxxxxx</url>
    <layout/>
  </repository>

  <!--构件的快照部署到哪里?如果没有配置该元素,默认部署到repository元素配置的仓库-->
  <snapshotRepository>
    <uniqueVersion/>
    <id>xxxxxx</id>
    <name>xxxxxx</name>
    <url>xxxxxx</url>
    <layout/>
  </snapshotRepository>
</distributionManagement>

2.3.3 dependencyManagement

继承自该项目的所有子项目的默认依赖信息。这部分的依赖信息不会被立即解析,而是当子项目声明一个依赖(必须描述group ID和 artifact ID信息),如果group ID和artifact ID以外的一些信息没有描述,则通过group ID和artifact ID 匹配到这里的依赖,并使用这里的依赖信息。

 <dependencyManagement>
  <dependencies>
    <!--参见dependencies/dependency元素-->
    <dependency>
      ......
    </dependency>
  </dependencies>
 </dependencyManagement>

2.3.4 dependencies

该元素描述了项目相关的所有依赖。 这些依赖组成了项目构建过程中的一个个环节。它们自动从项目定义的仓库中下载。要获取更多信息,请看项目依赖机制。

<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>
        <!--当计算传递依赖时, 从依赖构件列表里,列出被排除的依赖构件集。即告诉maven你只依赖指定的项目,不依赖项目的依赖。此元素主要用于解决版本冲突问题-->
        <exclusions>
            <exclusion>
                <artifactId>spring-core</artifactId>
                <groupId>org.springframework</groupId>
            </exclusion>
        </exclusions>
        <!--可选依赖,如果你在项目B中把C依赖声明为可选,你就需要在依赖于B的项目(例如项目A)中显式的引用对C的依赖。可选依赖阻断依赖的传递性。-->
        <optional>true</optional>
    </dependency>
</dependencies>

2.3.5 modules

模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径。

<modules>
  <module>./submodule1</module>
  <module>./submodule2</module>
</modules>

2.3.6 profiles

在列的项目构建 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>x86</arch>
        <!--激活profile的操作系统版本-->
        <version>5.1.2600</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/hudson/hudson-home/jobs/maven-guide-zh-to-production/workspace/</exists>
        <!--如果指定的文件不存在,则激活profile。-->
        <missing>/usr/local/hudson/hudson-home/jobs/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>
        <id/><name/><url/><layout/>
        <releases>
          <enabled/><updatePolicy/><checksumPolicy/>
        </releases>
        <snapshots>
          <enabled/><updatePolicy/><checksumPolicy/>
        </snapshots>
      </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>
    <!--参见dependencyManagement元素-->
    <dependencyManagement>
      <dependencies>
        <!--参见dependencies/dependency元素-->
        <dependency>
          ......
        </dependency>
      </dependencies>
    </dependencyManagement>
    <!--参见distributionManagement元素-->
    <distributionManagement>
      ......
    </distributionManagement>
    <!--参见properties元素-->
    <properties/>
  </profile>
</profiles>

2.3.7 repositories

发现依赖和扩展的远程仓库列表。

<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://192.168.1.169:9999/repository/</url>
    <!-- 用于定位和排序构件的仓库布局类型-可以是default(默认)或者legacy(遗留)。Maven 2为其仓库提供了一个默认的布局;然而,Maven 1.x有一种不同的布局。我们可以使用该元素指定布局是default(默认)还是legacy(遗留)。-->
    <layout>default</layout>
  </repository>
</repositories>

2.3.8 pluginRepositories

发现插件的远程仓库列表,这些插件用于构建和报表。

<!--发现插件的远程仓库列表,这些插件用于构建和报表-->
<pluginRepositories>
  <!--包含需要连接到远程插件仓库的信息.参见repositories/repository元素-->
  <pluginRepository>
    ......
  </pluginRepository>
</pluginRepositories>

2.3.9 build

构建项目需要的信息。

<build>
  <!--该元素设置了项目源码目录,当构建项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。-->
  <sourceDirectory/>
  <!--该元素设置了项目脚本源码目录,该目录和源码目录不同:绝大多数情况下,该目录下的内容 会被拷贝到输出目录(因为脚本是被解释的,而不是被编译的)。-->
  <scriptSourceDirectory/>
  <!--该元素设置了项目单元测试使用的源码目录,当测试项目的时候,构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。-->
  <testSourceDirectory/>
  <!--被编译过的应用程序class文件存放的目录。-->
  <outputDirectory/>
  <!--被编译过的测试class文件存放的目录。-->
  <testOutputDirectory/>
  <!--使用来自该项目的一系列构建扩展-->
  <extensions>
    <!--描述使用到的构建扩展。-->
    <extension>
      <!--构建扩展的groupId-->
      <groupId/>
      <!--构建扩展的artifactId-->
      <artifactId/>
      <!--构建扩展的版本-->
      <version/>
    </extension>
  </extensions>
  <!--这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。-->
  <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>

三、参考资料

史上最全的Maven Pom文件标签详解