devbox
笔触狂放9
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

maven：pom文件详解_pom directory

作者：笔触狂放9 | 2024-08-21 06:28:12

赞

踩

pom directory

一、maven项目的目录结构

    pom文件定于了一个maven项目的maven配置，一般pom文件的放在项目或者模块的根目录下。

    maven的遵循约定大于配置，约定了如下的目录结构：

目录目的
${basedir}存放pom.xml和所有的子目录
${basedir}/src/main/java项目的java源代码
${basedir}/src/main/resources项目的资源，比如说property文件，springmvc.xml
${basedir}/src/test/java项目的测试类，比如说Junit代码
${basedir}/src/test/resources测试用的资源
${basedir}/src/main/scripts项目脚本源码的目录
${basedir}/src/main/webapp/WEB-INFweb应用文件目录，web项目的信息，比如存放web.xml、本地图片、jsp视图页面
${basedir}/target打包输出目录
${basedir}/target/classes编译输出目录
${basedir}/target/site生成文档的目录，可以通过index.html查看项目的文档
${basedir}/target/test-classes测试编译输出目录
Test.javaMaven只会自动运行符合该命名规则的测试类
~/.m2/repositoryMaven默认的本地仓库目录位置

二、根元素和必要配置

  1. <project xmlns = "http://maven.apache.org/POM/4.0.0"
  2.     xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
  3.     xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0
  4.     http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.  
  6.     <!-- 模型版本 -->
  7.     <modelVersion>4.0.0</modelVersion>
  8.     <!-- 公司或者组织的唯一标志，也是打包成jar包路径的依据 -->
  9.     <!-- 例如com.companyname.project-group，maven打包jar包的路径：/com/companyname/project-group -->
  10.     <groupId>com.companyname.project-group</groupId>
  11.  
  12.     <!-- 项目的唯一ID，一个groupId下面可能多个项目，就是靠artifactId来区分的 -->
  13.     <artifactId>project</artifactId>
  14.  
  15.     <!-- 项目当前版本，格式为:主版本.次版本.增量版本-限定版本号 -->
  16.     <version>1.0</version>
  17.  
  18.     <!--项目产生的构件类型，包括jar、war、ear、pom等 -->
  19.     <packaging>jar</packaging>
  20. </project>

    project是pom文件的根元素，project下有modelVersion、groupId、artifactId、version、packaging等重要的元素。其中，groupId、artifactId、version三个元素用来定义一个项目的坐标，也就是说，一个maven仓库中，完全相同的一组groupId、artifactId、version，只能有一个项目。

  • project：整个pom配置文件的根元素，所有的配置都是写在project元素里面的；
  • modelVersion：指定了当前POM模型的版本，对于Maven2及Maven 3来说，它只能是4.0.0；
  • groupId：这是项目组的标识。它在一个组织或者项目中通常是唯一的。
  • artifactId：这是项目的标识，通常是工程的名称。它在一个项目组（group）下是唯一的。
  • version：这是项目的版本号，用来区分同一个artifact的不同版本。
  • packaging：这是项目产生的构件类型，即项目通过maven打包的输出文件的后缀名，包括jar、war、ear、pom等。

三、父项目和parent元素

  1.     <!--父项目的坐标，坐标包括group ID，artifact ID和version。 -->
  2.     <!--如果项目中没有规定某个元素的值，那么父项目中的对应值即为项目的默认值 -->
  3.     <parent>
  4.  
  5.         <!--被继承的父项目的构件标识符 -->
  6.         <artifactId>com.companyname.project-group</artifactId>
  7.         <!--被继承的父项目的全球唯一标识符 -->
  8.         <groupId>base-project</groupId>
  9.         <!--被继承的父项目的版本 -->
  10.         <version>1.0.1-RELEASE</version>
  11.  
  12.         <!-- 父项目的pom.xml文件的相对路径,默认值是../pom.xml。 -->
  13.         <!-- 寻找父项目的pom：构建当前项目的地方--)relativePath指定的位置--)本地仓库--)远程仓库 -->
  14.         <relativePath>../pom.xml</relativePath>
  15.     </parent>

    所有的pom都继承自一个父pom（Super POM）。父pom包含了一些可以被继承的默认设置，如果项目的pom中没有设置这些元素，就会使用父pom中设置。例如，Super POM中配置了默认仓库http://repo1.maven.org/maven2，这样哪怕项目的pom中没有配置仓库，也可以去这个默认仓库中去下载依赖。实际上，maven pom文件约定大于配置的原则，就是通过在Super POM中预定义了一些配置信息来实现的。

    Maven使用effective pom（Super pom加上工程自己的配置）来执行相关的目标，它帮助开发者在pom.xml中做尽可能少的配置。当然，这些配置也可以被重写。

    parent元素可以指定父pom。用户可以通过增加parent元素来自定义一个父pom，从而继承该pom的配置。parent元素中包含一些子元素，用来定位父项目和父项目的pom文件位置。

  • parent：用于指定父项目；
  • groupId：parent的子元素，父项目的groupId，用于定位父项目；
  • artifactId：parent的子元素，父项目的artifactId，用于定位父项目；
  • version：parent的子元素，父项目的version，用于定位父项目；
  • relativePath：parent的子元素，用于定位父项目pom文件的位置。

