Maven的pom.xml配置文件详解

时间 2019-11-13

标签 maven pom.xml pom xml 配置文件详解栏目 Maven 繁體版

原文原文链接

<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>
 
 
    <!-- 依赖配置 -->
    <dependencies>...</dependencies>
    <parent>...</parent>
    <dependencyManagement>...</dependencyManagement>
    <modules>...</modules>
    <properties>...</properties>
 
    <!-- 构建配置 -->
    <build>...</build>
    <reporting>...</reporting>
 
    <!-- 项目信息 -->
    <name>...</name>
    <description>...</description>
    <url>...</url>
    <inceptionYear>...</inceptionYear>
    <licenses>...</licenses>
    <organization>...</organization>
    <developers>...</developers>
    <contributors>...</contributors>
 
    <!-- 环境设置 -->
    <issueManagement>...</issueManagement>
    <ciManagement>...</ciManagement>
    <mailingLists>...</mailingLists>
    <scm>...</scm>
    <prerequisites>...</prerequisites>
    <repositories>...</repositories>
    <pluginRepositories>...</pluginRepositories>
    <distributionManagement>...</distributionManagement>
    <profiles>...</profiles>
</project>

1.基本参数解释html

modelVersion：pom模型版本，maven2和3只能为4.0.0
groupId：组ID，maven用于定位
artifactId：在组中的惟一ID用于定位
version：项目版本
packaging：项目打包方式，有如下值：pom, jar, maven-plugin, ejb, war, ear, rar, parjava

2.依赖参数解释web

<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：父项目的版本apache

<modules>
   <module>com-a</>
   <module>com-b</>
   <module>com-c</>
</modules>

用于指定当前项目所包含的全部模块。以后对这个项目进行的maven操做，会让全部子模块也进行相同操做。maven

<properties>
    <java.version>1.7</java.version>
</properties>

能够在pom文件的任意地方经过${java.version}来引用ide

<dependencies> 
      <dependency>
            <groupId></groupId>
            <artifactId></artifactId>
            <version></version>
            <type></type>
            <optional></optional> <!-- optional 可选，不会传递依赖-->
            <scope></scope>
            <classifier></classifier>
            <systemPath></systemPath>
            <exclusions></exclusions>
      </dependency>
</dependencies>

引入依赖jar包，子项目会自动引用。svn

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

在父项目中使用dependencyManagement，子项目不会自动引入对应包，须要手动引用但这时候能够不指定版本，这样就实现了对版本的统一。布局

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
</dependency>

3.构建参加详解post

用于配置项目构建相关信息性能

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

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

4.项目信息参数解释

name：给用户提供更为友好的项目名
description：项目描述，maven文档中保存
url：主页的URL，maven文档中保存
inceptionYear：项目建立年份，4位数字。当产生版权信息时须要使用这个值
licenses：该元素描述了项目全部License列表。应该只列出该项目的license列表，不要列出依赖项目的license列表。若是列出多个license，用户能够选择它们中的一个而不是接受全部license。（以下）

<license>
    <!--license用于法律上的名称-->    
    <name>...</name>     
    <!--官方的license正文页面的URL-->    
    <url>....</url>
    <!--项目分发的主要方式：repo，能够从Maven库下载 manual， 用户必须手动下载和安装依赖-->    
    <distribution>repo</distribution>     
    <!--关于license的补充信息-->    
    <comments>....</comments>     
</license>

organization：1.name组织名2.url组织主页url
developers：项目开发人员列表（以下）
contributors：项目其余贡献者列表，同developers

<developers>
    <!--某个开发者信息-->
    <developer>  
        <!--开发者的惟一标识符-->
        <id>....</id>  
        <!--开发者的全名-->
        <name>...</name>  
        <!--开发者的email-->
        <email>...</email>  
        <!--开发者的主页-->
        <url>...<url/>
        <!--开发者在项目中的角色-->
        <roles>  
            <role>Java Dev</role>  
            <role>Web UI</role>  
        </roles> 
        <!--开发者所属组织--> 
        <organization>sun</organization>  
        <!--开发者所属组织的URL-->
        <organizationUrl>...</organizationUrl>  
        <!--开发者属性，如即时消息如何处理等-->
        <properties>
            <!-- 和主标签中的properties同样，能够随意定义子标签 -->
        </properties> 
        <!--开发者所在时区， -11到12范围内的整数。--> 
        <timezone>-5</timezone>  
    </developer>  
</developers>

5.环境设置参数

<issueManagement>
    <system>Bugzilla</system>
    <url>http://127.0.0.1/bugzilla/</url>
</issueManagement>

system：系统类型
url：路径

<ciManagement>
    <system>continuum</system>
    <url>http://127.0.0.1:8080/continuum</url>
    <notifiers>
      <notifier>
        <type>mail</type>
        <sendOnError>true</sendOnError>
        <sendOnFailure>true</sendOnFailure>
        <sendOnSuccess>false</sendOnSuccess>
        <sendOnWarning>false</sendOnWarning>
        <address>continuum@127.0.0.1</address>
        <configuration></configuration>
      </notifier>
    </notifiers>
  </ciManagement>

