maven配置pom.xml详解介绍

pom文件作为MAVEN中重要的配置文件，对于它的配置相当重要。文件中包含了开发者需要遵循的规则，缺陷管理系统，组织，licenses，项目信息，项目依赖性等。 下面我们来看一下pom.xml文件的基本组成与功能

标签预览

<project>
    <modelVersion>4.0.0modelVersion>
    
    <groupId>...groupId>
    <artifactId>...artifactId>
    <version>...version>
    <packaging>...packaging>
    <name>...name>
    <url>...url>
    <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. groupId: 项目或者组织的唯一标志，如com.dream生成的相对路径为:/com/dream
2. artifactId: 项目的通用名称
3. version: 项目的版本
4. packaging: 打包机制，如pom，jar，maven-plugin，ejb，war，ear，rar，par
5. name: 用户描述项目的名称，无关紧要的东西，非必要
6. url: 开发团队官方地址，非必要
7. classifer: 分类

对于以上基本标签，groupId artifactId version packaging作为项目唯一坐标

POM依赖关系设置

对于POM文件中的关系，主要有依赖，继承 合成等关系

<dependencies>
    <dependency>
        <groupId>junitgroupId>
        <artifactId>junitartifactId>
        <version>4.0version>
        <type>jartype>
        <scope>testscope>
        <optional>trueoptional>
    dependency>
    
    <dependency>
    <groupId>com.alibaba.china.sharedgroupId>
    <artifactId>alibaba.apollo.webxartifactId>
    <version>2.5.0version>
    <exclusions>
        <exclusion>
            <artifactId>org.slf4j.slf4j-apiartifactId>
            <groupId>com.alibaba.externalgroupId>
        exclusion>
        ....
    exclusions>
    ......
dependencies>

dependency介绍

dependency下面包含众多子标签

1. type: 默认为jar类型，常用的类型有：jar,ejb-client,test-jar…,可设置plugins中的extensions值为true后在增加新类型。

2. scope：用来指定当前包的依赖范围

   • compile（编译范围），是默认的范围，编译范围依赖在所有的classpath中可用，同时它们也会被打包。
   • provided（已提供范围），只有在当JDK或者一个容器已提供该依赖之后才使用。
   • runtime（运行时范围），在运行和测试系统的时候需要。
   • test（测试范围），在一般的 编译和运行时都不需要。
   • system（系统范围），与provided类似

3. optional：设置指依赖是否可选，默认为false,即子项目默认都继承，为true,则子项目必需显示的引入，与dependencyManagement里定义的依赖类似 。

4. exclusions：如果X需要A,A包含B依赖，那么X可以声明不要B依赖，只要在exclusions中声明exclusion。

5. exclusion：将B从依赖树中删除，如上配置，alibaba.apollo.webx不想使用com.alibaba.external ,但是alibaba.apollo.webx是集成了com.alibaba.external,r所以就需要排除掉。

6. parent：如果一个工程作为父类工程，那就必须添加pom,子系统要继承父类，也必须使用parent标签。对于子系统使用如下所示：

    
       org.codehaus.mojo 
       my-parent 
       2.0 
       ../my-parent 
   
   

7. dependencyManagement：用于帮助管理chidren的dependencies，优点就是可以集中管理版本。

8. modules：多模块项目的标签，顺序不重要，MAVEN会自动拓展排序。使用如下所示：

   
   <modules>
       <module>ygb-service-configmodule>
       <module>ygb-service-busmodule>
       <module>ygb-service-policy-centermodule>
       <module>ygb-service-letter-of-indemnitymodule>
       <module>ygb-service-authentication-centermodule>
       <module>ygb-service-eureka-centermodule>
       <module>ygb-service-api-gatewaymodule>
       <module>ygb-service-demomodule>
       <module>ygb-service-cache-ehcachemodule>
       <module>ygb-service-mavenmodule>
   modules>
   

9. properties：POM文件常量定义区，在文件中可以直接引用，如版本、编码等。如下所示：

   <properties>
     <file.encoding>UTF-8file_encoding>
     <java.source.version>1.8java_source_version>
     <java.target.version>1.8java_target_version>
   properties>   
   
   

   使用方式：${file.encoding}

