maven核心:pom.xml文件詳解

什么是pom?
pom作為項(xiàng)目對象模型。通過xml表示maven項(xiàng)目,使用pom.xml來實(shí)現(xiàn)。主要描述了項(xiàng)目:包括配置文件;開發(fā)者需要遵循的規(guī)則,缺陷管理系統(tǒng),組織和licenses,項(xiàng)目的url,項(xiàng)目的依賴性,以及其他所有的項(xiàng)目相關(guān)因素。

快速察看:

<project>
  <modelVersion>4.0.0</modelVersion>
<!--maven2.0必須是這樣寫,現(xiàn)在是maven2唯一支持的版本-->
  <!-- 基礎(chǔ)設(shè)置 -->
  <groupId>...</groupId>
  <artifactId>...</artifactId>
  <version>...</version>
  <packaging>...</packaging>

  <name>...</name>

  <url>...</url>
  <dependencies>...</dependencies>
  <parent>...</parent>
  <dependencyManagement>...</dependencyManagement>
  <modules>...</modules>
  <properties>...</properties>

  <!--構(gòu)建設(shè)置 -->
  <build>...</build>
  <reporting>...</reporting>

  <!-- 更多項(xiàng)目信息 -->
  <name>...</name>
  <description>...</description>
  <url>...</url>
  <inceptionYear>...</inceptionYear>
  <licenses>...</licenses>
  <organization>...</organization>
  <developers>...</developers>
  <contributors>...</contributors>

  <!-- 環(huán)境設(shè)置-->
  <issueManagement>...</issueManagement>
  <ciManagement>...</ciManagement>
  <mailingLists>...</mailingLists> 
  <scm>...</scm>
  <prerequisites>...</prerequisites>
  <repositories>...</repositories>
  <pluginRepositories>...</pluginRepositories>
  <distributionManagement>...</distributionManagement>
  <profiles>...</profiles>
</project>

基本內(nèi)容:

POM包括了所有的項(xiàng)目信息

groupId:項(xiàng)目或者組織的唯一標(biāo)志,并且配置時生成路徑也是由此生成,如org.myproject.mojo生成的相對路徑為:/org/myproject/mojo

artifactId:項(xiàng)目的通用名稱

version:項(xiàng)目的版本

packaging:打包機(jī)制,如pom,jar,maven-plugin,ejb,war,ear,rar,par

name:用戶描述項(xiàng)目的名稱,無關(guān)緊要的東西,可選

url:應(yīng)該是只是寫明開發(fā)團(tuán)隊(duì)的網(wǎng)站,無關(guān)緊要,可選

classifer:分類

其中g(shù)roupId,artifactId,version,packaging這四項(xiàng)組成了項(xiàng)目的唯一坐標(biāo)。一般情況下,前面三項(xiàng)就可以組成項(xiàng)目的唯一坐標(biāo)了。

POM關(guān)系:主要為依賴,繼承,合成

依賴關(guān)系:

<dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.0</version>
      <type>jar</type>
      <scope>test</scope>
      <optional>true</optional>
    </dependency>

    <dependency>

        <groupId>com.alibaba.china.shared</groupId>

        <artifactId>alibaba.apollo.webx</artifactId>

        <version>2.5.0</version>

        <exclusions>

          <exclusion>

            <artifactId>org.slf4j.slf4j-api</artifactId>

            <groupId>com.alibaba.external</groupId>

          </exclusion>

          ....

        </exclusions>

......

</dependencies>

其中g(shù)roupId, artifactId, version這三個組合標(biāo)示依賴的具體工程,而且 這個依賴工程必需是maven中心包管理范圍內(nèi)的,如果碰上非開源包,maven支持不了這個包,那么則有有三種 方法處理:

  • 1.本地安裝這個插件install plugin

例如:mvn install:intall-file -Dfile=non-maven-proj.jar -DgroupId=som.group -DartifactId=non-maven-proj -Dversion=1

  • 2.創(chuàng)建自己的repositories并且部署這個包,使用類似上面的deploy:deploy-file命令,

  • 3.設(shè)置scope為system,并且指定系統(tǒng)路徑。

