maven - pom.xml文件詳解

時間 2019-11-07

標籤 maven pom.xml pom xml 文件詳解欄目 Maven 简体版

原文原文鏈接

settings.xml與pom.xml

settings.xml主要用於配置maven的運行環境等一系列的通用屬性，是全局級別的配置文件html

pom.xml主要用於描述項目的座標，依賴，規則，缺陷管理以及組織，licenses，是項目級別的配置文件java

基礎配置

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">  
  　
　　<!-- 父項目座標 -->
　　<parent>

　　　　<!-- 父項目惟一標識 -->
　　　　<groupId></groupId>

　　　　<!-- 父項目構建標識 -->
　　　　<artifactId></artfactId>

　　　　<!-- 父項目構建版本 -->
　　　　<version></version>

　　</parent>
　　　
    <!-- 模型版本 -->  
    <modelVersion>4.0.0</modelVersion>  
  
    <!-- 
　　　　 公司或者組織的惟一標誌，而且配置時生成的路徑也是由今生成 
　　 　　如com.gc.des，maven會將該項目打成的jar包放本地路徑：/com/gc/des -->  
    <groupId>com.gc.des</groupId>  
  
    <!-- 項目的惟一ID，一個groupId下面可能多個項目，經過artifactId區分 -->  
    <artifactId>app-core</artifactId>  
  
    <!-- 項目版本號 -->  
    <version>1.0.0-SNAPSHOT</version>  
  
    <!-- 打包機制，如pom, jar, maven-plugin, war, rar，默認爲jar -->  
    <packaging>jar</packaging>  
  　　
　　<!-- 項目名稱,用於Maven文檔 -->
　　<name>projectName</name>
　　
　　<!-- 項目主頁URL,用於Maven產生的文檔 -->
　　<url>http://maven.apache.org</url>
　　
　　<!-- 項目詳細描述，用於Maven文檔 -->
　　<description>a maven project</description>
　　
　　<!-- 模塊(子項目),被構建成項目的一部分 -->
　　<modules>

　　　　<!-- 子項目相對路徑 -->
　　　　<module></module>

　　</modules>


    <!-- 定義本項目的依賴關係 -->  
    <dependencies>  
  
        <!-- 每一個dependency都對應一個jar包 -->  
        <dependency>  
  
            <!-- 
　　　　　　　　　通常狀況下，maven是經過groupId、artifactId、version這三個元素值（GAV俗稱座標）來檢索該構件
　　　　　　  　  而後引入你的工程(特殊狀況會使用到classifier再進一步檢索)。-->
　　　　　　　　  若是別人想引用你如今開發的這個項目（前提是已開發完畢併發布到了遠程倉庫），   
            　 就須要在他的pom文件中新建一個dependency節點，將本項目的groupId、artifactId、version寫入，
　　　　　　　　 maven就會把你上傳的jar包下載到他的本地 -->  
            <groupId>com.gc.dsc</groupId>  
            <artifactId>app-core</artifactId>  
            <version>1.0.0-SNAPSHOT</version>  
  
            <!-- 
　　　　　　　　　　maven認爲，程序對外部的依賴會隨着程序的所處階段和應用場景而變化，
　　　　　　　　　　因此maven中的依賴關係有做用域(scope)的限制。 
            　　 scope包含以下的取值：compile（編譯範圍）、provided（已提供範圍）、
　　　　　　　　　 runtime（運行時範圍）、test（測試範圍）、system（系統範圍） -->  
            <scope>test</scope>  
  
            <!-- 設置指依賴是否可選，默認爲false,即子項目默認都繼承。爲true,則子項目必需顯示的引入  -->  
            <optional>false</optional>  
  
            <!-- 
　　　　　　　　　　屏蔽依賴關係。 好比項目中使用的libA依賴某個庫的1.0版，libB依賴某個庫的2.0版，
　　　　　　　　　　如今想統一使用2.0版，就應該屏蔽掉對1.0版的依賴 -->  
            <exclusions>  
                <exclusion>  
                    <groupId>org.slf4j</groupId>  
                    <artifactId>slf4j-api</artifactId>  
                </exclusion>  
            </exclusions>  
  
        </dependency>  
  
    </dependencies>  
  　　