MAVEN构建设置

这部分主要是对项目的构建过程进行配置，包括打包的方式、插件的安装等。配置如下所示：

<build>
    
    <plugins>
        <plugin>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-maven-pluginartifactId>
        plugin>
    plugins>
build>

build模块设置

1. defaultGoal ：默认的目标，必须跟命令行上的参数相同，如：jar:jar,或者与时期parse相同,例如install。
2. directory：指定build target目标的目录，默认为$(basedir}/target,即项目根目录下的target。
3. finalName：指定去掉后缀的工程名字，例如：默认为$artifactId-${version}。
4. filters：定义指定filter属性的位置，例如filter元素赋值filters/filter1.properties,那么这个文件里面就可以定义name=value对，这个name=value对的值就可以在工程pom中通过$name引用，默认的filter目录是${basedir}/src/main/fiters/。

resources：描述工程中各种文件资源的位置 。

<resource> 
    <targetPath>META-INF/plexustargetPath> 
    <filtering>falsefiltering> 
    <directory>${basedir}/src/main/plexusdirectory> 
    <includes> 
        <include>configuration.xmlinclude> 
    includes> 
    <excludes> 
        <exclude>**/*.propertiesexclude> 
    excludes> 
resource>

子标签介绍:

1. targetPath：指定build资源具体目录，默认是base directory。
2. filtering：指定是否将filter文件的变量值在这个resource文件有效。即上面说的filters里定义的*.property文件。例如上面就指定那些变量值在configuration文件无效，设置为false。
3. directory：指定属性文件的目录，build的过程需要找到它，并且将其放到targetPath下，默认的directory是**${basedir}/src/main/resources**。
4. includes：指定包含文件的patterns,符合样式并且在directory目录下的文件将会包含进project的资源文件。
5. excludes：指定不包含在内的patterns。
6. testResources：包含测试资源元素。默认的测试资源路径是${basedir}/src/test/resources,测试资源是不部署的。

plugins配置

对于打包插件的相关配置在该模块配置。样例如下：

<plugin> 
    <groupId>org.apache.maven.pluginsgroupId> 
    <artifactId>maven-jar-pluginartifactId> 
    <version>2.0version> 
    <extensions>falseextensions> 
    <inherited>trueinherited> 
    <configuration> 
      <classifier>testclassifier> 
    configuration> 
    <dependencies>...dependencies> 
    <executions>...executions> 
plugin>

子标签说明：

1. extensions：true or false, 决定是否要load这个plugin的extensions，默认为true。
2. inherited：是否让子pom继承，ture or false 默认为true。
3. configuration：通常用于私有不开源的plugin,不能够详细了解plugin的内部工作原理，但使plugin满足的properties
4. dependencies：与pom基础的dependencies的结构和功能都相同，只是plugin的dependencies用于plugin,而pom的denpendencies用于项目本身。
5. dependencies：排除一些用不到的dependency或者修改dependency的版本等。
6. executions：plugin也有很多个目标，每个目标具有不同的配置，executions就是设定plugin的目标。

 <execution> 
     <id>echodirid> 
     <goals> 
       <goal>rungoal> 
     goals> 
     <phase>verifyphase> 
     <inherited>falseinherited> 
     <configuration> 
       <tasks> 
         <echo>Build Dir: ${project.build.directory}echo> 
       tasks> 
     configuration> 
 execution> 

pluginManagement配置

pluginManagement的作用类似于denpendencyManagement,只是denpendencyManagement是用于管理项目jar包依赖，pluginManagement是用于管理plugin。样例如下：

<pluginManagement> 
  <plugins> 
    <plugin> 
      <groupId>org.apache.maven.pluginsgroupId> 
      <artifactId>maven-jar-pluginartifactId> 
      <version>2.2version> 
      <executions> 
        <execution> 
          <id>pre-process-classesid> 
          <phase>compilephase> 
          <goals> 
            <goal>jargoal> 
          goals> 
          <configuration> 
            <classifier>pre-processclassifier> 
          configuration> 
        execution> 
      executions> 
    plugin> 
  plugins> 
pluginManagement> 

与pom build里的plugins区别是，这里的plugin是列出来，然后让子pom来决定是否引用。

子pom引用方法： 在pom的build里的plugins引用：

<plugins> 
  <plugin> 
    <groupId>org.apache.maven.pluginsgroupId> 
    <artifactId>maven-jar-pluginartifactId> 
  plugin> 
plugins>

reporting设置

reporting包含site生成阶段的一些元素，某些maven plugin可以生成reports并且在reporting下配置。reporting里面的reportSets和build里面的executions的作用都是控制pom的不同粒度去控制build的过程，我们不单要配置plugins，还要配置那些plugins单独的goals。样例如下：

<reporting> 
    <plugins> 
      <plugin> 
        ... 
        <reportSets> 
          <reportSet> 
            <id>sunlinkid> 
            <reports> 
              <report>javadocreport> 
            reports> 
            <inherited>trueinherited> 
            <configuration> 
              <links> 
                <link>http://java.sun.com/j2se/1.5.0/docs/api/link> 
              links> 
            configuration> 
          reportSet> 
        reportSets> 
      plugin> 
    plugins> 
  reporting> 

更多项目信息

这块是一些非必要的设置信息，但是作为项目来讲、版权来讲，也会很重要的信息。

1. name:项目除了artifactId外，可以定义多个名称。

2. description：项目描述。

3. url：项目url。

4. inceptionYear：创始年份。

5. Licenses样例如下：

   <licenses>
     <license>
       <name>Apache 2name>
       <url>http://www.apache.org/licenses/LICENSE-2.0.txturl>
       <distribution>repodistribution>
       <comments>A business-friendly OSS licensecomments>
     license>
   licenses>
   

6. organization：组织信息。

7. developers：开发者信息。样例如下：

   <developers>
       <developer>
         <id>hanyahongid>
         <name>hanyahongname>
         <email>[email protected]email>
         <url>http://www.hanyahong.comurl>
         <organization>hanyahongorganization>
         <organizationUrl>http://www.hanyahong.comorganizationUrl>
         <roles>
           <role>architectrole>
           <role>developerrole>
         roles>
         <timezone>-6timezone>
         <properties>
           <picUrl>http://www.hanyahong.com/testpicUrl>
         properties>
       developer>
     developers>
   

8. issueManagement:环境配置信息，样例如下：

   <issueManagement> 
       <system>Bugzillasystem> 
       <url>http://hanyahong.com/url> 
   issueManagement> 
   

9. repositories:仓库配置信息，pom里面的仓库与setting.xml里的仓库功能是一样，主要的区别在于，pom里的仓库是个性化的。比如一家大公司里的setting文件是公用 的，所有项目都用一个setting文件，但各个子项目却会引用不同的第三方库，所以就需要在pom里设置自己需要的仓库地址。 repositories：要成为maven2的repository artifact，必须具有pom文件在$BASE_REPO/groupId/artifactId/version/artifactId-version.pom BASE_REPO可以是本地，也可以是远程的。repository元素就是声明那些去查找的repositories 默认的central Maven repository在 http://repo1.maven.org/maven2/ 。样例如下：

   <repositories> 
       <repository> 
         <releases> 
           <enabled>falseenabled> 
           <updatePolicy>alwaysupdatePolicy> 
           <checksumPolicy>warnchecksumPolicy> 
         releases> 
         <snapshots> 
           <enabled>trueenabled> 
           <updatePolicy>neverupdatePolicy> 
           <checksumPolicy>failchecksumPolicy> 
         snapshots> 
         <id>codehausSnapshotsid> 
         <name>Codehaus Snapshotsname> 
         <url>http://snapshots.maven.codehaus.org/maven2url> 
         <layout>defaultlayout> 
       repository> 
     repositories> 
   

大概的话就是这么多了

注: 此博客参考互联网相关文章整理所得