四、项目构建需要的信息

  1.     <!--构建项目需要的信息 -->
  2.     <build>
  3.         <!--------------------- 路径管理（在遵循约定大于配置原则下，不需要配置） --------------------->
  4.         <!--项目源码目录，当构建项目的时候，构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->
  5.         <sourceDirectory />
  6.         <!--该元素设置了项目单元测试使用的源码目录。该路径是相对于pom.xml的相对路径 -->
  7.         <testSourceDirectory />
  8.         <!--被编译过的应用程序class文件存放的目录。 -->
  9.         <outputDirectory />
  10.         <!--被编译过的测试class文件存放的目录。 -->
  11.         <testOutputDirectory />        
  12.         <!--项目脚本源码目录，该目录下的内容，会直接被拷贝到输出目录，因为脚本是被解释的，而不是被编译的 -->
  13.         <scriptSourceDirectory />
  14.  
  15.         <!--------------------- 资源管理 --------------------->
  16.         <!--这个元素描述了项目相关的所有资源路径列表，例如和项目相关的属性文件，这些资源被包含在最终的打包文件里。 -->
  17.         <resources>
  18.             <!--这个元素描述了项目相关或测试相关的所有资源路径 -->
  19.             <resource>
  20.                 <!-- 描述了资源的目标输出路径。该路径是相对于target/classes的路径 -->
  21.                 <!-- 如果是想要把资源直接放在target/classes下，不需要配置该元素 -->
  22.                 <targetPath />
  23.                 <!--是否使用参数值代替参数名。参数值取自文件里配置的属性，文件在filters元素里列出。 -->
  24.                 <filtering />
  25.                 <!--描述存放资源的目录，该路径相对POM路径 -->
  26.                 <directory />
  27.                 <!--包含的模式列表，例如**/*.xml，只有符合条件的资源文件才会在打包的时候被放入到输出路径中 -->
  28.                 <includes />
  29.                 <!--排除的模式列表，例如**/*.xml，符合的资源文件不会在打包的时候会被过滤掉 -->
  30.                 <excludes />
  31.             </resource>
  32.         </resources>
  33.         <!--这个元素描述了单元测试相关的所有资源路径，例如和单元测试相关的属性文件。 -->
  34.         <testResources>
  35.             <!--这个元素描述了测试相关的所有资源路径，子元素说明参考build/resources/resource元素的说明 -->
  36.             <testResource>
  37.                 <targetPath />
  38.                 <filtering />
  39.                 <directory />
  40.                 <includes />
  41.                 <excludes />
  42.             </testResource>
  43.         </testResources>
  44.  
  45.         <!--------------------- 插件管理 --------------------->
  46.         <!-- 子项目可以引用的默认插件信息。pluginManagement中的插件直到被引用时才会被解析或绑定到生命周期 -->
  47.         <!-- 这里只是做了声明，并没有真正的引入。给定插件的任何本地配置都会覆盖这里的配置-->
  48.         <pluginManagement>
  49.             <!-- 可使用的插件列表 -->
  50.             <plugins>
  51.                 <!--plugin元素包含描述插件所需要的信息。 -->
  52.                 <plugin>
  53.                     <!--插件在仓库里的group ID -->
  54.                     <groupId />
  55.                     <!--插件在仓库里的artifact ID -->
  56.                     <artifactId />
  57.                     <!--被使用的插件的版本（或版本范围） -->
  58.                     <version />
  59.                     <!-- 是否从该插件下载Maven扩展(例如打包和类型处理器) -->
  60.                     <!-- 由于性能原因，只有在真需要下载时，该元素才被设置成enabled -->
  61.                     <extensions />
  62.                     <!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->
  63.                     <executions>
  64.                         <!--execution元素包含了插件执行需要的信息 -->
  65.                         <execution>
  66.                             <!--执行目标的标识符，用于标识构建过程中的目标，或者匹配继承过程中需要合并的执行目标 -->
  67.                             <id />
  68.                             <!--绑定了目标的构建生命周期阶段，如果省略，目标会被绑定到源数据里配置的默认阶段 -->
  69.                             <phase />
  70.                             <!--配置的执行目标 -->
  71.                             <goals />
  72.                             <!--配置是否被传播到子POM -->
  73.                             <inherited />
  74.                             <!--作为DOM对象的配置 -->
  75.                             <configuration />
  76.                         </execution>
  77.                     </executions>
  78.                     <!--项目引入插件所需要的额外依赖 -->
  79.                     <dependencies>
  80.                         <!--参见dependencies/dependency元素 -->
  81.                         <dependency>
  82.                             ......
  83.                         </dependency>
  84.                     </dependencies>
  85.                     <!--任何配置是否被传播到子项目 -->
  86.                     <inherited />
  87.                     <!--作为DOM对象的配置 -->
  88.                     <configuration />
  89.                 </plugin>
  90.             </plugins>
  91.         </pluginManagement>
  92.         <!--使用的插件列表 -->
  93.         <plugins>
  94.             <!--参见build/pluginManagement/plugins/plugin元素 -->
  95.             <plugin>
  96.                 <groupId />
  97.                 <artifactId />
  98.                 <version />
  99.                 <extensions />
  100.                 <executions>
  101.                     <execution>
  102.                         <id />
  103.                         <phase />
  104.                         <goals />
  105.                         <inherited />
  106.                         <configuration />
  107.                     </execution>
  108.                 </executions>
  109.                 <dependencies>
  110.                     <!--参见dependencies/dependency元素 -->
  111.                     <dependency>
  112.                         ......
  113.                     </dependency>
  114.                 </dependencies>
  115.                 <goals />
  116.                 <inherited />
  117.                 <configuration />
  118.             </plugin>
  119.         </plugins>
  120.  
  121.         <!--------------------- 构建扩展 --------------------->
  122.         <!--使用来自其他项目的一系列构建扩展 -->
  123.         <extensions>
  124.             <!--每个extension描述一个会使用到其构建扩展的一个项目，extension的子元素是项目的坐标 -->
  125.             <extension>
  126.                 <!--项目坐标三元素：groupId + artifactId + version -->
  127.                 <groupId />
  128.                 <artifactId />
  129.                 <version />
  130.             </extension>
  131.         </extensions>
  132.  
  133.         <!--------------------- 其他配置 --------------------->
  134.         <!--当项目没有规定目标（Maven2 叫做阶段）时的默认值 -->
  135.         <defaultGoal />
  136.         <!--构建产生的所有文件存放的目录 -->
  137.         <directory />
  138.         <!--产生的构件的文件名，默认值是${artifactId}-${version}。 -->
  139.         <finalName />
  140.         <!--当filtering开关打开时，使用到的过滤器属性文件列表 -->
  141.         <filters />
  142.     </build>

    build标签定义了构建项目需要的信息，这部分信息对于定制化项目构建是非常重要的。这里会根据build的子元素的特点，简单地分类讲解。

