关于maven:pom文件的使用解析

作者:jingxian 时间:2022-02-08 06:21:41 

一、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默认的本地仓库目录位置

二、根元素和必要配置

<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>
   <!-- 公司或者组织的唯一标志,也是打包成jar包路径的依据 -->
   <!-- 例如com.companyname.project-group,maven打包jar包的路径:/com/companyname/project-group -->
   <groupId>com.companyname.project-group</groupId>

<!-- 项目的唯一ID,一个groupId下面可能多个项目,就是靠artifactId来区分的 -->
   <artifactId>project</artifactId>

<!-- 项目当前版本,格式为:主版本.次版本.增量版本-限定版本号 -->
   <version>1.0</version>

<!--项目产生的构件类型,包括jar、war、ear、pom等 -->
   <packaging>jar</packaging>
</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元素

<!--父项目的坐标,坐标包括group ID,artifact ID和version。 -->
   <!--如果项目中没有规定某个元素的值,那么父项目中的对应值即为项目的默认值 -->
   <parent>

<!--被继承的父项目的构件标识符 -->
       <artifactId>com.companyname.project-group</artifactId>
       <!--被继承的父项目的全球唯一标识符 -->
       <groupId>base-project</groupId>
       <!--被继承的父项目的版本 -->
       <version>1.0.1-RELEASE</version>

<!-- 父项目的pom.xml文件的相对路径,默认值是../pom.xml。 -->
       <!-- 寻找父项目的pom:构建当前项目的地方--)relativePath指定的位置--)本地仓库--)远程仓库 -->
       <relativePath>../pom.xml</relativePath>
   </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文件的位置。

四、项目构建需要的信息

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

<!--------------------- 资源管理 --------------------->
       <!--这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。 -->
       <resources>
           <!--这个元素描述了项目相关或测试相关的所有资源路径 -->
           <resource>
               <!-- 描述了资源的目标输出路径。该路径是相对于target/classes的路径 -->
               <!-- 如果是想要把资源直接放在target/classes下,不需要配置该元素 -->
               <targetPath />
               <!--是否使用参数值代替参数名。参数值取自文件里配置的属性,文件在filters元素里列出。 -->
               <filtering />
               <!--描述存放资源的目录,该路径相对POM路径 -->
               <directory />
               <!--包含的模式列表,例如**/*.xml,只有符合条件的资源文件才会在打包的时候被放入到输出路径中 -->
               <includes />
               <!--排除的模式列表,例如**/*.xml,符合的资源文件不会在打包的时候会被过滤掉 -->
               <excludes />
           </resource>
       </resources>
       <!--这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。 -->
       <testResources>
           <!--这个元素描述了测试相关的所有资源路径,子元素说明参考build/resources/resource元素的说明 -->
           <testResource>
               <targetPath />
               <filtering />
               <directory />
               <includes />
               <excludes />
           </testResource>
       </testResources>

<!--------------------- 插件管理 --------------------->
       <!-- 子项目可以引用的默认插件信息。pluginManagement中的插件直到被引用时才会被解析或绑定到生命周期 -->
       <!-- 这里只是做了声明,并没有真正的引入。给定插件的任何本地配置都会覆盖这里的配置-->
       <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>

<!--------------------- 构建扩展 --------------------->
       <!--使用来自其他项目的一系列构建扩展 -->
       <extensions>
           <!--每个extension描述一个会使用到其构建扩展的一个项目,extension的子元素是项目的坐标 -->
           <extension>
               <!--项目坐标三元素:groupId + artifactId + version -->
               <groupId />
               <artifactId />
               <version />
           </extension>
       </extensions>

<!--------------------- 其他配置 --------------------->
       <!--当项目没有规定目标(Maven2 叫做阶段)时的默认值 -->
       <defaultGoal />
       <!--构建产生的所有文件存放的目录 -->
       <directory />
       <!--产生的构件的文件名,默认值是${artifactId}-${version}。 -->
       <finalName />
       <!--当filtering开关打开时,使用到的过滤器属性文件列表 -->
       <filters />
   </build>

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