　　<!-- 
　　　　繼承自本項目的子項目默認依賴信息。
　　　　這部分依賴不會當即被解析，而是當子項目聲明一個依賴(包含groupId和artifactId)時，
　　　　經過groupId和artifactId匹配來獲取其餘依賴信息 -->
　　<dependencymanagement>
　　　　<!-- 參考上文dependencies -->
　　　　<dependencies>
　　　　　　<dependency>
　　　　　　　　<!-- groupId和artifactId是必須的 -->
　　　　　　　　<groupId></groupId>
　　　　　　　　<artifactId></artifactId>
　　　　　　</dependency>
　　　　</dependencies>
 　</depencymanagement>

    <!-- 爲pom定義一些常量，在pom中的其它地方能夠直接引用 使用方式 以下 ：${file.encoding} -->  
    <properties>  
        <file.encoding>UTF-8</file.encoding>  
        <java.source.version>1.5</java.source.version>  
        <java.target.version>1.5</java.target.version>  
    </properties>  
  
    ...  
</project>

構建配置

<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.0http://maven.apache.org/xsd/maven-4.0.0.xsd"> 

<build>  

    <!-- 產生的構件的文件名，默認值是${artifactId}-${version}。 -->  
    <finalName>name</finalName>  
  
    <!-- 構建產生的全部文件存放的目錄,默認爲${basedir}/target，即項目根目錄下的target -->  
    <directory>${basedir}/target</directory>  
  
    <!--
　　　　　當項目沒有規定目標（Maven2叫作階段（phase））時的默認值， 
        必須跟命令行上的參數相同例如jar:jar，或者與某個階段（phase）相同例如install、compile等 -->  
    <defaultGoal>install</defaultGoal>  
  
    <!--
　　　　　 當filtering開關打開時，使用到的過濾器屬性文件列表。 -->  
    　　　項目配置信息中諸如${spring.version}之類的佔位符會被屬性文件中的實際值替換掉 -->  
    <filters>  
        <filter>../filter.properties</filter>  
    </filters>  
  
    <!--
　　　　項目相關的全部資源路徑列表，例如和項目相關的配置文件、
　　　　屬性文件，這些資源被包含在最終的打包文件裏。 -->  
    <resources>  
        <resource>  
  
            <!--
　　　　　　　　　描述了資源的目標路徑。該路徑相對target/classes目錄（例如${project.build.outputDirectory}）。 
            　　舉個例子，若是你想資源在特定的包裏(org.apache.maven.messages)，
　　　　　　　　　你就必須該元素設置爲org/apache/maven/messages。  
            　　然而，若是你只是想把資源放到源碼目錄結構裏，就不須要該配置。 -->  
            <targetPath>resources</targetPath>  
  
            <!--
　　　　　　　　　　是否使用參數值代替參數名。
　　　　　　　　　　參數值取自properties元素或者文件裏配置的屬性，文件在filters元素裏列出。 -->  
            <filtering>true</filtering>  
  
            <!--描述存放資源的目錄，該路徑相對POM路徑 -->  
            <directory>src/main/resources</directory>  
  
            <!--包含的模式列表 -->  
            <includes>  
                <include>**/*.properties</include>  
                <include>**/*.xml</include>  
            </includes>  
  
            <!--排除的模式列表 若是<include>與<exclude>劃定的範圍存在衝突，以<exclude>爲準 -->  
            <excludes>  
                <exclude>jdbc.properties</exclude>  
            </excludes>  
  
        </resource>  
    </resources>  
  
    <!--單元測試相關的全部資源路徑，配製方法與resources相似 -->  
    <testResources>  
        <testResource>  
            <targetPath />  
            <filtering />  
            <directory />  
            <includes />  
            <excludes />  
        </testResource>  
    </testResources>  
  
    <!--項目源碼目錄，當構建項目的時候，構建系統會編譯目錄裏的源碼。該路徑是相對於pom.xml的相對路徑。 -->  
    <sourceDirectory>${basedir}\src\main\java</sourceDirectory>  
  
    <!--