1、路径管理

  1.        <!--------------------- 路径管理（在遵循约定大于配置原则下，不需要配置） --------------------->
  2.         <!--项目源码目录，当构建项目的时候，构建系统会编译目录里的源码。该路径是相对于pom.xml的相对路径。 -->
  3.         <sourceDirectory />
  4.         <!--该元素设置了项目单元测试使用的源码目录。该路径是相对于pom.xml的相对路径 -->
  5.         <testSourceDirectory />
  6.         <!--被编译过的应用程序class文件存放的目录。 -->
  7.         <outputDirectory />
  8.         <!--被编译过的测试class文件存放的目录。 -->
  9.         <testOutputDirectory />        
  10.         <!--项目脚本源码目录，该目录下的内容，会直接被拷贝到输出目录，因为脚本是被解释的，而不是被编译的 -->
  11.         <scriptSourceDirectory />

    路径管理定义了各种源码和编译结果的输出路径。如果遵循maven默认的路径约定，这里的几个元素是不需要配置的。这些元素包括：

  • sourceDirectory：项目源码目录，定义的是相对于pom文件的相对路径；
  • testSourceDirectory：项目单元测试源码目录，定义的也是是相对于pom文件的相对路径；
  • outputDirectory：被编译过的应用程序class文件存放的目录，也是是相对于pom文件的相对路径；
  • testOutoutDIrectory：被编译过的测试class文件存放的目录，也是是相对于pom文件的相对路径；
  • scriptSourceDirectory：项目脚本源码目录，也是是相对于pom文件的相对路径。由于脚本是解释性的语言，所以该目录下的内容，会直接被拷贝到输出目录，而不需要编译。

2、资源管理

  1.         <!--------------------- 资源管理 --------------------->
  2.         <!--这个元素描述了项目相关的所有资源路径列表，例如和项目相关的属性文件，这些资源被包含在最终的打包文件里。 -->
  3.         <resources>
  4.             <!--这个元素描述了项目相关或测试相关的所有资源路径 -->
  5.             <resource>
  6.                 <!-- 描述了资源的目标输出路径。该路径是相对于target/classes的路径 -->
  7.                 <!-- 如果是想要把资源直接放在target/classes下，不需要配置该元素 -->
  8.                 <targetPath />
  9.                 <!--是否使用参数值代替参数名。参数值取自文件里配置的属性，文件在filters元素里列出 -->
  10.                 <filtering />
  11.                 <!--描述打包前的资源存放的目录，该路径相对POM路径 -->
  12.                 <directory />
  13.                 <!--包含的模式列表，例如**/*.xml，只有符合条件的资源文件才会在打包的时候被放入到输出路径中 -->
  14.                 <includes />
  15.                 <!--排除的模式列表，例如**/*.xml，符合的资源文件不会在打包的时候会被过滤掉 -->
  16.                 <excludes />
  17.             </resource>
  18.         </resources>
  19.         <!--这个元素描述了单元测试相关的所有资源路径，例如和单元测试相关的属性文件。 -->
  20.         <testResources>
  21.             <!--这个元素描述了测试相关的所有资源路径，子元素说明参考build/resources/resource元素的说明 -->
  22.             <testResource>
  23.                 <targetPath />
  24.                 <filtering />
  25.                 <directory />
  26.                 <includes />
  27.                 <excludes />
  28.             </testResource>
  29.         </testResources>

    这里的元素主要是对应用程序resource资源和单元测试部分resource资源的管理，分别通过resource标签和testResource标签管理两种资源。两个标签元素可选的子元素都是一样的。子元素包括：

  • targetPath：描述了资源的目标输出路径，该路径是相对于target/classes的路径；
  • filtering：对文件中的参数值进行过滤，需要被过滤的文件在filter中指定；
  • directory：描述打包前的资源的存放路径，这个路径是相对于pom文件所在目录的相对路径；
  • includes：包含的模式列表，例如**/*.xml。只有符合条件的资源文件才会在打包的时候被放入到输出路径中；
  • excludes：排除的模式列表，例如**/*.xml，符合的资源文件不会在打包的时候会被过滤掉。