1、路径管理

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

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

  • sourceDirectory:项目源码目录,定义的是相对于pom文件的相对路径;

  • testSourceDirectory:项目单元测试源码目录,定义的也是是相对于pom文件的相对路径;

  • outputDirectory:被编译过的应用程序class文件存放的目录,也是是相对于pom文件的相对路径;

  • testOutoutDIrectory:被编译过的测试class文件存放的目录,也是是相对于pom文件的相对路径;

  • scriptSourceDirectory:项目脚本源码目录,也是是相对于pom文件的相对路径。由于脚本是解释性的语言,所以该目录下的内容,会直接被拷贝到输出目录,而不需要编译。

2、资源管理

<!--------------------- 资源管理 --------------------->
       <!--这个元素描述了项目相关的所有资源路径列表,例如和项目相关的属性文件,这些资源被包含在最终的打包文件里。 -->
       <resources>
           <!--这个元素描述了项目相关或测试相关的所有资源路径 -->
           <resource>
               <!-- 描述了资源的目标输出路径。该路径是相对于target/classes的路径 -->
               <!-- 如果是想要把资源直接放在target/classes下,不需要配置该元素 -->
               <targetPath />
               <!--是否使用参数值代替参数名。参数值取自文件里配置的属性,文件在filters元素里列出 -->
               <filtering />
               <!--描述打包前的资源存放的目录,该路径相对POM路径 -->
               <directory />
               <!--包含的模式列表,例如**/*.xml,只有符合条件的资源文件才会在打包的时候被放入到输出路径中 -->
               <includes />
               <!--排除的模式列表,例如**/*.xml,符合的资源文件不会在打包的时候会被过滤掉 -->
               <excludes />
           </resource>
       </resources>
       <!--这个元素描述了单元测试相关的所有资源路径,例如和单元测试相关的属性文件。 -->
       <testResources>
           <!--这个元素描述了测试相关的所有资源路径,子元素说明参考build/resources/resource元素的说明 -->
           <testResource>
               <targetPath />
               <filtering />
               <directory />
               <includes />
               <excludes />
           </testResource>
       </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中定义的才是这个项目中真正需要被引入的插件。

<!--------------------- 插件管理 --------------------->
       <!-- 子项目可以引用的默认插件信息。pluginManagement中的插件直到被引用时才会被解析或绑定到生命周期 -->
       <!-- 这里只是做了声明,并没有真正的引入。给定插件的任何本地配置都会覆盖这里的配置-->
       <pluginManagement>
           <!-- 可使用的插件列表 -->
           <plugins>
               <!--plugin元素包含描述插件所需要的信息。 -->
               <plugin>
                   <!--插件定位坐标三元素:groupId + artifactId + version -->
                   <groupId />
                   <artifactId />
                   <version />
                   <!-- 是否使用这个插件的Maven扩展(extensions),默认为false -->
                   <!-- 由于性能原因,只有在真需要下载时,该元素才被设置成enabled -->
                   <extensions />
                   <!--在构建生命周期中执行一组目标的配置。每个目标可能有不同的配置。 -->
                   <executions>
                       <!--execution元素包含了插件执行需要的信息 -->
                       <execution>
                           <!--执行目标的标识符,用于标识构建过程中的目标,或者匹配继承过程中需要合并的执行目标 -->
                           <id />
                           <!--绑定了目标的构建生命周期阶段,如果省略,目标会被绑定到源数据里配置的默认阶段 -->
                           <phase />
                           <!--配置的执行目标 -->
                           <goals />
                           <!--配置是否被传播到子POM -->
                           <inherited />
                           <!--作为DOM对象的配置 -->
                           <configuration />
                       </execution>
                   </executions>
                   <!--项目引入插件所需要的额外依赖,参见dependencies元素 -->
                   <dependencies>
                           ......
                   </dependencies>
                   <!--任何配置是否被传播到子项目 -->
                   <inherited />
                   <!--作为DOM对象的配置 -->
                   <configuration />
               </plugin>
           </plugins>
       </pluginManagement>
       <!--使用的插件列表,这里是真正的引入插件。参见build/pluginManagement/plugins元素 -->
       <plugins>
           ......
       </plugins>

