Maven - 構建配置檔案

上一頁
下一頁

什麼是構建配置檔案？

構建配置檔案是一組配置值，可用於設定或覆蓋 Maven 構建的預設值。使用構建配置檔案，您可以為不同的環境（例如生產環境與開發環境）自定義構建。

配置檔案在 pom.xml 檔案中使用其 activeProfiles/profiles 元素指定，並透過多種方式觸發。配置檔案在構建時修改 POM，並用於為不同的目標環境提供引數（例如，開發、測試和生產環境中資料庫伺服器的路徑）。

構建配置檔案型別

構建配置檔案主要分為三種類型。

型別 定義位置
每個專案 在專案 POM 檔案 pom.xml 中定義
每個使用者 在 Maven settings.xml 檔案中定義 (%USER_HOME%/.m2/settings.xml)
全域性 在 Maven 全域性 settings.xml 檔案中定義 (%M2_HOME%/conf/settings.xml)

配置檔案啟用

Maven 構建配置檔案可以透過多種方式啟用。

  • 顯式使用命令列輸入。
  • 透過 Maven 設定。
  • 基於環境變數（使用者/系統變數）。
  • 作業系統設定（例如，Windows 系統）。
  • 檔案存在/不存在。

配置檔案啟用示例

讓我們假設您的專案的目錄結構如下：

Maven Build Profile

現在，在 **src/main/resources** 下，有三個特定於環境的檔案：

序號 檔名和描述
1

env.properties

如果沒有提及配置檔案，則使用預設配置。
2

env.test.properties

使用測試配置檔案時的測試配置。
3

env.prod.properties

使用生產配置檔案時的生產配置。

顯式配置檔案啟用

在下面的示例中，我們將 maven-antrun-plugin:run 目標附加到測試階段。這將允許我們為不同的配置檔案回顯文字訊息。我們將使用 pom.xml 定義不同的配置檔案，並使用 maven 命令在命令列中啟用配置檔案。

假設我們在 C:\MVN\project 資料夾中建立了以下 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/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.companyname.projectgroup</groupId>
   <artifactId>project</artifactId>
   <version>1.0</version>
   <profiles>
      <profile>
         <id>test</id>
         <build>
            <plugins>
               <plugin>
                  <groupId>org.apache.maven.plugins</groupId>
                  <artifactId>maven-antrun-plugin</artifactId>
                  <version>1.1</version>
                  <executions>
                     <execution>
                        <phase>test</phase>
                        <goals>
                           <goal>run</goal>
                        </goals>
                        <configuration>
                           <tasks>
                              <echo>Using env.test.properties</echo>
                              <copy file="src/main/resources/env.test.properties"
                                 tofile="${project.build.outputDirectory}/env.properties"/>
                           </tasks>
                        </configuration>
                     </execution>
                  </executions>
               </plugin>
            </plugins>
         </build>
      </profile>
   </profiles>
</project>

現在開啟命令列，轉到包含 pom.xml 的資料夾，並執行以下 **mvn** 命令。使用 -P 選項將配置檔名作為引數傳遞。

C:\MVN\project>mvn test -Ptest

Maven 將開始處理並顯示測試構建配置檔案的結果。