3、插件管理

    插件管理相关的元素有两个，包括pluginManagement和plugins。pluginManagement中有子元素plugins，它和project下的直接子元素plugins的区别是，pluginManagement主要是用来声明子项目可以引用的默认插件信息，这些插件如果只写在pluginManagement中是不会被引入的。project下的直接子元素plugins中定义的才是这个项目中真正需要被引入的插件。

  1.         <!--------------------- 插件管理 --------------------->
  2.         <!-- 子项目可以引用的默认插件信息。pluginManagement中的插件直到被引用时才会被解析或绑定到生命周期 -->
  3.         <!-- 这里只是做了声明，并没有真正的引入。给定插件的任何本地配置都会覆盖这里的配置-->
  4.         <pluginManagement>
  5.             <!-- 可使用的插件列表 -->
  6.             <plugins>
  7.                 <!--plugin元素包含描述插件所需要的信息。 -->
  8.                 <plugin>
  9.                     <!--插件定位坐标三元素：groupId + artifactId + version -->
  10.                     <groupId />
  11.                     <artifactId />
  12.                     <version />
  13.                     <!-- 是否使用这个插件的Maven扩展(extensions)，默认为false -->
  14.                     <!-- 由于性能原因，只有在真需要下载时，该元素才被设置成enabled -->
  15.                     <extensions />
  16.                     <!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->
  17.                     <executions>
  18.                         <!--execution元素包含了插件执行需要的信息 -->
  19.                         <execution>
  20.                             <!--执行目标的标识符，用于标识构建过程中的目标，或者匹配继承过程中需要合并的执行目标 -->
  21.                             <id />
  22.                             <!--绑定了目标的构建生命周期阶段，如果省略，目标会被绑定到源数据里配置的默认阶段 -->
  23.                             <phase />
  24.                             <!--配置的执行目标 -->
  25.                             <goals />
  26.                             <!--配置是否被传播到子POM -->
  27.                             <inherited />
  28.                             <!--作为DOM对象的配置 -->
  29.                             <configuration />
  30.                         </execution>
  31.                     </executions>
  32.                     <!--项目引入插件所需要的额外依赖，参见dependencies元素 -->
  33.                     <dependencies>
  34.                             ......
  35.                     </dependencies>
  36.                     <!--任何配置是否被传播到子项目 -->
  37.                     <inherited />
  38.                     <!--作为DOM对象的配置 -->
  39.                     <configuration />
  40.                 </plugin>
  41.             </plugins>
  42.         </pluginManagement>
  43.         <!--使用的插件列表，这里是真正的引入插件。参见build/pluginManagement/plugins元素 -->
  44.         <plugins>
  45.             ......
  46.         </plugins>

4、构建扩展

    extensions是在此构建中使用的项目的列表，它们将被包含在运行构建的classpath中。这些项目可以启用对构建过程的扩展，并使活动的插件能够对构建生命周期进行更改。简而言之，扩展是在构建期间激活的artifacts。扩展不需要实际执行任何操作，也不包含 Mojo。因此，扩展对于指定普通插件接口的多个实现中的一个是非常好的。

  1.         <!--------------------- 构建扩展 --------------------->
  2.         <!--使用来自其他项目的一系列构建扩展 -->
  3.         <extensions>
  4.             <!--每个extension描述一个会使用到其构建扩展的一个项目，extension的子元素是项目的坐标 -->
  5.             <extension>
  6.                 <!--项目坐标三元素：groupId + artifactId + version -->
  7.                 <groupId />
  8.                 <artifactId />
  9.                 <version />
  10.             </extension>
  11.         </extensions>

5、其他配置

    build中还有一些配置，如下：

  1.         <!--------------------- 其他配置 --------------------->
  2.         <!--当项目没有规定目标（Maven2 叫做阶段）时的默认值 -->
  3.         <defaultGoal />
  4.         <!--构建产生的所有文件存放的目录 -->
  5.         <directory />
  6.         <!--产生的构件的文件名，默认值是${artifactId}-${version}。 -->
  7.         <finalName />
  8.         <!--当filtering开关打开时，使用到的过滤器属性文件列表 -->
  9.         <filters />

五、项目依赖相关信息

    pom文件中通过dependencyManagement来声明依赖，通过dependencies元素来管理依赖。dependencyManagement下的子元素只有一个直接的子元素dependencice，其配置和dependencies子元素是完全一致的；而dependencies下只有一类直接的子元素：dependency。一个dependency子元素表示一个依赖项目。

  1.     <!--该元素描述了项目相关的所有依赖。 这些依赖自动从项目定义的仓库中下载 -->
  2.     <dependencies>
  3.         <dependency>
  4.             <!------------------- 依赖坐标 ------------------->
  5.             <!--依赖项目的坐标三元素：groupId + artifactId + version -->
  6.             <groupId>org.apache.maven</groupId>
  7.             <artifactId>maven-artifact</artifactId>
  8.             <version>3.8.1</version>
  9.  
  10.             <!------------------- 依赖类型 ------------------->
  11.             <!-- 依赖类型，默认是jar。通常表示依赖文件的扩展名，但有例外。一个类型可以被映射成另外一个扩展名或分类器 -->
  12.             <!-- 类型经常和使用的打包方式对应，尽管这也有例外，一些类型的例子：jar，war，ejb-client和test-jar -->
  13.             <!-- 如果设置extensions为true，就可以在plugin里定义新的类型 -->
  14.             <type>jar</type>
  15.             <!-- 依赖的分类器。分类器可以区分属于同一个POM，但不同构建方式的构件。分类器名被附加到文件名的版本号后面 -->
  16.             <!-- 如果想将项目构建成两个单独的JAR，分别使用Java 4和6编译器，就可以使用分类器来生成两个单独的JAR构件 -->
  17.             <classifier></classifier>
  18.  
  19.             <!------------------- 依赖传递 ------------------->
  20.             <!--依赖排除，即告诉maven只依赖指定的项目，不依赖该项目的这些依赖。此元素主要用于解决版本冲突问题 -->
  21.             <exclusions>
  22.                 <exclusion>
  23.                     <artifactId>spring-core</artifactId>
  24.                     <groupId>org.springframework</groupId>
  25.                 </exclusion>
  26.             </exclusions>
  27.             <!-- 可选依赖，用于阻断依赖的传递性。如果在项目B中把C依赖声明为可选，那么依赖B的项目中无法使用C依赖 -->
  28.             <optional>true</optional>
  29.             
  30.             <!------------------- 依赖范围 ------------------->
  31.             <!--依赖范围。在项目发布过程中，帮助决定哪些构件被包括进来
  32.                 - compile：默认范围，用于编译;  - provided：类似于编译，但支持jdk或者容器提供，类似于classpath 
  33.                 - runtime: 在执行时需要使用;    - systemPath: 仅用于范围为system。提供相应的路径 
  34.                 - test: 用于test任务时使用;    - system: 需要外在提供相应的元素。通过systemPath来取得 
  35.                 - optional: 当项目自身被依赖时，标注依赖是否传递。用于连续依赖时使用 -->
  36.             <scope>test</scope>
  37.             <!-- 该元素为依赖规定了文件系统上的路径。仅供scope设置system时使用。但是不推荐使用这个元素 -->
  38.             <!-- 不推荐使用绝对路径，如果必须要用，推荐使用属性匹配绝对路径，例如${java.home} -->
  39.             <systemPath></systemPath>
  40.         </dependency>
  41.     </dependencies>
  42.  
  43.     <!-- 继承自该项目的所有子项目的默认依赖信息，这部分的依赖信息不会被立即解析。 -->
  44.     <!-- 当子项目声明一个依赖，如果group ID和artifact ID以外的一些信息没有描述，则使用这里的依赖信息 -->
  45.     <dependencyManagement>
  46.         <dependencies>
  47.             <!--参见dependencies/dependency元素 -->
  48.             <dependency>
  49.                 ......
  50.             </dependency>
  51.         </dependencies>
  52.     </dependencyManagement>

    这里也是根据元素的作用，简单的对dependency的子元素做了一下分类。下面按分类来看一下dependency的子元素：