4、构建扩展

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

<!--------------------- 构建扩展 --------------------->
       <!--使用来自其他项目的一系列构建扩展 -->
       <extensions>
           <!--每个extension描述一个会使用到其构建扩展的一个项目,extension的子元素是项目的坐标 -->
           <extension>
               <!--项目坐标三元素:groupId + artifactId + version -->
               <groupId />
               <artifactId />
               <version />
           </extension>
       </extensions>

5、其他配置

build中还有一些配置,如下:

<!--------------------- 其他配置 --------------------->
       <!--当项目没有规定目标(Maven2 叫做阶段)时的默认值 -->
       <defaultGoal />
       <!--构建产生的所有文件存放的目录 -->
       <directory />
       <!--产生的构件的文件名,默认值是${artifactId}-${version}。 -->
       <finalName />
       <!--当filtering开关打开时,使用到的过滤器属性文件列表 -->
       <filters />

五、项目依赖相关信息

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

<!--该元素描述了项目相关的所有依赖。 这些依赖自动从项目定义的仓库中下载 -->
   <dependencies>
       <dependency>
           <!------------------- 依赖坐标 ------------------->
           <!--依赖项目的坐标三元素:groupId + artifactId + version -->
           <groupId>org.apache.maven</groupId>
           <artifactId>maven-artifact</artifactId>
           <version>3.8.1</version>

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

<!------------------- 依赖传递 ------------------->
           <!--依赖排除,即告诉maven只依赖指定的项目,不依赖该项目的这些依赖。此元素主要用于解决版本冲突问题 -->
           <exclusions>
               <exclusion>
                   <artifactId>spring-core</artifactId>
                   <groupId>org.springframework</groupId>
               </exclusion>
           </exclusions>
           <!-- 可选依赖,用于阻断依赖的传递性。如果在项目B中把C依赖声明为可选,那么依赖B的项目中无法使用C依赖 -->
           <optional>true</optional>

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

<!-- 继承自该项目的所有子项目的默认依赖信息,这部分的依赖信息不会被立即解析。 -->
   <!-- 当子项目声明一个依赖,如果group ID和artifact ID以外的一些信息没有描述,则使用这里的依赖信息 -->
   <dependencyManagement>
       <dependencies>
           <!--参见dependencies/dependency元素 -->
           <dependency>
               ......
           </dependency>
       </dependencies>
   </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}

六、生成文档相关的元素

<!--项目的名称, Maven生成文档使用 -->
   <name>project-maven</name>

<!--项目主页的URL, Maven生成文档使用 -->
   <url>http://123.a.b/nsnxs</url>

<!-- 项目的详细描述, Maven生成文档使用。当这个元素能够用HTML格式描述时,不鼓励使用纯文本描述 -->
   <!--如果你需要修改生成的web站点的索引页面,你应该修改你自己的索引页文件,而不是调整这里的文档 -->
   <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。

<!--发现依赖和扩展的远程仓库列表。 -->
   <repositories>
       <!--包含需要连接到远程仓库的信息 -->
       <repository>
           <!--如何处理远程仓库里发布版本的下载 -->
           <releases>
               <!--值为true或者false,表示该仓库是否为下载某种类型构件(发布版,快照版)开启。 -->
               <enabled />
               <!--该元素指定更新发生的频率。Maven会比较本地POM和远程POM的时间戳 -->
               <!--选项:always,daily(默认),interval:X(X单位为分钟),或者never。 -->
               <updatePolicy />
               <!--当Maven验证构件校验文件失败时该怎么做。选项:ignore,fail,或者warn -->
               <checksumPolicy />
           </releases>
           <!-- 如何处理远程仓库里快照版本的下载 -->
           <!-- 有了releases和snapshots这两组配置,就可以在每个单独的仓库中,为每种类型的构件采取不同的策略 -->
           <snapshots>
               <enabled />
               <updatePolicy />
               <checksumPolicy />
           </snapshots>

