Maven之pom.xml文件中的Build配置解析

更新時間：2021年12月30日 15:13:18 作者：劍小純

這篇文章主要介紹了Maven之pom.xml文件中的Build配置解析，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

前言

在日常的開發(fā)中,我們經(jīng)常使用maven來管理和構(gòu)建我們的項目,即使現(xiàn)在使用了各種springboot等方便快捷的框架,jar包的引入也是通過maven來進行的,因此有必要了解pom.xml文件中的沒一項配置.

正文

mave的相關(guān)插件

首先,關(guān)于maven我們要有一定的認識:

maven能幫我們構(gòu)建工程,管理jar包,編譯代碼,還能幫我們自動運行單元測試,生成報表,甚至部署項目.
使用maven構(gòu)建的項目均可以直接使用maven build完成項目的編譯測試打包,無需額外的配置.
maven是通過pom.xml來執(zhí)行任務(wù)的.其中的build標簽描述了如何來編譯打包項目,而具體的編譯和打包工作是通過build中配置的plugin來完成的.

默認情況下,maven會綁定一下幾個插件來完成基本操作

plugin	funcation	life cycle phase
maven-clean-plugin	清理上一次執(zhí)行創(chuàng)建的目標文件	clean
maven-resources-plugin	處理源資源文件和測試資源文件	resources;testResources
maven-compiler-plugin	編譯源文件和測試源文件	compile,testCompile
maven-surefire-plugin	執(zhí)行測試文件	test
maven-jar-plugin	創(chuàng)建jar	jar
maven-install-plugin	安裝jar,將創(chuàng)建生成的jar拷貝到.m2/repository下面	install
maven-deploy-plugin	發(fā)布jar	deploy

在沒有配置的情況下,執(zhí)行maven clean install時,maven會調(diào)用默認的plugin來完成編譯打包操作,具體會執(zhí)行以下plugin:

maven-clean-plugin:2.5:clean (default-clean)
maven-resources-plugin:2.6:resources (default-resources)
maven-compiler-plugin:3.1:compile (default-compile)
maven-resources-plugin:2.6:testResources (default-testResources)
maven-compiler-plugin:3.1:testCompile (default-testCompile)
maven-surefire-plugin:2.12.4:test (default-test)
maven-jar-plugin:2.4:jar (default-jar)
maven-install-plugin:2.4:install (default-install)

如果有需要可以針對各個plugin進行特殊的配置,需要在pom.xml文件中的標簽中顯示指定plugin和對應(yīng)的屬性配置.

在后面會有對每一個plugin配置的實例來供參考

pom.xml中的build標簽

在Maven的pom.xml文件中,Build相關(guān)的配置包含兩個部分:一個是,另一個是,這里只介紹.

1. pom.xml中的兩種build

在Maven的pom.xml文件中,存在如下兩種<build>:

<project>
    <build>...</build>
    
    <profiles>
     <profile>
            <build>...</build>
        </profile>
    </profiles>
</project>

說明: 第一種被稱為Project Build,即是<project>的直接子元素.另一種<build>被稱為Profile Build,即是<profile>的直接子元素.

Profile Build包含了基本的build元素,而Project Build還包含兩個特殊的元素,即各種和.

2. Profile Build和Project Build的共有元素

共用的基本build元素

<build>
    <defaultGoal>install</defaultGoal>
    <directory>${basedir}</directory>
    <finalName>${artifactId}-${version}</finalName>
</build>

defaultGoal: 執(zhí)行構(gòu)建時默認的goal或phase,如jar或者package等
directory: 構(gòu)建的結(jié)果所在的路徑,默認為${basedir}/target目錄
finalName: 構(gòu)建的最終結(jié)果的名字,該名字可能在其他plugin中被改變

資源往往不是代碼,無需編譯,而是一些properties或XML配置文件,構(gòu)建過程往往會將資源文件從源路徑復(fù)制到指定的目標路徑.

給出各個資源在Maven項目中的具體路徑.示例如下:

在這里插入圖片描述

說明:

