Maven pom.xml 全配置（一）常用配置

這里貼出一個Maven中出現頻率較高的配置參數注釋，方便理解項目中Maven的配置具體的作用。如果在此博文中沒有找到你想看到的參數，可以移步Maven pom.xml 全配置（二）不常用配置

<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/maven-v4_0_0.xsd "> 

    <!-- 父項目的坐標。如果項目中沒有規定某個元素的值，那么父項目中的對應值即為項目的默認值。
         坐標包括group ID，artifact ID和 version。 --> 
    <parent> 
        <!-- 被繼承的父項目的構件標識符 --> 
        <artifactId>xxx</artifactId>

        <!-- 被繼承的父項目的全球唯一標識符 -->
        <groupId>xxx</groupId> 

        <!-- 被繼承的父項目的版本 --> 
        <version>xxx</version>

        <!-- 父項目的pom.xml文件的相對路徑。相對路徑允許你選擇一個不同的路徑。默認值是../pom.xml。
             Maven首先在構建當前項目的地方尋找父項目的pom，其次在文件系統的這個位置（relativePath位置），
             然后在本地倉庫，最后在遠程倉庫尋找父項目的pom。 --> 
        <relativePath>xxx</relativePath> 
    </parent> 

    <!-- 聲明項目描述符遵循哪一個POM模型版本。模型本身的版本很少改變，雖然如此，但它仍然是必不可少的，
         這是為了當Maven引入了新的特性或者其他模型變更的時候，確保穩定性。 --> 
    <modelVersion> 4.0.0 </modelVersion> 

    <!-- 項目的全球唯一標識符，通常使用全限定的包名區分該項目和其他項目。並且構建時生成的路徑也是由此生成， 
         如com.mycompany.app生成的相對路徑為：/com/mycompany/app --> 
    <groupId>xxx</groupId> 
    <!-- 構件的標識符，它和group ID一起唯一標識一個構件。換句話說，你不能有兩個不同的項目擁有同樣的artifact ID
         和groupID；在某個特定的group ID下，artifact ID也必須是唯一的。構件是項目產生的或使用的一個東西，Maven
         為項目產生的構件包括：JARs，源碼，二進制發布和WARs等。 --> 
    <artifactId>xxx</artifactId> 
   <!-- 項目當前版本，格式為:主版本.次版本.增量版本-限定版本號 --> 
    <version> 1.0-SNAPSHOT </version> 
    
    <!-- 項目產生的構件類型，例如jar、war、ear、pom。插件可以創建他們自己的構件類型，所以前面列的不是全部構件類型 --> 
    <packaging> jar </packaging> 

    <!-- 項目的名稱, Maven產生的文檔用 --> 
    <name> xxx-maven </name> 
    <!-- 項目主頁的URL, Maven產生的文檔用 --> 
    <url> http://maven.apache.org </url> 

    <!-- 項目的詳細描述, Maven 產生的文檔用。 當這個元素能夠用HTML格式描述時（例如，CDATA中的文本會被解析器忽略，
         就可以包含HTML標簽）， 不鼓勵使用純文本描述。如果你需要修改產生的web站點的索引頁面，你應該修改你自己的
         索引頁文件，而不是調整這里的文檔。 --> 
    <description> A maven project to study maven. </description> 

       <!-- 模塊（有時稱作子項目） 被構建成項目的一部分。列出的每個模塊元素是指向該模塊的目錄的
         相對路徑 --> 
    <modules>
        <!--子項目相對路徑-->
        <module></module>
    </modules> 

    <!-- 以值替代名稱，Properties可以在整個POM中使用，也可以作為觸發條件（見settings.xml配置文件里
         activation元素的說明）。格式是<name>value</name>。 --> 
    <properties>
        <name>value</name>
    </properties> 

    <!-- 繼承自該項目的所有子項目的默認依賴信息。這部分的依賴信息不會被立即解析,而是當子項目聲明一個依賴
        （必須描述group ID和artifact ID信息），如果group ID和artifact ID以外的一些信息沒有描述，則通過
            group ID和artifact ID匹配到這里的依賴，並使用這里的依賴信息。 --> 
    <dependencyManagement> 
        <dependencies> 
            <!-- 參見dependencies/dependency元素 --> 
            <dependency> 
            </dependency> 
        </dependencies> 
    </dependencyManagement> 

    <!-- 該元素描述了項目相關的所有依賴。 這些依賴組成了項目構建過程中的一個個環節。它們自動從項目定義的倉庫中下載。
         要獲取更多信息，請看項目依賴機制。 --> 
    <dependencies> 
        <dependency> 
            <!-- 依賴的group ID --> 
            <groupId> org.apache.maven </groupId> 

            <!-- 依賴的artifact ID --> 
            <artifactId> maven-artifact </artifactId> 

            <!-- 依賴的版本號。 在Maven 2里, 也可以配置成版本號的范圍。 --> 
            <version> 3.8.1 </version> 

            <!-- 依賴類型，默認類型是jar。它通常表示依賴的文件的擴展名，但也有例外。一個類型可以被映射成另外一個擴展
                 名或分類器。類型經常和使用的打包方式對應，盡管這也有例外。一些類型的例子：jar，war，ejb-client和test-jar。
                 如果設置extensions為 true，就可以在plugin里定義新的類型。所以前面的類型的例子不完整。 --> 
            <type> jar </type> 

            <!-- 依賴的分類器。分類器可以區分屬於同一個POM，但不同構建方式的構件。分類器名被附加到文件名的版本號后面。例如，
                 如果你想要構建兩個單獨的構件成JAR，一個使用Java 1.4編譯器，另一個使用Java 6編譯器，你就可以使用分類器來生
                 成兩個單獨的JAR構件。 --> 
            <classifier></classifier> 

            <!-- 依賴范圍。在項目發布過程中，幫助決定哪些構件被包括進來。欲知詳情請參考依賴機制。 
                - compile ：默認范圍，用於編譯 
                - provided：類似於編譯，但支持你期待jdk或者容器提供，類似於classpath 
                - runtime: 在執行時需要使用 
                - test: 用於test任務時使用 
                - system: 需要外在提供相應的元素。通過systemPath來取得 
                - systemPath: 僅用於范圍為system。提供相應的路徑 
                - optional: 當項目自身被依賴時，標注依賴是否傳遞。用於連續依賴時使用 --> 
            <scope> test </scope> 

            <!-- 僅供system范圍使用。注意，不鼓勵使用這個元素，並且在新的版本中該元素可能被覆蓋掉。該元素為依賴規定了文件
                 系統上的路徑。需要絕對路徑而不是相對路徑。推薦使用屬性匹配絕對路徑，例如${java.home}。 --> 
            <systemPath></systemPath> 

            <!-- 當計算傳遞依賴時， 從依賴構件列表里，列出被排除的依賴構件集。即告訴maven你只依賴指定的項目，不依賴項目的
                 依賴。此元素主要用於解決版本沖突問題 --> 
            <exclusions> 
                <exclusion> 
                    <artifactId> spring-core </artifactId> 
                    <groupId> org.springframework </groupId> 
                </exclusion> 
            </exclusions> 

            <!-- 可選依賴，如果你在項目B中把C依賴聲明為可選，你就需要在依賴於B的項目（例如項目A）中顯式的引用對C的依賴。
                 可選依賴阻斷依賴的傳遞性。 --> 
            <optional> true </optional> 
        </dependency> 
    </dependencies> 

    <!-- 構建項目需要的信息 --> 
    <build> 
        <!-- 該元素設置了項目源碼目錄，當構建項目的時候，構建系統會編譯目錄里的源碼。該路徑是相對
             於pom.xml的相對路徑。 --> 
        <sourceDirectory></sourceDirectory> 

        <!-- 該元素設置了項目腳本源碼目錄，該目錄和源碼目錄不同：絕大多數情況下，該目錄下的內容會
             被拷貝到輸出目錄(因為腳本是被解釋的，而不是被編譯的)。 --> 
        <scriptSourceDirectory></scriptSourceDirectory> 

        <!-- 該元素設置了項目單元測試使用的源碼目錄，當測試項目的時候，構建系統會編譯目錄里的源碼。
             該路徑是相對於pom.xml的相對路徑。 --> 
        <testSourceDirectory></testSourceDirectory> 

        <!-- 被編譯過的應用程序class文件存放的目錄。 --> 
        <outputDirectory></outputDirectory> 

        <!-- 被編譯過的測試class文件存放的目錄。 --> 
        <testOutputDirectory></testOutputDirectory> 

        <!-- 使用來自該項目的一系列構建擴展 --> 
        <extensions> 
            <!-- 描述使用到的構建擴展。 --> 
            <extension> 
                <!-- 構建擴展的groupId --> 
                <groupId></groupId> 

                <!-- 構建擴展的artifactId --> 
                <artifactId></artifactId> 

                <!-- 構建擴展的版本 --> 
                <version></version> 
            </extension> 
        </extensions> 

        <!-- 當項目沒有規定目標（Maven2 叫做階段）時的默認值 --> 
        <defaultGoal></defaultGoal> 

        <!-- 這個元素描述了項目相關的所有資源路徑列表，例如和項目相關的屬性文件，這些資源被包含在
             最終的打包文件里。 --> 
        <resources> 
            <!-- 這個元素描述了項目相關或測試相關的所有資源路徑 --> 
            <resource> 
                <!-- 描述了資源的目標路徑。該路徑相對target/classes目錄（例如${project.build.outputDirectory}）。
                     舉個例子，如果你想資源在特定的包里(org.apache.maven.messages)，你就必須該元素設置為
                    org/apache/maven/messages。然而，如果你只是想把資源放到源碼目錄結構里，就不需要該配置。 --> 
                <targetPath></targetPath> 

                <!-- 是否使用參數值代替參數名。參數值取自properties元素或者文件里配置的屬性，文件在filters元素
                     里列出。 --> 
                <filtering></filtering>

                <!-- 描述存放資源的目錄，該路徑相對POM路徑 --> 
                <directory></directory>

                <!-- 包含的模式列表，例如**/*.xml. --> 
                <includes>
                    <include></include>
                </includes>

                <!-- 排除的模式列表，例如**/*.xml -->
                <excludes>
                    <exclude></exclude>
                </excludes>
            </resource> 
        </resources> 

        <!-- 這個元素描述了單元測試相關的所有資源路徑，例如和單元測試相關的屬性文件。 --> 
        <testResources> 
            <!-- 這個元素描述了測試相關的所有資源路徑，參見build/resources/resource元素的說明 --> 
            <testResource> 
                <!-- 描述了測試相關的資源的目標路徑。該路徑相對target/classes目錄（例如${project.build.outputDirectory}）。
                     舉個例子，如果你想資源在特定的包里(org.apache.maven.messages)，你就必須該元素設置為
                    org/apache/maven/messages。然而，如果你只是想把資源放到源碼目錄結構里，就不需要該配置。 --> 
                <targetPath></targetPath> 

                <!-- 是否使用參數值代替參數名。參數值取自properties元素或者文件里配置的屬性，文件在filters元素
                     里列出。 --> 
                <filtering></filtering>

                <!-- 描述存放測試相關的資源的目錄，該路徑相對POM路徑 --> 
                <directory></directory>

                <!-- 包含的模式列表，例如**/*.xml. --> 
                <includes>
                    <include></include>
                </includes>

                <!-- 排除的模式列表，例如**/*.xml -->
                <excludes>
                    <exclude></exclude>
                </excludes> 
            </testResource> 
        </testResources> 

        <!-- 構建產生的所有文件存放的目錄 --> 
        <directory></directory> 

        <!-- 產生的構件的文件名，默認值是${artifactId}-${version}。 --> 
        <finalName></finalName> 

        <!-- 當filtering開關打開時，使用到的過濾器屬性文件列表 --> 
        <filters></filters> 

        <!-- 子項目可以引用的默認插件信息。該插件配置項直到被引用時才會被解析或綁定到生命周期。給定插件的任何本
             地配置都會覆蓋這里的配置 --> 
        <pluginManagement> 
            <!-- 使用的插件列表 。 --> 
            <plugins> 
                <!-- plugin元素包含描述插件所需要的信息。 --> 
                <plugin> 
                    <!-- 插件在倉庫里的group ID --> 
                    <groupId></groupId> 

                    <!-- 插件在倉庫里的artifact ID --> 
                    <artifactId></artifactId> 

                    <!-- 被使用的插件的版本（或版本范圍） --> 
                    <version></version> 

                    <!-- 是否從該插件下載Maven擴展（例如打包和類型處理器），由於性能原因，只有在真需要下載時，該
                         元素才被設置成enabled。 --> 
                    <extensions>true/false</extensions> 

                    <!-- 在構建生命周期中執行一組目標的配置。每個目標可能有不同的配置。 --> 
                    <executions> 
                        <!-- execution元素包含了插件執行需要的信息 --> 
                        <execution> 
                            <!-- 執行目標的標識符，用於標識構建過程中的目標，或者匹配繼承過程中需要合並的執行目標 --> 
                            <id></id>

                            <!-- 綁定了目標的構建生命周期階段，如果省略，目標會被綁定到源數據里配置的默認階段 --> 
                            <phase></phase>

                            <!-- 配置的執行目標 --> 
                            <goals></goals> 

                            <!-- 配置是否被傳播到子POM --> 
                            <inherited>true/false</inherited> 

                            <!-- 作為DOM對象的配置 --> 
                            <configuration></configuration>
                        </execution> 
                    </executions> 

                    <!-- 項目引入插件所需要的額外依賴 --> 
                    <dependencies>
                        <!-- 參見dependencies/dependency元素 --> 
                        <dependency> 
                        </dependency> 
                    </dependencies> 

                    <!-- 任何配置是否被傳播到子項目 --> 
                    <inherited>true/false</inherited>

                    <!-- 作為DOM對象的配置 --> 
                    <configuration></configuration>
                </plugin> 
            </plugins> 
        </pluginManagement> 

        <!-- 該項目使用的插件列表 。 --> 
        <plugins> 
            <!-- plugin元素包含描述插件所需要的信息。 --> 
            <plugin> 
                <!-- 插件在倉庫里的group ID --> 
                <groupId></groupId> 

                <!-- 插件在倉庫里的artifact ID --> 
                <artifactId></artifactId> 

                <!-- 被使用的插件的版本（或版本范圍） --> 
                <version></version> 

                <!-- 是否從該插件下載Maven擴展（例如打包和類型處理器），由於性能原因，只有在真需要下載時，該
                     元素才被設置成enabled。 --> 
                <extensions>true/false</extensions> 

                <!-- 在構建生命周期中執行一組目標的配置。每個目標可能有不同的配置。 --> 
                <executions> 
                    <!-- execution元素包含了插件執行需要的信息 --> 
                    <execution> 
                        <!-- 執行目標的標識符，用於標識構建過程中的目標，或者匹配繼承過程中需要合並的執行目標 --> 
                        <id></id>

                        <!-- 綁定了目標的構建生命周期階段，如果省略，目標會被綁定到源數據里配置的默認階段 --> 
                        <phase></phase>

                        <!-- 配置的執行目標 --> 
                        <goals></goals> 

                        <!-- 配置是否被傳播到子POM --> 
                        <inherited>true/false</inherited> 

                        <!-- 作為DOM對象的配置 --> 
                        <configuration></configuration>
                    </execution> 
                </executions> 

                <!-- 項目引入插件所需要的額外依賴 --> 
                <dependencies>
                    <!-- 參見dependencies/dependency元素 --> 
                    <dependency> 
                    </dependency> 
                </dependencies> 

                <!-- 任何配置是否被傳播到子項目 --> 
                <inherited>true/false</inherited> 

                <!-- 作為DOM對象的配置 --> 
                <configuration></configuration> 
            </plugin> 
        </plugins>
    </build> 

    <!-- 發現依賴和擴展的遠程倉庫列表。 --> 
    <repositories> 
        <!-- 包含需要連接到遠程倉庫的信息 --> 
        <repository> 
            <!-- 如何處理遠程倉庫里發布版本的下載 --> 
            <releases> 
                <!-- true或者false表示該倉庫是否為下載某種類型構件（發布版，快照版）開啟。 --> 
                <enabled><enabled> 

                <!-- 該元素指定更新發生的頻率。Maven會比較本地POM和遠程POM的時間戳。這里的選項是：always（一直），
                     daily（默認，每日），interval：X（這里X是以分鍾為單位的時間間隔），或者never（從不）。 --> 
                <updatePolicy></updatePolicy> 

                <!-- 當Maven驗證構件校驗文件失敗時該怎么做：ignore（忽略），fail（失敗），或者warn（警告）。 --> 
                <checksumPolicy></checksumPolicy> 
            </releases> 

            <!-- 如何處理遠程倉庫里快照版本的下載。有了releases和snapshots這兩組配置，POM就可以在每個單獨的倉庫中，
                 為每種類型的構件采取不同的策略。例如，可能有人會決定只為開發目的開啟對快照版本下載的支持。參見repositories/repository/releases元素 --> 
            <snapshots> 
                <enabled><enabled>
                <updatePolicy></updatePolicy>
                <checksumPolicy></checksumPolicy> 
            </snapshots> 

            <!-- 遠程倉庫唯一標識符。可以用來匹配在settings.xml文件里配置的遠程倉庫 --> 
            <id> banseon-repository-proxy </id> 
            <!-- 遠程倉庫名稱 --> 
            <name> banseon-repository-proxy </name> 
            <!-- 遠程倉庫URL，按protocol://hostname/path形式 --> 
            <url> http://192.168.1.169:9999/repository/ </url> 

            <!-- 用於定位和排序構件的倉庫布局類型-可以是default（默認）或者legacy（遺留）。Maven 2為其倉庫提供了一個默認
                 的布局；然而，Maven 1.x有一種不同的布局。我們可以使用該元素指定布局是default（默認）還是legacy（遺留）。 --> 
            <layout> default </layout> 
        </repository> 
    </repositories> 

</project>