<!--远程仓库唯一标识符。可以用来匹配在settings.xml文件里配置的远程仓库 -->
           <id>nanxs-repository-proxy</id>
           <!--远程仓库名称 -->
           <name>nanxs-repository-proxy</name>
           <!--远程仓库URL,按protocol://hostname/path形式 -->
           <url>http://192.168.1.169:9999/repository/</url>
           <!-- 用于定位和排序构件的仓库布局类型。可以是default或者legacy -->
           <layout>default</layout>
       </repository>
   </repositories>

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

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

<!--项目分发信息,在执行mvn deploy后表示要发布的位置。用于把网站部署到远程服务器或者把构件部署到远程仓库 -->
   <distributionManagement>
       <!--部署项目产生的构件到远程仓库需要的信息 -->
       <repository>
           <!-- 是分配给快照一个唯一的版本号 -->
           <uniqueVersion />
           <!-- 其他配置参见repositories/repository元素 -->
           <id>nanxs-maven2</id>
           <name>nanxsmaven2</name>
           <url>file://${basedir}/target/deploy</url>
           <layout />
       </repository>
       <!--构件的快照部署的仓库。默认部署到distributionManagement/repository元素配置的仓库 -->
       <snapshotRepository>
           <uniqueVersion />
           <id>nanxs-maven2</id>
           <name>Nanxs-maven2 Snapshot Repository</name>
           <url>scp://svn.baidu.com/nanxs:/usr/local/maven-snapshot</url>
           <layout />
       </snapshotRepository>
       <!--部署项目的网站需要的信息 -->
       <site>
           <!--部署位置的唯一标识符,用来匹配站点和settings.xml文件里的配置 -->
           <id>nanxs-site</id>
           <!--部署位置的名称 -->
           <name>business api website</name>
           <!--部署位置的URL,按protocol://hostname/path形式 -->
           <url>scp://svn.baidu.com/nanxs:/var/www/localhost/nanxs-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>

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

  • repositorysnapshotRepository:项目产生的构建/快照构建部署的远程仓库。如果不配置snapshotRepository,快照也会部署到repository中;

  • site:部署项目的网站需要的信息;

  • downloadUrl:项目下载页面的URL,这是为不在仓库中的构建提供的;

  • relocation:如果构件有了新的group ID和artifact ID(移到了新的位置),这里列出构件的新的信息;

  • status:给出该构件在远程仓库的状态,本地项目中不能设置该元素,这是工具自动更新的。

九、报表规范

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

<!-- 该元素描述使用报表插件产生报表的规范 -->
   <!-- 当用户执行"mvn site",这些报表就会运行,在页面导航栏能看到所有报表的链接 -->
   <reporting>
       <!--网站是否排除默认的报表。这包括"项目信息"菜单中的报表。 -->
       <excludeDefaults />
       <!--所有产生的报表存放到哪里。默认值是${project.build.directory}/site。 -->
       <outputDirectory />
       <!--使用的报表插件和他们的配置。 -->
       <plugins>
           <!--plugin元素包含描述报表插件需要的信息 -->
           <plugin>
               <!--报表插件定位:groupId + artifactId + version -->
               <groupId />
               <artifactId />
               <version />

<!--任何配置是否被传播到子项目 -->
               <inherited />
               <!--报表插件的配置 -->
               <configuration />
               <!-- 一组报表的多重规范,每个规范可能有不同的配置。一个规范(报表集)对应一个执行目标 -->
               <!-- 例如,有1~9这9个报表。1,2构成A报表集,对应一个执行目标;2,5构成B报表集,对应另一个执行目标 -->
               <reportSets>
                   <!--表示报表的一个集合,以及产生该集合的配置 -->
                   <reportSet>
                       <!--报表集合的唯一标识符,POM继承时用到 -->
                       <id />
                       <!--产生报表集合时,被使用的报表的配置 -->
                       <configuration />
                       <!--配置是否被继承到子POMs -->
                       <inherited />
                       <!--这个集合里使用到哪些报表 -->
                       <reports />
                   </reportSet>
               </reportSets>
           </plugin>
       </plugins>
   </reporting>