resource：build過程中涉及的資源文件
targetPath：資源文件的目標路徑
filtering：構(gòu)建過程中是否對資源進行過濾,默認false
directory：資源文件的路徑,默認位于${basedir}/src/main/resources目錄下
includes：一組文件名的匹配模式,被匹配的資源文件將被構(gòu)建過程處理
excludes：一組文件名的匹配模式,被匹配的資源文件將被構(gòu)建過程忽略,同時被includes和excludes匹配的資源文件,將被忽略.
filters：給出對資源文件進行過濾的屬性文件的路徑,默認位于${basedir}/src/main/filters/目錄下.屬性文件中定義若干鍵值對.在構(gòu)建過程中,對于資源文件中出現(xiàn)的變量(鍵),將使用屬性文件中該鍵對應(yīng)的值替換.
testResources：test過程中涉及的文件,默認位于${basedir}/src/test/resources/目錄下,這里的資源文件不會被構(gòu)建到目標構(gòu)建中.

給出構(gòu)建過程中所用到的插件.

在這里插入圖片描述

說明:

extensions：是否加載該插件的擴展,默認false
inherited：該插件的configuration中的配置是否可以被繼承,默認true
configuration：該插件所需要的特殊配置,在父子項目之間可以進行覆蓋或者合并
dependencies：該插件所特有的依賴類庫
executions：該插件的某個goal(一個插件可能包含多個goal)的執(zhí)行方式.一個execution有如下配置:
id：唯一標識
goals：要執(zhí)行插件的goal,可以有多個,如<goal>run</goal>
phase：插件的goal要嵌入到Maven的phase中執(zhí)行,如verify
inherited：該execution是否可以被子項目繼承
configuration：該execution的其他配置參數(shù)

在中,與并列,兩者之間的關(guān)系類似于與之間的關(guān)系.中也配置,其配置參數(shù)與中的完全一致.只是,往往出現(xiàn)在父項目中,其中配置的往往通用于子項目.

子項目只要在中聲明該插件,該插件的具體配置參數(shù)則繼承自父項目中對該插件的配置,從而避免了在子項目中重復(fù)配置.

3. Project Build特有的<…Directory>

往往配置在父項目中,供所有父子項目使用.使用如下:

在這里插入圖片描述

目錄可以使用絕對路徑,如果使用相對路徑,則所有的相對路徑都是在${basedir}目錄下.

4. Project Build特有的

是執(zhí)行構(gòu)建過程中可能用到的其他工具,在執(zhí)行構(gòu)建的過程中被加入到classpath中.也可以通過激活構(gòu)建插件,從而改變構(gòu)建的過程.具體使用如下:

在這里插入圖片描述

Maven默認的輸入和輸出目錄

在構(gòu)建Maven項目的時候,如果沒有進行特殊配置,Maven會按照標準的目錄結(jié)構(gòu)查找和處理各種類型文件.

src/main/java和src/test/java

這兩個目錄中的所有*.java文件會分別在comile和test-comiple階段被編譯,編譯結(jié)果分別被放到了target/classes和target/test-classes目錄中,但是這兩個目錄中的其他文件會被忽略掉.

src/main/resources和src/text/resources

這兩個目錄中的文件也會分別被復(fù)制到target/classes和target/test-classes目錄中.

當項目是web項目時,會在target目錄下生成myProject目錄,myProject是你的項目名

src/main/webapps

這個目錄中的文件會被復(fù)制到target/myProject目錄中.

target/classes

默認會把這個目錄中的所有內(nèi)容復(fù)制到target/myProject/WEB-INF/calssess中

Dependency

默認會將項目的依賴復(fù)制到target/myProject/WEB-INF/lib

Maven常用配置

pom.xml基礎(chǔ)配置

    <properties>  
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
        <spring.framework.version>3.0.5.RELEASE</spring.framework.version>  
        <cxf.version>2.3.2</cxf.version>  
        <tiles.version>2.2.2</tiles.version>  
    </properties>

我需要讓整個項目統(tǒng)一字符集編碼，就需要設(shè)定**<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>**；

如果我需要讓spring統(tǒng)一版本號，可以設(shè)置這么個變量**<spring.framework.version>3.0.5.RELEASE</spring.framework.version>**，

當然，maven不會那么乖乖的自動識別這些配置。

當然，**<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>**默認還是可以識別的！

插件配置