　　　　項目腳本源碼目錄，該目錄和源碼目錄不一樣，
　　　　絕大多數狀況下，該目錄下的內容會被拷貝到輸出目錄(由於腳本是被解釋的，而不是被編譯的)。 -->  
    <scriptSourceDirectory>${basedir}\src\main\scripts  
    </scriptSourceDirectory>  
  
    <!--
　　　　項目單元測試使用的源碼目錄，當測試項目的時候，
　　　　構建系統會編譯目錄裏的源碼。該路徑是相對於pom.xml的相對路徑。 -->  
    <testSourceDirectory>${basedir}\src\test\java</testSourceDirectory>  
  
    <!--被編譯過的應用程序class文件存放的目錄。 -->  
    <outputDirectory>${basedir}\target\classes</outputDirectory>  
  
    <!--被編譯過的測試class文件存放的目錄。 -->  
    <testOutputDirectory>${basedir}\target\test-classes  
    </testOutputDirectory>  
  
    <!--
　　　　　　項目的一系列構建擴展,它們是一系列build過程當中要使用的產品，會包含在running bulid‘s classpath裏面。  
    　　　 他們能夠開啓extensions，也能夠經過提供條件來激活plugins。   
   　　　　簡單來說，extensions是在build過程被激活的產品 -->  
    <extensions>  
  
        <!--
　　　　　　例如，一般狀況下，程序開發完成後部署到線上Linux服務器，可能須要經歷打包、   
        　將包文件傳到服務器、SSH連上服務器、敲命令啓動程序等一系列繁瑣的步驟。  
          實際上這些步驟均可以經過Maven的一個插件 wagon-maven-plugin 來自動完成  
          下面的擴展插件wagon-ssh用於經過SSH的方式鏈接遠程服務器， 
          相似的還有支持ftp方式的wagon-ftp插件 -->
        <extension>  
            <groupId>org.apache.maven.wagon</groupId>  
            <artifactId>wagon-ssh</artifactId>  
            <version>2.8</version>  
        </extension>  
  
    </extensions>  
  
    <!--使用的插件列表 。 -->  
    <plugins>  
        <plugin>  
            <groupId></groupId>  
            <artifactId>maven-assembly-plugin</artifactId>  
            <version>2.5.5</version>  
  
            <!--在構建生命週期中執行一組目標的配置。每一個目標可能有不一樣的配置。 -->  
            <executions>  
                <execution>  
  
                    <!--執行目標的標識符，用於標識構建過程當中的目標，或者匹配繼承過程當中須要合併的執行目標 -->  
                    <id>assembly</id>  
  
                    <!--綁定了目標的構建生命週期階段，若是省略，目標會被綁定到源數據裏配置的默認階段 -->  
                    <phase>package</phase>  
  
                    <!--配置的執行目標 -->  
                    <goals>  
                        <goal>single</goal>  
                    </goals>  
  
                    <!--配置是否被傳播到子POM -->  
                    <inherited>false</inherited>  
  
                </execution>  
            </executions>  
  
            <!--做爲DOM對象的配置,配置項因插件而異 -->  
            <configuration>  
                <finalName>${finalName}</finalName>  
                <appendAssemblyId>false</appendAssemblyId>  
                <descriptor>assembly.xml</descriptor>  
            </configuration>  
  
            <!--
　　　　　　　　　　是否從該插件下載Maven擴展（例如打包和類型處理器），   
            　　 因爲性能緣由，只有在真須要下載時，該元素才被設置成true。 -->  
            <extensions>false</extensions>  
  
            <!--項目引入插件所須要的額外依賴 -->  
            <dependencies>  
                <dependency>...</dependency>  
            </dependencies>  
  
            <!--任何配置是否被傳播到子項目 -->  
            <inherited>true</inherited>  
  
        </plugin>  
    </plugins>  
  
    <!--
　　　　 主要定義插件的共同元素、擴展元素集合，相似於dependencyManagement， 
    　　全部繼承於此項目的子項目都能使用。該插件配置項直到被引用時纔會被解析或綁定到生命週期。   
    　　給定插件的任何本地配置都會覆蓋這裏的配置 -->  
    <pluginManagement>  
        <plugins>...</plugins>  
    </pluginManagement>  
  
</build>  

</project>