Maven 構建配置文件
什麽是構建配置文件?
生成配置文件是一組可以用來設置或覆蓋 Maven 構建配置值的默認值。使用生成配置文件,你可以針對不同的環境,如:生產V/S開發環境自定義構建。
配置文件中指定 pom.xml 文件使用其配置文件/配置文件元素和多種方式來觸發。配置文件修改 POM 後,在編譯的時候是用來給不同的目標環境參數(例如,開發,測試和生產環境的數據庫服務器的路徑)。
生成配置文件的類型
創建配置文件的文件主要有三種類型:
類型 | 定義位置 |
---|---|
Per Project | 在項目中定義的POM文件, pom.xml |
Per User | 定義在 Maven 中的設置 XML 文件(%USER_HOME%/.m2/settings.xml) |
Global | 定義在 Maven 中的全局設置 xml 文件 (%M2_HOME%/conf/settings.xml) |
配置文件激活
Maven 構建配置文件的文件,可以使用以下幾種方式來激活。
-
明確使用命令從控制臺輸入。
-
通過 Maven 設置。
-
基於環境變量(用戶/系統變量)。
-
OS設置(例如,Windows系列)。
-
呈現/丟失的文件。
配置文件的文件激活的例子
我們假設你的項目如下的目錄結構:
現在下src/main/resources 有三個特定的文件:
文件名稱 | 描述 |
---|---|
env.properties | 如果沒有配置文件關聯則使用默認配置 |
env.test.properties | 當測試配置文件用於測試配置 |
env.prod.properties | 生產配置時,prod信息被使用 |
顯式配置文件激活
在下面的例子中,我們會附加上maven-antrun-plugin:run 插件:運行測試階段目標。這將使我們能夠為不同的配置文件調用文本消息。將在 pom.xml 中定義不同的配置文件,並在命令控制臺使用 maven 命令將配置文件啟動。
假設,我們建立如下的 pom.xml 在 C:\MVN\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.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> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>3.8.1</version> <scope>test</scope> </dependency> </dependencies> </project>
env.properties
environment=debug
env.test.properties
environment=test
env.prod.properties
environment=prod
現在,打開命令控制臺,進入到包含 pom.xml 的文件夾並執行以下 mvn 命令。通過配置文件名作為參數可使用 -P 選項。
C:\MVN\project>mvn test -P test
Maven會開始處理並顯示構建配置文件的測試結果。
[INFO] Scanning for projects... [INFO] ------------------------------------------------------------------ [INFO] Building Unnamed - com.companyname.projectgroup:project:jar:1.0 [INFO] task-segment: [test] [INFO] ------------------------------------------------------------------ [INFO] [resources:resources {execution: default-resources}] [WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent! [INFO] Copying 3 resources [INFO] [compiler:compile {execution: default-compile}] [INFO] Nothing to compile - all classes are up to date [INFO] [resources:testResources {execution: default-testResources}] [WARNING] Using platform encoding (Cp1252 actually) to copy filtered resources, i.e. build is platform dependent! [INFO] skip non existing resourceDirectory C:MVNprojectsrc est esources [INFO] [compiler:testCompile {execution: default-testCompile}] [INFO] Nothing to compile - all classes are up to date [INFO] [surefire:test {execution: default-test}] [INFO] Surefire report directory: C:MVNproject argetsurefire-reports ------------------------------------------------------- T E S T S ------------------------------------------------------- There are no tests to run. Results : Tests run: 0, Failures: 0, Errors: 0, Skipped: 0 [INFO] [antrun:run {execution: default}] [INFO] Executing tasks [echo] Using env.test.properties [INFO] Executed tasks [INFO] ------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------ [INFO] Total time: 1 second [INFO] Finished at: Sun Jul 08 14:55:41 IST 2012 [INFO] Final Memory: 8M/64M [INFO] ------------------------------------------------------------------
現在,作為一個練習,可以做以下步驟:
-
在另一個配置文件pom.xml 添加元素(復制現有的配置文件元素 profiles,並將其粘貼輪廓元素結束)。
-
更新在此檔案中元素的 ID 並測試正常。
-
更新任務部分使用 env.properties 並將 env.properties 復制到目標目錄
-
再次重復上述三個步驟,更新 ID 和 env.prod.properties
-
現在準備建立配置文件文件(正常/測試/產品)。
現在,打開命令控制臺,進入到該文件夾包含的 pom.xml 並執行以下 mvn 命令。通過配置文件名作為參數使用 -P 選項。
C:\MVN\project>mvn test -Pnormal
C:\MVN\project>mvn test -Pprod
建立檢查輸出看到它們的差別了
配置文件通過Maven設置激活
打開 Maven 的 settings.xml 文件,可在 %USER_HOME%/.m2 目錄,%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 元素包括 os 細節,如下所示。測試配置文件文件時,將觸發的系統是 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 元件包括 os 的細節,如下所示。test配置文件將因 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 會顯示結果,test 配置文件是一個 活動配置文件。
C:\MVN\project>mvn test
Maven 構建配置文件