1、依赖坐标

    依然是通过groupId + artifactId + version来在仓库中定位一个项目：

  • groupId：parent的子元素，父项目的groupId，用于定位父项目；
  • artifactId：parent的子元素，父项目的artifactId，用于定位父项目；
  • version：parent的子元素，父项目的version，用于定位父项目；

2、依赖类型

    这个分类主要包括两个元素，分别是依赖类型和依赖的分类器。同一个项目，即使打包成同一种类型，也可以有多个文件同时存在，因为它们的分类器可能是不同的。

  • type：依赖类型，默认是jar。通常表示依赖文件的扩展名，但也有例外。一个类型可以被映射成另外一个扩展名或分类器。类型经常和使用的打包方式对应，尽管这也有例外，一些类型的例子：jar，war，ejb-client和test-jar。如果设置extensions为true，就可以在plugin里定义新的类型。
  • classifier：依赖的分类器。分类器可以区分属于同一个POM，但不同构建方式的构件。分类器名被附加到文件名的版本号后面，如果想将项目构建成两个单独的JAR，分别使用Java 4和6编译器，就可以使用分类器来生成两个单独的JAR构件

3、依赖传递

    依赖传递相关的子元素主要有两个，用于依赖排除的exclusions和设置依赖是否可选的optional。

  • exclusions：排除该项目中的一些依赖，即本项目A依赖该dependency指示的项目B，但是不依赖项目B中依赖的这些依赖；
  • optional：可选依赖，用于阻断依赖的传递性，即本项目不会依赖父项目中optional设置为true的依赖。

4、依赖范围

    还有一些其他元素：

  • scope：依赖范围。在项目发布过程中，帮助决定哪些构件被包括进来
                    - compile：默认范围，用于编译;   - provided：类似于编译，但支持jdk或者容器提供，类似于classpath 
                    - runtime: 在执行时需要使用;         - systemPath: 仅用于范围为system，提供相应的路径 
                    - test: 用于test任务时使用;             - system: 需要外在提供相应的元素，通过systemPath来取得 
                    - optional: 当项目自身被依赖时，标注依赖是否传递。用于连续依赖时使用
  • systemPath：该元素为依赖规定了文件系统上的绝对路径。仅在scope设置成system时才会使用。不推荐使用这个元素。不推荐使用绝对路径，如果必须要用，推荐使用属性匹配绝对路径，例如${java.home}

六、生成文档相关的元素

  1.     <!--项目的名称, Maven生成文档使用 -->
  2.     <name>project-maven</name>
  3.  
  4.     <!--项目主页的URL, Maven生成文档使用 -->
  5.     <url>http://123.a.b/nsnxs</url>
  6.  
  7.     <!-- 项目的详细描述, Maven生成文档使用。当这个元素能够用HTML格式描述时，不鼓励使用纯文本描述 -->
  8.     <!--如果你需要修改生成的web站点的索引页面，你应该修改你自己的索引页文件，而不是调整这里的文档 -->
  9.     <description>Description of this maven project</description>

    备注：maven可以通过mvn site命令生成项目的相关文档。

    和生成文档相关的元素，包括name，url，和description。

  • name：项目名称，maven生成文档会使用项目名；
  • url：项目主页的地址，maven生成文档的时候使用。
  • description：项目描述。如果可以使用HTML格式进行描述的时候，不推荐使用纯文本的描述。

七、远程仓库列表

    远程仓库列表的配置，包括依赖和扩展的远程仓库配置，以及插件的远程仓库配置。在本地仓库找不到的情况下，maven下载依赖、扩展和插件就是从这里配置的远程仓库中进行下载。

    需要注意的是release和snapshot两者的区别。release是稳定版本，一经发布不再修改，想发布修改后的项目，只能升级项目版本再进行发布；snapshot是不稳定的，一个snapshot的版本可以不断改变。项目在开发期间一般会使用snapshot，更方便进行频繁的代码更新；一旦发布到外部，或者开发基本完成，代码迭代不再频繁，则推荐使用release。

  1.     <!--发现依赖和扩展的远程仓库列表。 -->
  2.     <repositories>
  3.         <!--包含需要连接到远程仓库的信息 -->
  4.         <repository>
  5.             <!--如何处理远程仓库里发布版本的下载 -->
  6.             <releases>
  7.                 <!--值为true或者false，表示该仓库是否为下载某种类型构件（发布版，快照版）开启。 -->
  8.                 <enabled />
  9.                 <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳 -->
  10.                 <!--选项：always，daily（默认），interval：X（X单位为分钟），或者never。 -->
  11.                 <updatePolicy />
  12.                 <!--当Maven验证构件校验文件失败时该怎么做。选项：ignore，fail，或者warn -->
  13.                 <checksumPolicy />
  14.             </releases>
  15.             <!-- 如何处理远程仓库里快照版本的下载 -->
  16.             <!-- 有了releases和snapshots这两组配置，就可以在每个单独的仓库中，为每种类型的构件采取不同的策略 -->
  17.             <snapshots>
  18.                 <enabled />
  19.                 <updatePolicy />
  20.                 <checksumPolicy />
  21.             </snapshots>
  22.  
  23.             <!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->
  24.             <id>nanxs-repository-proxy</id>
  25.             <!--远程仓库名称 -->
  26.             <name>nanxs-repository-proxy</name>
  27.             <!--远程仓库URL，按protocol://hostname/path形式 -->
  28.             <url>http://192.168.1.169:9999/repository/</url>
  29.             <!-- 用于定位和排序构件的仓库布局类型。可以是default或者legacy -->
  30.             <layout>default</layout>
  31.         </repository>
  32.     </repositories>
  33.     
  34.     <!--发现插件的远程仓库列表，这些插件用于构建和报表 -->
  35.     <pluginRepositories>
  36.         <!--包含需要连接到远程插件仓库的信息。参见repositories/repository元素 -->
  37.         <pluginRepository>
  38.             ......
  39.         </pluginRepository>
  40.     </pluginRepositories>