十、profile配置

<!--在列的项目构建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/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/
                   </exists>
                   <!--如果指定的文件不存在,则激活profile。 -->
                   <missing>/usr/local/abcd/abcd-home/jobs/maven-guide-zh-to-production/workspace/
                   </missing>
               </file>
           </activation>

<!--构建项目所需要的信息。参见build元素 -->
           <build />
           <!--发现依赖和扩展的远程仓库列表。详情参见repositories元素 -->
           <repositories />
           <!--发现插件的远程仓库列表,这些插件用于构建和报表。详情参见pluginRepositories元素 -->
           <pluginRepositories />
           <!--该元素描述了项目相关的所有依赖。 详细配置参见dependencies -->
           <dependencies />
           <!--该元素包括使用报表插件产生报表的规范。当用户执行"mvn site",这些报表就会运行。在页面导航栏能看到所有报表的链接。参见reporting元素 -->
           <reporting />
           <!--参见dependencyManagement元素 -->
           <dependencyManagement />
           <!--参见distributionManagement元素 -->
           <distributionManagement />

<!--不赞成使用. 现在Maven忽略该元素. -->
           <reports />
           <!--模块(有时称作子项目) 被构建成项目的一部分。列出的每个模块元素是指向该模块的目录的相对路径 -->
           <modules />
           <!--参见properties元素 -->
           <properties />
       </profile>
   </profiles>

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

<!--项目持续集成信息 -->
   <ciManagement>
       <!--持续集成系统的名字,例如continuum -->
       <system />
       <!--该项目使用的持续集成系统的URL(如果持续集成系统有web接口的话)。 -->
       <url />
       <!--构建完成时,需要通知的开发者/用户的配置项。包括被通知者信息和通知条件(错误,失败,成功,警告) -->
       <notifiers>
           <!--配置一种方式,当构建中断时,以该方式通知用户/开发者 -->
           <notifier>
               <!--传送通知的途径 -->
               <type />
               <!--发生错误时是否通知 -->
               <sendOnError />
               <!--构建失败时是否通知 -->
               <sendOnFailure />
               <!--构建成功时是否通知 -->
               <sendOnSuccess />
               <!--发生警告时是否通知 -->
               <sendOnWarning />
               <!--不赞成使用。通知发送到哪里 -->
               <address />
               <!--扩展配置项 -->
               <configuration />
           </notifier>
       </notifiers>
   </ciManagement>

<!--项目相关邮件列表信息 -->
   <mailingLists>
       <!--该元素描述了项目相关的所有邮件列表。自动产生的网站引用这些信息。 -->
       <mailingList>
           <!--邮件的名称 -->
           <name>Demo</name>
           <!--发送邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->
           <post>nanxs@123.com</post>
           <!--订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->
           <subscribe>nanxs@123.com</subscribe>
           <!--取消订阅邮件的地址或链接,如果是邮件地址,创建文档时,mailto: 链接会被自动创建 -->
           <unsubscribe>nanxs@123.com</unsubscribe>
           <!--你可以浏览邮件信息的URL -->
           <archive>http:/a.b.c/nanxs/demo/dev/</archive>
       </mailingList>
   </mailingLists>

十二、项目的描述性信息

<!--项目的问题管理系统(Bugzilla, Jira, Scarab,或任何你喜欢的问题管理系统)的名称和URL -->
   <issueManagement>
       <!--问题管理系统(例如jira)的名字, -->
       <system>jira</system>
       <!--该项目使用的问题管理系统的URL -->
       <url>http://jira.baidu.com/nanxs</url>
   </issueManagement>