C:\MVN>mvn test -Ptest
[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< com.companyname.projectgroup:project >----------------
[INFO] Building project 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ project ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] Copying 3 resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ project ---
[WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory C:\MVN\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ project ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ project ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-antrun-plugin:1.1:run (default) @ project ---
[INFO] Executing tasks
     [echo] Using env.test.properties
[INFO] Executed tasks
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  2.011 s
[INFO] Finished at: 2021-12-10T20:29:39+05:30
[INFO] ------------------------------------------------------------------------

C:\MVN>

現在，您可以執行以下步驟作為練習：

  • 將另一個 profile 元素新增到 pom.xml 的 profiles 元素中（複製現有的 profile 元素，並將其貼上到 profile 元素結束的位置）。

  • 將此 profile 元素的 id 從 test 更新為 normal。

  • 更新 task 部分以回顯 env.properties 並將 env.properties 複製到目標目錄。

  • 再次重複上述三個步驟，將 id 更新為 prod，並更新 task 部分以使用 env.prod.properties。

  • 就是這樣。現在您已經準備好了三個構建配置檔案（normal/test/prod）。

現在開啟命令列，轉到包含 pom.xml 的資料夾，並執行以下 **mvn** 命令。使用 -P 選項將配置檔名作為引數傳遞。

C:\MVN\project>mvn test -Pnormal

C:\MVN\project>mvn test -Pprod

檢查構建的輸出以檢視差異。

透過 Maven 設定啟用配置檔案

開啟位於 %USER_HOME%/.m2 目錄中的 Maven **settings.xml** 檔案，其中 **%USER_HOME%** 代表使用者主目錄。如果 settings.xml 檔案不存在，則建立一個新的檔案。

使用 activeProfiles 節點將測試配置檔案新增為活動配置檔案，如下例所示。

<settings 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/xsd/settings-1.0.0.xsd">
   <mirrors>
      <mirror>
         <id>maven.dev.snaponglobal.com</id>
         <name>Internal Artifactory Maven repository</name>
         <url>http://repo1.maven.org/maven2/</url>
         <mirrorOf>*</mirrorOf>
      </mirror>
   </mirrors>
   <activeProfiles>
      <activeProfile>test</activeProfile>
   </activeProfiles>
</settings>

現在開啟命令列，轉到包含 pom.xml 的資料夾，並執行以下 **mvn** 命令。不要使用 -P 選項傳遞配置檔名。Maven 將顯示測試配置檔案作為活動配置檔案的結果。

C:\MVN\project>mvn test

透過環境變數啟用配置檔案

現在從 maven settings.xml 中刪除活動配置檔案，並更新 pom.xml 中提到的測試配置檔案。向 profile 元素新增 activation 元素，如下所示。

當系統屬性“env”指定為值“test”時，測試配置檔案將被觸發。建立一個環境變數“env”，並將其值設定為“test”。

<profile>
   <id>test</id>
   <activation>
      <property>
         <name>env</name>
         <value>test</value>
      </property>
   </activation>
</profile>

讓我們開啟命令列，轉到包含 pom.xml 的資料夾，並執行以下 **mvn** 命令。

C:\MVN\project>mvn test

透過作業系統啟用配置檔案

新增 activation 元素以包含作業系統詳細資訊，如下所示。當系統為 Windows XP 時，此測試配置檔案將被觸發。

<profile>
   <id>test</id>
   <activation>
      <os>
         <name>Windows XP</name>
         <family>Windows</family>
         <arch>x86</arch>
         <version>5.1.2600</version>
      </os>
   </activation>
</profile>

現在開啟命令列，轉到包含 pom.xml 的資料夾，並執行以下 **mvn** 命令。不要使用 -P 選項傳遞配置檔名。Maven 將顯示測試配置檔案作為活動配置檔案的結果。

C:\MVN\project>mvn test

透過檔案存在/不存在啟用配置檔案

現在新增 activation 元素以包含作業系統詳細資訊，如下所示。當 **target/generated-sources/axistools/wsdl2java/com/companyname/group** 不存在時，測試配置檔案將被觸發。

<profile>
   <id>test</id>
   <activation>
      <file>
         <missing>target/generated-sources/axistools/wsdl2java/
           com/companyname/group</missing>
      </file>
   </activation>
</profile>

現在開啟命令列，轉到包含 pom.xml 的資料夾，並執行以下 **mvn** 命令。不要使用 -P 選項傳遞配置檔名。Maven 將顯示測試配置檔案作為活動配置檔案的結果。

C:\MVN\project>mvn test
列印頁面
上一頁
下一頁
廣告
© . All rights reserved.