dependency里屬性介紹:

type:默認(rèn)為jar類型,常用的類型有:jar,ejb-client,test-jar...,可設(shè)置plugins中的extensions值為true后在增加 新的類型,

scope:是用來指定當(dāng)前包的依賴范圍,mave基礎(chǔ):依賴范圍

optional:設(shè)置指依賴是否可選,默認(rèn)為false,即子項(xiàng)目默認(rèn)都繼承,為true,則子項(xiàng)目必需顯示的引入,與dependencyManagement里定義的依賴類似 。

exclusions:如果X需要A,A包含B依賴,那么X可以聲明不要B依賴,只要在exclusions中聲明exclusion.

exclusion:是將B從依賴樹中刪除,如上配置,alibaba.apollo.webx不想使用com.alibaba.external ,但是alibaba.apollo.webx是集成了com.alibaba.external,r所以就需要排除掉.

如果一個工程是parent或者aggregation(即mutil-module的)的,那么必須在packing賦值為pom,child工程從parent繼承的包括:dependencies,developers,contributors,plugin lists,reports lists,plugin execution with matching ids,plugin configuration

parent的使用方法如下:

<parent> 
    <groupId>org.codehaus.mojo</groupId> 
    <artifactId>my-parent</artifactId> 
    <version>2.0</version> 
    <relativePath>../my-parent</relativePath> 
  </parent>

relativePath是可選的,maven會首先搜索這個地址,在搜索本地遠(yuǎn)程repositories之前.

dependencyManagement:是用于幫助管理chidren的dependencies的。例如如果parent使用dependencyManagement定義了一個dependencyon junit:junit4.0,那么 它的children就可以只引用 groupId和artifactId,而version就可以通過parent來設(shè)置,這樣的好處就是可以集中管理 依賴的詳情

modules:對于多模塊的project,outer-module沒有必需考慮inner-module的dependencies,當(dāng)列出modules的時候,modules的順序是不重要的,因?yàn)閙aven會自動根據(jù)依賴關(guān)系來拓?fù)渑判颍?/p>

modules例子如下 :

<module>my-project</module>

<module>other-project</module>

properties:是為pom定義一些常量,在pom中的其它地方可以直接引用。

定義方式如下:

<properties>

      <file.encoding>UTF-8</file_encoding>

      <java.source.version>1.5</java_source_version>

      <java.target.version>1.5</java_target_version>

</properties>

使用方式 如下 :

${file.encoding}

還可以使用project.xx引用pom里定義的其它屬性:如$(project.version}

build設(shè)置:

defaultGoal:默認(rèn)的目標(biāo),必須跟命令行上的參數(shù)相同,如:jar:jar,或者與時期parse相同,例如install

directory:指定build target目標(biāo)的目錄,默認(rèn)為$(basedir}/target,即項(xiàng)目根目錄下的target

finalName:指定去掉后綴的工程名字,例如:默認(rèn)為{artifactId}-{version}

filters:用于定義指定filter屬性的位置,例如filter元素賦值filters/filter1.properties,那么這個文件里面就可以定義name=value對,這個name=value對的值就可以在工程pom中通過{name}引用,默認(rèn)的filter目錄是{basedir}/src/main/fiters/

resources:描述工程中資源的位置