八、项目分发信息相关元素

  1.     <!--项目分发信息，在执行mvn deploy后表示要发布的位置。用于把网站部署到远程服务器或者把构件部署到远程仓库 -->
  2.     <distributionManagement>
  3.         <!--部署项目产生的构件到远程仓库需要的信息 -->
  4.         <repository>
  5.             <!-- 是分配给快照一个唯一的版本号 -->
  6.             <uniqueVersion />
  7.             <!-- 其他配置参见repositories/repository元素 -->
  8.             <id>nanxs-maven2</id>
  9.             <name>nanxsmaven2</name>
  10.             <url>file://${basedir}/target/deploy</url>
  11.             <layout />
  12.         </repository>
  13.         <!--构件的快照部署的仓库。默认部署到distributionManagement/repository元素配置的仓库 -->
  14.         <snapshotRepository>
  15.             <uniqueVersion />
  16.             <id>nanxs-maven2</id>
  17.             <name>Nanxs-maven2 Snapshot Repository</name>
  18.             <url>scp://svn.baidu.com/nanxs:/usr/local/maven-snapshot</url>
  19.             <layout />
  20.         </snapshotRepository>
  21.         <!--部署项目的网站需要的信息 -->
  22.         <site>
  23.             <!--部署位置的唯一标识符，用来匹配站点和settings.xml文件里的配置 -->
  24.             <id>nanxs-site</id>
  25.             <!--部署位置的名称 -->
  26.             <name>business api website</name>
  27.             <!--部署位置的URL，按protocol://hostname/path形式 -->
  28.             <url>scp://svn.baidu.com/nanxs:/var/www/localhost/nanxs-web</url>
  29.         </site>
  30.         <!--项目下载页面的URL。如果没有该元素，用户应该参考主页 -->
  31.         <!--本元素是为了帮助定位那些不在仓库里的构件(license限制) -->
  32.         <downloadUrl />
  33.         <!--如果构件有了新的group ID和artifact ID（构件移到了新的位置），这里列出构件的重定位信息 -->
  34.         <relocation>
  35.             <!--构件新的group ID -->
  36.             <groupId />
  37.             <!--构件新的artifact ID -->
  38.             <artifactId />
  39.             <!--构件新的版本号 -->
  40.             <version />
  41.             <!--显示给用户的，关于移动的额外信息，例如原因 -->
  42.             <message />
  43.         </relocation>
  44.         <!-- 给出该构件在远程仓库的状态。本地项目中不能设置该元素，因为这是工具自动更新的 -->
  45.         <!-- 有效的值有：none（默认），converted（仓库管理员从 Maven 1 POM转换过来），
  46.             partner（直接从伙伴Maven 2仓库同步过来），deployed（从Maven 2实例部署），
  47.             verified（被核实时正确的和最终的） -->
  48.         <status />
  49.     </distributionManagement>

    项目分发信息的相关配置，在distributionManagement中设置。设置的内容包括：

  • repository和snapshotRepository：项目产生的构建/快照构建部署的远程仓库。如果不配置snapshotRepository，快照也会部署到repository中；
  • site：部署项目的网站需要的信息；
  • downloadUrl：项目下载页面的URL，这是为不在仓库中的构建提供的；
  • relocation：如果构件有了新的group ID和artifact ID（移到了新的位置），这里列出构件的新的信息；
  • status：给出该构件在远程仓库的状态，本地项目中不能设置该元素，这是工具自动更新的。

九、报表规范

    报表规范描述的是使用mvn site命令时使用的一些配置。

  1.     <!-- 该元素描述使用报表插件产生报表的规范 -->
  2.     <!-- 当用户执行"mvn site"，这些报表就会运行，在页面导航栏能看到所有报表的链接 -->
  3.     <reporting>
  4.         <!--网站是否排除默认的报表。这包括"项目信息"菜单中的报表。 -->
  5.         <excludeDefaults />
  6.         <!--所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 -->
  7.         <outputDirectory />
  8.         <!--使用的报表插件和他们的配置。 -->
  9.         <plugins>
  10.             <!--plugin元素包含描述报表插件需要的信息 -->
  11.             <plugin>
  12.                 <!--报表插件定位：groupId + artifactId + version -->
  13.                 <groupId />
  14.                 <artifactId />
  15.                 <version />
  16.  
  17.                 <!--任何配置是否被传播到子项目 -->
  18.                 <inherited />
  19.                 <!--报表插件的配置 -->
  20.                 <configuration />
  21.                 <!-- 一组报表的多重规范，每个规范可能有不同的配置。一个规范（报表集）对应一个执行目标 -->
  22.                 <!-- 例如，有1~9这9个报表。1，2构成A报表集，对应一个执行目标；2，5构成B报表集，对应另一个执行目标 -->
  23.                 <reportSets>
  24.                     <!--表示报表的一个集合，以及产生该集合的配置 -->
  25.                     <reportSet>
  26.                         <!--报表集合的唯一标识符，POM继承时用到 -->
  27.                         <id />
  28.                         <!--产生报表集合时，被使用的报表的配置 -->
  29.                         <configuration />
  30.                         <!--配置是否被继承到子POMs -->
  31.                         <inherited />
  32.                         <!--这个集合里使用到哪些报表 -->
  33.                         <reports />
  34.                     </reportSet>
  35.                 </reportSets>
  36.             </plugin>
  37.         </plugins>
  38.     </reporting>