<!--项目创建年份,4位数字。当产生版权信息时需要使用这个值。 -->
   <inceptionYear />

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

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

<!--该元素描述了项目所有License列表。 应该只列出该项目的license列表,不要列出依赖项目的license列表 -->
   <!--如果列出多个license,用户可以选择它们中的一个而不是接受所有license -->
   <licenses>
       <!--描述了项目的license,用于生成项目的web站点的license页面,其他一些报表和validation也会用到该元素。 -->
       <license>
           <!--license用于法律上的名称 -->
           <name>Apache 2</name>
           <!--官方的license正文页面的URL -->
           <url>http://a.b.com/nanxs/LICENSE-1.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描述了版本库和如何连接到版本库。该连接只读 -->
       <connection>scm:svn:http://a.b.com/nanxs</connection>
       <!--给开发者使用的,类似connection元素。即该连接不仅仅只读 -->
       <developerConnection>scm:svn:http://a.b.com/nanxs</developerConnection>
       <!--当前代码的标签,在开发阶段默认为HEAD -->
       <tag />
       <!--指向项目的可浏览SCM库(例如ViewVC或者Fisheye)的URL。 -->
       <url>http://a.b.com/nanxs</url>
   </scm>

<!--描述项目所属组织的各种属性。Maven产生的文档用 -->
   <organization>
       <!--组织的全名 -->
       <name>demo</name>
       <!--组织主页的URL -->
       <url>http://a.b.com/nanxs</url>
   </organization>

十三、其他配置

<!--描述了这个项目构建环境中的前提条件。 -->
   <prerequisites>
       <!--构建该项目或使用该插件所需要的Maven的最低版本 -->
       <maven />
   </prerequisites>

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

<!--以值替代名称,Properties可以在整个POM中使用,也可以作为触发条件(见settings.xml中activation元素的说明) -->
   <!-格式是<name>value</name>。 -->
   <properties />

<!--不推荐使用,现在Maven忽略该元素. -->
   <reports></reports>

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。 

来源:https://blog.csdn.net/weixin_38569499/article/details/91456988

标签:maven,pom,文件
0
投稿

猜你喜欢

  • MyBatis注解式开发映射语句详解

    2023-06-07 20:31:23
  • Java虚拟机之类加载

    2022-11-15 05:19:19
  • 手写java性能测试框架第二版

    2023-03-15 14:07:31
  • Unity实现UI光晕效果(发光效果)

    2022-07-08 16:37:41
  • 详谈Java中Object类中的方法以及finalize函数作用

    2021-05-29 07:59:25
  • Android实现系统级悬浮按钮

    2022-12-15 00:44:26
  • Android WebView实现长按保存图片及长按识别二维码功能

    2021-08-18 18:56:09
  • C# XML基础入门小结(XML文件内容增删改查清)

    2022-10-18 17:12:02
  • SpringBoot下的值注入(推荐)

    2023-04-01 04:45:01
  • 解决Springboot get请求是参数过长的情况

    2023-11-27 16:45:37
  • java 多态性详解及常见面试题

    2023-03-15 18:08:49
  • 浅析C#中的Main(String[] args)参数输入问题

    2023-08-13 01:45:58
  • java集合求和最大值最小值示例分享

    2022-10-11 04:15:10
  • Android自定义控件实现边缘凹凸的卡劵效果

    2022-10-01 01:20:51
  • Springboot如何根据实体类生成数据库表

    2023-11-20 13:54:39
  • C#使用WebClient实现上传下载

    2022-04-22 21:46:31
  • android TabHost(选项卡)的使用方法

    2021-08-09 10:08:39
  • 利用Lambda表达式创建新线程案例

    2023-08-26 23:16:00
  • c#动态加载卸载DLL的方法

    2023-06-08 08:18:08
  • Spring Data JPA 映射VO/DTO对象方式

    2022-10-13 10:25:27
  • asp之家 软件编程 m.aspxhome.com