<resource> 
        <targetPath>META-INF/plexus</targetPath> 
        <filtering>false</filtering> 
        <directory>${basedir}/src/main/plexus</directory> 
        <includes> 
          <include>configuration.xml</include> 
        </includes> 
        <excludes> 
          <exclude>**/*.properties</exclude> 
        </excludes> 
</resource>

targetPath:指定build資源到哪個目錄,默認(rèn)是base directory

filtering:指定是否將filter文件(即上面說的filters里定義的*.property文件)的變量值在這個resource文件有效,例如上面就指定那些變量值在configuration文件無效。

directory:指定屬性文件的目錄,build的過程需要找到它,并且將其放到targetPath下,默認(rèn)的directory是${basedir}/src/main/resources

includes:指定包含文件的patterns,符合樣式并且在directory目錄下的文件將會包含進(jìn)project的資源文件。

excludes:指定不包含在內(nèi)的patterns,如果inclues與excludes有沖突,那么excludes勝利,那些符合沖突的樣式的文件是不會包含進(jìn)來的。

testResources:這個模塊包含測試資源元素,其內(nèi)容定義與resources類似,不同的一點(diǎn)是默認(rèn)的測試資源路徑是${basedir}/src/test/resources,測試資源是不部署的。

plugins配置:

<plugin> 
        <groupId>org.apache.maven.plugins</groupId> 
        <artifactId>maven-jar-plugin</artifactId> 
        <version>2.0</version> 
        <extensions>false</extensions> 
        <inherited>true</inherited> 
        <configuration> 
          <classifier>test</classifier> 
        </configuration> 
        <dependencies>...</dependencies> 
        <executions>...</executions> 
 </plugin>

extensions:true or false, 決定是否要load這個plugin的extensions,默認(rèn)為true.

inherited:是否讓子pom繼承,ture or false 默認(rèn)為true.

configuration:通常用于私有不開源的plugin,不能夠詳細(xì)了解plugin的內(nèi)部工作原理,但使plugin滿足的properties

dependencies:與pom基礎(chǔ)的dependencies的結(jié)構(gòu)和功能都相同,只是plugin的dependencies用于plugin,而pom的denpendencies用于項(xiàng)目本身。在plugin的dependencies主要用于改變plugin原來的dependencies,例如排除一些用不到的dependency或者修改dependency的版本等,詳細(xì)請看pom的denpendencies.

executions:plugin也有很多個目標(biāo),每個目標(biāo)具有不同的配置,executions就是設(shè)定plugin的目標(biāo),

<execution> 
            <id>echodir</id> 
            <goals> 
              <goal>run</goal> 
            </goals> 
            <phase>verify</phase> 
            <inherited>false</inherited> 
            <configuration> 
              <tasks> 
                <echo>Build Dir: ${project.build.directory}</echo> 
              </tasks> 
            </configuration> 
 </execution> 

id:標(biāo)識符

goals:里面列出一系列的goals元素,例如上面的run goal

phase:聲明goals執(zhí)行的時期,例如:verify

inherited:是否傳遞execution到子pom里。

configuration:設(shè)置execution下列表的goals的設(shè)置,而不是plugin所有的goals的設(shè)置

pluginManagement配置:

pluginManagement的作用類似于denpendencyManagement,只是denpendencyManagement是用于管理項(xiàng)目jar包依賴,pluginManagement是用于管理plugin。與pom build里的plugins區(qū)別是,這里的plugin是列出來,然后讓子pom來決定是否引用。

例如:

<pluginManagement> 

      <plugins> 
        <plugin> 
          <groupId>org.apache.maven.plugins</groupId> 
          <artifactId>maven-jar-plugin</artifactId> 
          <version>2.2</version> 
          <executions> 
            <execution> 
              <id>pre-process-classes</id> 
              <phase>compile</phase> 
              <goals> 
                <goal>jar</goal> 
              </goals> 
              <configuration> 
                <classifier>pre-process</classifier> 
              </configuration> 
            </execution> 
          </executions> 
        </plugin> 
      </plugins> 
    </pluginManagement> 
子pom引用方法:

在pom的build里的plugins引用:

    <plugins> 
      <plugin> 
        <groupId>org.apache.maven.plugins</groupId> 
        <artifactId>maven-jar-plugin</artifactId> 
      </plugin> 
    </plugins>
build里的directories:
<sourceDirectory>${basedir}/src/main/java</sourceDirectory> 
    <scriptSourceDirectory>${basedir}/src/main/scripts</scriptSourceDirectory> 
    <testSourceDirectory>${basedir}/src/test/java</testSourceDirectory> 
    <outputDirectory>${basedir}/target/classes</outputDirectory> 
    <testOutputDirectory>${basedir}/target/test-classes</testOutputDirectory>

這幾個元素只在parent build element里面定義,他們設(shè)置多種路徑結(jié)構(gòu),他們并不在profile里,所以不能通過profile來修改

build 里面的Extensions:

它們是一系列build過程中要使用的產(chǎn)品,他們會包含在running bulid‘s classpath里面。他們可以開啟extensions,也可以通過提供條件來激活plugins。簡單來講,extensions是在build過程被激活的產(chǎn)品

    <extensions> 
      <extension> 
        <groupId>org.apache.maven.wagon</groupId> 
        <artifactId>wagon-ftp</artifactId> 
        <version>1.0-alpha-3</version> 
      </extension> 
    </extensions> 

reporting設(shè)置:

reporting包含site生成階段的一些元素,某些maven plugin可以生成reports并且在reporting下配置。例如javadoc,maven site等,在reporting下配置的report plugin的方法與build幾乎一樣,最不同的是build的plugin goals在executions下設(shè)置,而reporting的configures goals在reporttest。

excludeDefaults:是否排除site generator默認(rèn)產(chǎn)生的reports

outputDirectory,默認(rèn)的dir變成:${basedir}/target/site

report sets:設(shè)置execution goals,相當(dāng)于build里面的executions,不同的是不能夠bind a report to another phase,只能夠是site

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

reporting里面的厄reportSets和build里面的executions的作用都是控制pom的不同粒度去控制build的過程,我們不單要配置plugins,還要配置那些plugins單獨(dú)的goals。

更多項(xiàng)目信息:

name:項(xiàng)目除了artifactId外,可以定義多個名稱
description: 項(xiàng)目描述
url: 項(xiàng)目url
inceptionYear:創(chuàng)始年份

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

列出本工程直接的licenses,而不要列出dependencies的licenses

配置組織信息:
  <organization>
    <name>Codehaus Mojo</name>
    <url>http://mojo.codehaus.org</url>
  </organization>

很多工程都受到某些組織運(yùn)行,這里設(shè)置基本信息

配置開發(fā)者信息:

例如:一個開發(fā)者可以有多個roles,properties是

<developers>
    <developer>
      <id>eric</id>
      <name>Eric</name>
      <email>eredmond@codehaus.org</email>
      <url>http://eric.propellors.net</url>
      <organization>Codehaus</organization>
      <organizationUrl>http://mojo.codehaus.org</organizationUrl>
      <roles>
        <role>architect</role>
        <role>developer</role>
      </roles>
      <timezone>-6</timezone>
      <properties>
        <picUrl>http://tinyurl.com/prv4t</picUrl>
      </properties>
    </developer>
  </developers>

環(huán)境設(shè)置:

issueManagement:bug跟蹤管理系統(tǒng),定義defect tracking system缺陷跟蹤系統(tǒng),比如有(bugzilla,testtrack,clearquest等).

例如:

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

倉庫:

Repositories:pom里面的倉庫與setting.xml里的倉庫功能是一樣的。主要的區(qū)別在于,pom里的倉庫是個性化的。比如一家大公司里的setting文件是公用 的,所有項(xiàng)目都用一個setting文件,但各個子項(xiàng)目卻會引用不同的第三方庫,所以就需要在pom里設(shè)置自己需要的倉庫地址。

repositories:要成為maven2的repository artifact,必須具有pom文件在$BASE_REPO/groupId/artifactId/version/artifactId-version.pom
BASE_REPO可以是本地,也可以是遠(yuǎn)程的。repository元素就是聲明那些去查找的repositories
默認(rèn)的central Maven repository在http://repo1.maven.org/maven2/

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

release和snapshots:是artifact的兩種policies,pom可以選擇那種政策有效。
enable:本別指定兩種類型是否可用,true or false
updatePolicy:說明更新發(fā)生的頻率always 或者 never 或者 daily(默認(rèn)的)或者 interval:X(X是分鐘數(shù))

checksumPolicy:當(dāng)Maven的部署文件到倉庫中,它也部署了相應(yīng)的校驗(yàn)和文件。您可以選擇忽略,失敗,或缺少或不正確的校驗(yàn)和警告。

layout:maven1.x與maven2有不同的layout,所以可以聲明為default或者是legacy(遺留方式maven1.x)。

插件倉庫:

pluginRepositories:與Repositories具有類似的結(jié)構(gòu),只是Repositories是dependencies的home,而這個是plugins 的home。

分發(fā)管理:

distributionManagement :管理distribution和supporting files。

downloadUrl:是其他項(xiàng)目為了抓取本項(xiàng)目的pom’s artifact而指定的url,就是說告訴pom upload的地址也就是別人可以下載的地址。
status:這里的狀態(tài)不要受到我們的設(shè)置,maven會自動設(shè)置project的狀態(tài),有效的值:none:沒有聲明狀態(tài),pom默認(rèn)的;converted:本project是管理員從原先的maven版本convert到maven2的;partner:以前叫做synched,意思是與partner repository已經(jīng)進(jìn)行了同步;deployed:至今為止最經(jīng)常的狀態(tài),意思是制品是從maven2 instance部署的,人工在命令行deploy的就會得到這個;verified:本制品已經(jīng)經(jīng)過驗(yàn)證,也就是已經(jīng)定下來了最終版。
repository:聲明deploy過程中current project會如何變成repository,說明部署到repository的信息。

    <repository> 
      <uniqueVersion>false</uniqueVersion> 
      <id>corp1</id> 
      <name>Corporate Repository</name> 
      <url>scp://repo1/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> 

id, name::唯一性的id,和可讀性的name
uniqueVersion:指定是否產(chǎn)生一個唯一性的version number還是使用address里的其中version部分。true or false
url:說明location和transport protocol
layout:default或者legacy

profiles:pom4.0的一個新特性就是具有根據(jù)environment來修改設(shè)置的能力

它包含可選的activation(profile的觸發(fā)器)和一系列的changes。例如test過程可能會指向不同的數(shù)據(jù)庫(相對最終的deployment)或者不同的dependencies或者不同的repositories,并且是根據(jù)不同的JDK來改變的。那么結(jié)構(gòu)如下:

  <profiles> 
    <profile> 
      <id>test</id> 
      <activation>...</activation> 
      <build>...</build> 
      <modules>...</modules> 
      <repositories>...</repositories> 
      <pluginRepositories>...</pluginRepositories> 
      <dependencies>...</dependencies> 
      <reporting>...</reporting> 
      <dependencyManagement>...</dependencyManagement> 
      <distributionManagement>...</distributionManagement> 
    </profile> 
  </profiles> 
Activation:

觸發(fā)這個profile的條件配置如下例:(只需要其中一個成立就可以激活profile,如果第一個條件滿足了,那么后面就不會在進(jìn)行匹配。

    <profile> 
      <id>test</id> 
      <activation> 
        <activeByDefault>false</activeByDefault> 
        <jdk>1.5</jdk> 
        <os> 
          <name>Windows XP</name> 
          <family>Windows</family> 
          <arch>x86</arch> 
          <version>5.1.2600</version> 
        </os> 
        <property> 
          <name>mavenVersion</name> 
          <value>2.0.3</value> 
        </property> 
        <file> 
          <exists>${basedir}/file2.properties</exists> 
          <missing>${basedir}/file1.properties</missing> 
        </file> 
      </activation> 

激活profile的方法有多個:setting文件的activeProfile元素明確指定激活的profile的ID,在命令行上明確激活Profile用-P flag 參數(shù)
查看某個build會激活的profile列表可以用:mvn help:active-profiles

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 清晨,窗外淅淅瀝瀝地下起了秋雨,麻雀在樹上嘰嘰喳喳地聒噪,那歡快的叫聲似乎在嘲笑痛苦地躺在床上的人。瞧,咱們鳥類的...
    夢想2050閱讀 714評論 7 25
  • 夏 泳 四面垂柳八面青, 日落西山云倒影。 男游女泳兒嬉逐, 膚色姿態(tài)各不同。
    步昌閱讀 325評論 0 0
  • 文/半兩銅錢 1 生活中,你認(rèn)為最尷尬的事情是什...
    有料理財(cái)閱讀 774評論 3 3
  • 還有三個月就正式滿27歲了 理論上都該是少女的母親了 沒想到自己還有一顆少女心 喜歡黃致列和徐佳瑩的唱功 但真正被...
    冬眠喵閱讀 182評論 0 0

友情鏈接更多精彩內(nèi)容