<plugin>  
        <groupId>org.apache.maven.plugins</groupId>  
        <artifactId>maven-resources-plugin</artifactId>  
        <version>2.4.3</version>  
        <configuration>  
            <encoding>${project.build.sourceEncoding}</encoding>  
        </configuration>  
    </plugin>

xml、properties文件都是資源文件，編碼的時候遇到中文總要進行轉(zhuǎn)碼！用什么編碼？UTF-8,那就記得強制**${project.build.sourceEncoding},雖然<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>**默認可以識別，但是我還是覺得不放心。

編譯插件

這個插件就是個默認配置，不過我還是謹慎的配置了jdk編譯版本跟字符集設(shè)置：

<plugin>  
        <groupId>org.apache.maven.plugins</groupId>  
        <artifactId>maven-compiler-plugin</artifactId>  
        <version>2.0.2</version>  
        <configuration>  
            <source>1.6</source>  
            <target>1.6</target>  
            <encoding>${project.build.sourceEncoding}</encoding>  
        </configuration>  
    </plugin>

<source>1.6</source> ：源代碼編譯版本；
<target>1.6</target> ：目標平臺編譯版本；
<encoding>${project.build.sourceEncoding}</encoding>：字符集編碼

如果你用eclipse建立maven項目時，新建的項目往往JDK版本很低——1.5！怎么辦？修改settings.xml文件：

<profile>  
        <id>jdk-1.6</id>  
        <activation>  
            <activeByDefault>true</activeByDefault>  
            <jdk>1.6</jdk>  
        </activation>  
        <properties>  
            <maven.compiler.source>1.6</maven.compiler.source>  
            <maven.compiler.target>1.6</maven.compiler.target>  
            <maven.compiler.compilerVersion>1.6</maven.compiler.compilerVersion>  
        </properties>  
    </profile>

eclipse會很聽話的構(gòu)建一個JDK1.6版本的maven項目！

測試插件

<plugin>  
        <groupId>org.apache.maven.plugins</groupId>  
        <artifactId>maven-surefire-plugin</artifactId>  
        <version>2.7.2</version>  
        <configuration>  
            <parallel>methods</parallel>  
            <threadCount>10</threadCount>  
            <argLine>-Dfile.encoding=UTF-8</argLine>  
            <!-- <skip>true</skip> -->  
            <!-- <testFailureIgnore>true</testFailureIgnore> -->  
        </configuration>  
    </plugin>

<parallel>methods</parallel>：方法級并發(fā)；
<threadCount>10</threadCount>：是線程數(shù)，當前是10；
<argLine>-Dfile.encoding=UTF-8</argLine>：就是參數(shù)命令行，這一行很關(guān)鍵。

測試插件有個小問題，它不依賴項目的字符集設(shè)置，它依賴于操作系統(tǒng)。如果你用命令行操作，看中文提示測試結(jié)果還好。

但在win+eclipse（UTF-8設(shè)置）下，那就是亂碼了；
<skip>true</skip>是忽略測試；
<testFailureIgnore>true</testFailureIgnore>：忽略測試異常；

測試報告插件

要測試，就要有報告，知曉測試覆蓋率，這就需要clover：

<plugin>  
        <groupId>maven</groupId>  
        <artifactId>maven-clover-plugin</artifactId>  
        <version>2.4.2</version>  
        <configuration>  
            <encoding>${project.build.sourceEncoding}</encoding>  
        </configuration>  
    </plugin>

安全起見，我還是要強制字符集編碼設(shè)置：

<encoding>${project.build.sourceEncoding}</encoding>

可以使用 mvn cobertura:cobertura 產(chǎn)生測試覆蓋率報告！

eclipse插件

在eclipse下進行maven項目開發(fā)，還是需要eclipse相應(yīng)的插件：

<plugin>  
        <groupId>org.apache.maven.plugins</groupId>  
        <artifactId>maven-eclipse-plugin</artifactId>  
        <version>2.8</version>  
        <configuration>  
            <wtpmanifest>true</wtpmanifest>  
            <wtpapplicationxml>true</wtpapplicationxml>  
            <wtpversion>2.0</wtpversion>  
            <downloadSources>true</downloadSources>  
            <downloadJavadocs>true</downloadJavadocs>  
        </configuration>  
    </plugin>