十、profile配置

  1.     <!--在列的项目构建profile，如果被激活，会修改构建处理 -->
  2.     <profiles>
  3.         <!--根据环境参数或命令行参数激活某个构建处理 -->
  4.         <profile>
  5.             <!--构建配置的唯一标识符。即用于命令行激活，也用于在继承时合并具有相同标识符的profile。 -->
  6.             <id />
  7.             <!--自动触发profile的条件逻辑。Activation是profile的开启钥匙，profile的力量来自于它 -->
  8.             <!-- 能够在某些特定的环境中自动使用某些特定的值；这些环境通过activation元素指定。activation元素并不是激活profile的唯一方式 -->
  9.             <activation>
  10.                 <!--profile默认是否激活的标志 -->
  11.                 <activeByDefault />
  12.                 <!--当匹配的jdk被检测到，profile被激活。例如，1.4激活JDK1.4，1.4.0_2，而!1.4激活所有版本不是以1.4开头的JDK -->
  13.                 <jdk />
  14.                 <!--当匹配的操作系统属性被检测到，profile被激活。os元素可以定义一些操作系统相关的属性。 -->
  15.                 <os>
  16.                     <!--激活profile的操作系统的名字 -->
  17.                     <name>Windows XP</name>
  18.                     <!--激活profile的操作系统所属家族(如 'windows') -->
  19.                     <family>Windows</family>
  20.                     <!--激活profile的操作系统体系结构 -->
  21.                     <arch>x86</arch>
  22.                     <!--激活profile的操作系统版本 -->
  23.                     <version>5.1.2600</version>
  24.                 </os>
  25.                 <!--如果Maven检测到某一个属性（其值可以在POM中通过${名称}引用），其拥有对应的名称和值，Profile就会被激活 -->
  26.                 <!--如果值字段是空的，那么存在属性名称字段就会激活profile，否则按区分大小写方式匹配属性值字段 -->
  27.                 <property>
  28.                     <!--激活profile的属性的名称 -->
  29.                     <name>mavenVersion</name>
  30.                     <!--激活profile的属性的值 -->
  31.                     <value>2.0.3</value>
  32.                 </property>
  33.                 <!--提供一个文件名，通过检测该文件的存在或不存在来激活profile。missing检查文件是否存在，如果不存在则激活profile -->
  34.                 <!--另一方面，exists则会检查文件是否存在，如果存在则激活profile -->
  35.                 <file>
  36.                     <!--如果指定的文件存在，则激活profile。 -->
  37.                     <exists>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/
  38.                     </exists>
  39.                     <!--如果指定的文件不存在，则激活profile。 -->
  40.                     <missing>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/
  41.                     </missing>
  42.                 </file>
  43.             </activation>
  44.  
  45.             <!--构建项目所需要的信息。参见build元素 -->
  46.             <build />
  47.             <!--发现依赖和扩展的远程仓库列表。详情参见repositories元素 -->
  48.             <repositories />
  49.             <!--发现插件的远程仓库列表，这些插件用于构建和报表。详情参见pluginRepositories元素 -->
  50.             <pluginRepositories />
  51.             <!--该元素描述了项目相关的所有依赖。 详细配置参见dependencies -->
  52.             <dependencies />
  53.             <!--该元素包括使用报表插件产生报表的规范。当用户执行"mvn site"，这些报表就会运行。在页面导航栏能看到所有报表的链接。参见reporting元素 -->
  54.             <reporting />
  55.             <!--参见dependencyManagement元素 -->
  56.             <dependencyManagement />
  57.             <!--参见distributionManagement元素 -->
  58.             <distributionManagement />
  59.  
  60.             <!--不赞成使用. 现在Maven忽略该元素. -->
  61.             <reports />
  62.             <!--模块（有时称作子项目） 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 -->
  63.             <modules />
  64.             <!--参见properties元素 -->
  65.             <properties />
  66.         </profile>
  67.     </profiles>

 

十一、邮件列表和持续集成配置

  1.     <!--项目持续集成信息 -->
  2.     <ciManagement>
  3.         <!--持续集成系统的名字，例如continuum -->
  4.         <system />
  5.         <!--该项目使用的持续集成系统的URL（如果持续集成系统有web接口的话）。 -->
  6.         <url />
  7.         <!--构建完成时，需要通知的开发者/用户的配置项。包括被通知者信息和通知条件（错误，失败，成功，警告） -->
  8.         <notifiers>
  9.             <!--配置一种方式，当构建中断时，以该方式通知用户/开发者 -->
  10.             <notifier>
  11.                 <!--传送通知的途径 -->
  12.                 <type />
  13.                 <!--发生错误时是否通知 -->
  14.                 <sendOnError />
  15.                 <!--构建失败时是否通知 -->
  16.                 <sendOnFailure />
  17.                 <!--构建成功时是否通知 -->
  18.                 <sendOnSuccess />
  19.                 <!--发生警告时是否通知 -->
  20.                 <sendOnWarning />
  21.                 <!--不赞成使用。通知发送到哪里 -->
  22.                 <address />
  23.                 <!--扩展配置项 -->
  24.                 <configuration />
  25.             </notifier>
  26.         </notifiers>
  27.     </ciManagement>
  28.  
  29.     <!--项目相关邮件列表信息 -->
  30.     <mailingLists>
  31.         <!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->
  32.         <mailingList>
  33.             <!--邮件的名称 -->
  34.             <name>Demo</name>
  35.             <!--发送邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
  36.             <post>nanxs@123.com</post>
  37.             <!--订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
  38.             <subscribe>nanxs@123.com</subscribe>
  39.             <!--取消订阅邮件的地址或链接，如果是邮件地址，创建文档时，mailto: 链接会被自动创建 -->
  40.             <unsubscribe>nanxs@123.com</unsubscribe>
  41.             <!--你可以浏览邮件信息的URL -->
  42.             <archive>http:/a.b.c/nanxs/demo/dev/</archive>
  43.         </mailingList>
  44.     </mailingLists>