system：持续集成系统的名字
url：持续集成系统的URL
notifiers：构建完成时，须要通知的开发者/用户的配置项。包括被通知者信息和通知条件（错误，失败，成功，警告）
type：通知方式
sendOnError：错误时是否通知
sendOnFailure：失败时是否通知
sendOnSuccess：成功时是否通知
sendOnWarning：警告时是否通知
address：通知发送到的地址
configuration：扩展项

这里本身单独会写一篇文章讲maven的持续集成

<mailingLists>
    <mailingList>
      <name>User List</name>
      <subscribe>user-subscribe@127.0.0.1</subscribe>
      <unsubscribe>user-unsubscribe@127.0.0.1</unsubscribe>
      <post>user@127.0.0.1</post>
      <archive>http://127.0.0.1/user/</archive>
      <otherArchives>
   <otherArchive>http://base.google.com/base/1/127.0.0.1</otherArchive>
      </otherArchives>
    </mailingList>
    .....
  </mailingLists>

subscribe, unsubscribe: 订阅邮件（取消订阅）的地址或连接，若是是邮件地址，建立文档时，mailto:连接会被自动建立
archive：浏览邮件信息的URL
post：接收邮件的地址

<scm>
    <connection>scm:svn:http://127.0.0.1/svn/my-project</connection>
    <developerConnection>scm:svn:https://127.0.0.1/svn/my-project</developerConnection>
    <tag>HEAD</tag>
    <url>http://127.0.0.1/websvn/my-project</url>
  </scm>

connection, developerConnection：这两个表示咱们如何链接到maven的版本库。connection只提供读，developerConnection将提供写的请求
写法如：scm:[provider]:[provider_specific]
若是链接到CVS仓库，能够配置以下：scm:cvs:pserver:127.0.0.1:/cvs/root:my-project
tag：项目标签，默认HEAD
url：共有仓库路径

<prerequisites>
    <maven>2.0.6</maven>
</prerequisites>

构建该项目或使用该插件所须要的Maven的最低版本

<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>
  <pluginRepositories>
    ...
  </pluginRepositories>

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。

<distributionManagement>
    ...
    <downloadUrl>http://mojo.codehaus.org/my-project</downloadUrl>
    <status>deployed</status>
  </distributionManagement>

管理的分布在整个构建过程生成的工件和支持文件

downloadUrl: 其余pom能够经过此url的仓库抓取组件
status：给出该构件在远程仓库的状态
none: 默认
converted: 将被早期Maven 2 POM转换过来
partner: 这个项目会从合做者仓库同步过来
deployed: 从Maven 2或3实例部署
verified: 被核实时正确的和最终的

<distributionManagement>
    <repository>
      <uniqueVersion>false</uniqueVersion>
      <id>corp1</id>
      <name>Corporate Repository</name>
      <url>scp://repo/maven2</url>
      <layout>default</layout>
    </repository>
    <snapshotRepository>
      <uniqueVersion>true</uniqueVersion>
      <id>propSnap</id>
      <name>Propellors Snapshots</name>
      <url>sftp://propellers.net/maven</url>
      <layout>legacy</layout>
    </snapshotRepository>
    ...
  </distributionManagement>

指定Maven pom从远程下载控件到当前项目的位置和方式，若是snapshotRepository没有被定义则使用repository相关的配置

id, name：仓库的惟一标识
uniqueVersion：true或false，指明控件部署的时候是否获取独立的版本号。
url：repository元素的核心。指定位置和部署协议发布控件到仓库。
layout：布局，default或legacy

<distributionManagement>
    ...
    <site>
      <id>mojo.website</id>
      <name>Mojo Website</name>
      <url>scp://beaver.codehaus.org/home/projects/mojo/public_html/</url>
    </site>
    ...
  </distributionManagement>

多分布存储库,distributionManagement负责定义如何部署项目的网站和文档。

id, name, url: 这些元素与distributionManagement repository中的相同

<distributionManagement>
    ...
    <relocation>
      <groupId>org.apache</groupId>
      <artifactId>my-project</artifactId>
      <version>1.0</version>
      <message>We have moved the Project underApache</message>
    </relocation>
    ...
  </distributionManagement>

从新部署-项目不是静态的，是活的。他们须要被搬到更合适的地方。如：当你的下个成功的开源项目移到Apache下，重命名为org.apache:my-project:1.0对你项目更有好处。

<profiles>
    <profile>
        <!-- 本地开发环境 -->
        <id>dev</id>
        <properties>
            <profiles.active>dev</profiles.active>
        </properties>
        <activation>
            <!-- 设置默认激活这个配置 -->
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
    <profile>
        <!-- 发布环境 -->
        <id>release</id>
        <properties>
            <profiles.active>release</profiles.active>
        </properties>
    </profile>
    <profile>
        <!-- 测试环境 -->
        <id>beta</id>
        <properties>
            <profiles.active>beta</profiles.active>
        </properties>
    </profile>
</profiles>

profile可让咱们定义一系列的配置信息（插件等），而后指定其激活条件

jdk：检测到对应jdk版本就激活

os：针对不一样操做系统

property：当maven检测到property（pom中如${name}这样的）profile将被激活

file：若是存在文件，激活，不存在文件激活

qq技术交流群：208779755 我的公众号：海涛聊技术