<wtpmanifest>true</wtpmanifest>：產(chǎn)生manifest文件
<wtpapplicationxml>true</wtpapplicationxml>：產(chǎn)生web.xml文件
<wtpversion>2.0</wtpversion>：這是eclipse里面的wtp版本
<downloadSources>true</downloadSources>：下載源代碼
<downloadJavadocs>true</downloadJavadocs>：下載源碼文檔

雖然這么配置了，但是由maven項目轉(zhuǎn)為eclipse的wtp類型的項目時，所產(chǎn)生的文件根本沒有實際意義。

web.xml文件的servlet版本很低，也許是我沒有配置。對應(yīng)的xml字符集的頭標識也沒有。

war包插件

既然是web項目，就需要打war包，那就需要這個插件：

<plugin>  
        <groupId>org.apache.maven.plugins</groupId>  
        <artifactId>maven-war-plugin</artifactId>  
        <version>2.1.1</version>  
        <configuration>  
            <encoding>${project.build.sourceEncoding}</encoding>  
            <warName>platform</warName>  
            <webappDirectory>${project.build.directory}/platform</webappDirectory>  
            <warSourceDirectory>WebContent</warSourceDirectory>  
        </configuration>  
    </plugin>

<encoding>${project.build.sourceEncoding}</encoding>強制字符集編碼
<warName>platform</warName>war包名字——platform.war
<webappDirectory>${project.build.directory}/platform</webappDirectory>產(chǎn)生war前，用于存放構(gòu)建war包的目錄——target/platform。
<warSourceDirectory>WebContent</warSourceDirectory>：我把web工程搞成了eclipse下的WTP類型。我不喜歡maven產(chǎn)生的webapp目錄，更喜歡WebContent！

tomcat插件

我習慣于用tomcat作為JSP容器，對jetty多少有點陌生。不但如此，我還通過在Bamboo中配置命令讓這個應(yīng)用可以在tomcat中定時部署：

<plugin>  
        <groupId>org.codehaus.mojo</groupId>  
        <artifactId>tomcat-maven-plugin</artifactId>  
        <configuration>  
            <charset>${project.build.sourceEncoding}</charset>  
            <url>http://localhost:8080/manager</url>  
            <server>tomcat.server</server>  
            <path>/platform</path>  
            <port>8080</port>  
            <warFile>${project.build.directory}/platform.war</warFile>  
            <warSourceDirectory>WebContent</warSourceDirectory>  
            <uriEncoding>${project.build.sourceEncoding}</uriEncoding>  
        </configuration>  
    </plugin>

<charset>${project.build.sourceEncoding}</charset>：字符集強制編碼
<url>http://localhost:8080/manager/text</url>：我這里已經(jīng)使用了Tomcat7，如果是Tomcat6就不需要/text！
<server>tomcat.server</server>這是個用戶名設(shè)置

需要配置maven的settings.xml文件：

<servers>  
        <server>  
            <id>tomcat.server</id>  
            <username>admin</username>  
            <password>123456</password>  
        </server>  
    </servers>

別急，這時候還沒完！

在tomcat的tomcat-users.xml中補充相關(guān)內(nèi)容：

<role rolename="manager-gui"/>  
    <role rolename="magager-script"/>  
    <user username="admin" password="123456" roles="manager-gui,manager-script" />

<port>8080</port>：運行時端口
<path>/platform</path>：是運行時路徑——http://host:port/platform
<warFile>${project.build.directory}/platform.war</warFile>：我們以war包方式發(fā)布，需要指定war包路徑。
<warSourceDirectory>WebContent</warSourceDirectory>：同時要指定war包源碼路徑。這里我使用eclipse的WTP類型工程WebContent目錄。
<uriEncoding>${project.build.sourceEncoding}</uriEncoding>：強制字符集編碼！

插件命令

#Run Tomcat  
    mvn tomcat:run  
    #Stop Tomcat  
    #Deploy Tomcat  
    mvn tomcat:deploy  
    #Undeploy Tomcat  
    mvn tomcat:undeploy  
    #Redeploy Tomcat  
    mvn tomcat:redeploy