十二、项目的描述性信息

  1.     <!--项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL -->
  2.     <issueManagement>
  3.         <!--问题管理系统（例如jira）的名字， -->
  4.         <system>jira</system>
  5.         <!--该项目使用的问题管理系统的URL -->
  6.         <url>http://jira.baidu.com/nanxs</url>
  7.     </issueManagement>
  8.  
  9.     <!--项目创建年份，4位数字。当产生版权信息时需要使用这个值。 -->
  10.     <inceptionYear />
  11.  
  12.     <!--项目开发者列表 -->
  13.     <developers>
  14.         <!--某个项目开发者的信息 -->
  15.         <developer>
  16.             <!--SCM里项目开发者的唯一标识符 -->
  17.             <id>HELLO WORLD</id>
  18.             <!--项目开发者的全名 -->
  19.             <name>nanxs</name>
  20.             <!--项目开发者的email -->
  21.             <email>123@abc.com</email>
  22.             <!--项目开发者的主页的URL -->
  23.             <url />
  24.             <!--项目开发者在项目中扮演的角色，角色元素描述了各种角色 -->
  25.             <roles>
  26.                 <role>Project Manager</role>
  27.                 <role>Architect</role>
  28.             </roles>
  29.             <!--项目开发者所属组织 -->
  30.             <organization>demo</organization>
  31.             <!--项目开发者所属组织的URL -->
  32.             <organizationUrl>http://a.b.com/nanxs</organizationUrl>
  33.             <!--项目开发者属性，如即时消息如何处理等 -->
  34.             <properties>
  35.                 <dept>No</dept>
  36.             </properties>
  37.             <!--项目开发者所在时区， -11到12范围内的整数。 -->
  38.             <timezone>-5</timezone>
  39.         </developer>
  40.     </developers>
  41.  
  42.     <!--项目的其他贡献者列表 -->
  43.     <contributors>
  44.         <!--项目的其他贡献者。参见developers/developer元素 -->
  45.         <contributor>
  46.             <name />
  47.             <email />
  48.             <url />
  49.             <organization />
  50.             <organizationUrl />
  51.             <roles />
  52.             <timezone />
  53.             <properties />
  54.         </contributor>
  55.     </contributors>
  56.  
  57.     <!--该元素描述了项目所有License列表。 应该只列出该项目的license列表，不要列出依赖项目的license列表 -->
  58.     <!--如果列出多个license，用户可以选择它们中的一个而不是接受所有license -->
  59.     <licenses>
  60.         <!--描述了项目的license，用于生成项目的web站点的license页面，其他一些报表和validation也会用到该元素。 -->
  61.         <license>
  62.             <!--license用于法律上的名称 -->
  63.             <name>Apache 2</name>
  64.             <!--官方的license正文页面的URL -->
  65.             <url>http://a.b.com/nanxs/LICENSE-1.0.txt</url>
  66.             <!--项目分发的主要方式： repo，可以从Maven库下载 manual， 用户必须手动下载和安装依赖 -->
  67.             <distribution>repo</distribution>
  68.             <!--关于license的补充信息 -->
  69.             <comments>A business-friendly OSS license</comments>
  70.         </license>
  71.     </licenses>
  72.  
  73.     <!--SCM(Source Control Management)标签允许你配置你的代码库，供Maven web站点和其它插件使用。 -->
  74.     <scm>
  75.         <!--SCM的URL,该URL描述了版本库和如何连接到版本库。该连接只读 -->
  76.         <connection>scm:svn:http://a.b.com/nanxs</connection>
  77.         <!--给开发者使用的，类似connection元素。即该连接不仅仅只读 -->
  78.         <developerConnection>scm:svn:http://a.b.com/nanxs</developerConnection>
  79.         <!--当前代码的标签，在开发阶段默认为HEAD -->
  80.         <tag />
  81.         <!--指向项目的可浏览SCM库（例如ViewVC或者Fisheye）的URL。 -->
  82.         <url>http://a.b.com/nanxs</url>
  83.     </scm>
  84.  
  85.     <!--描述项目所属组织的各种属性。Maven产生的文档用 -->
  86.     <organization>
  87.         <!--组织的全名 -->
  88.         <name>demo</name>
  89.         <!--组织主页的URL -->
  90.         <url>http://a.b.com/nanxs</url>
  91.     </organization>

十三、其他配置

  1.     <!--描述了这个项目构建环境中的前提条件。 -->
  2.     <prerequisites>
  3.         <!--构建该项目或使用该插件所需要的Maven的最低版本 -->
  4.         <maven />
  5.     </prerequisites>
  6.  
  7.     <!--模块（有时称作子项目） 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 -->
  8.     <modules />
  9.  
  10.     <!--以值替代名称，Properties可以在整个POM中使用，也可以作为触发条件（见settings.xml中activation元素的说明） -->
  11.     <!-格式是<name>value</name>。 -->
  12.     <properties />
  13.  
  14.     <!--不推荐使用，现在Maven忽略该元素. -->
  15.     <reports></reports>
声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/笔触狂放9/article/detail/1010560
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号