程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> 簡述maven中的profiles

簡述maven中的profiles

編輯：關於JAVA

Profiles是maven的一個很關鍵的術語：profile是用來定義一些在build lifecycle中使用的environmental variations，profile可以設置成在不同的環境下激活不同的profile（例如：不同的OS激活不同的profile，不同的JVM激活不同的profile，不同的dabase激活不同的profile等等）。

定義Profiles

你可以把profiles定義在4個地方：

%M2_HOME%/conf/settings.xml，這是針對該部電腦的所有user的profiles，是global profiles，它會影響所有的maven project build

<your -home-directory>/.m2/settings.xml，這是針對per user的profiles，是user級的profiles，它會影響當前user的所有maven project build

定義在pom.xml文件裡面，這是僅針對該project的profiles，是project級的profiles

profiles.xml，它和pom.xml在同一個目錄下，也是project級的profiles，使用profiles.xml的目的是希望把profiles的設置從pom.xml裡抽離出來設置。

定義在這4個地方的profiles中，涉及范圍越窄的profiles會覆蓋范圍越寬的profiles。即：定義在pom.xml裡profiles會覆蓋profiles.xml的，profiles.xml的會覆蓋<your -home-directory>/.m2/settings.xml的，<your -home-directory>/.m2/settings.xml的會覆蓋%M2_HOME%/conf/settings.xml的。

不過請注意：設置在pom.xml裡的profiles是最最推薦的，因為pom.xml會被deploy到repository裡，所以pom.xml裡的profiles才會available for subsequent builds originating from the repository or as transitive dependencies。而settings.xml和profiles.xml裡定義的profiles不會被deploy到repository，則有諸多限制，因此，只有下面幾個profiles能夠在settings.xml和profiles.xml裡定義：

repositories

pluginRepositories

properties

其他類型的profiles必須在pom.xml裡定義（上面3個profiles也可以在pom.xml裡定義）。

Pom.xml能夠定義的profiles包括：

<repositories> <pluginRepositories> <dependencies> <plugins> <properties> (not actually available in the main POM, but used behind the scenes) <modules> <reporting> <dependencyManagement> <distributionManagement> a subset of the <build> element, which consists of: <defaultGoal> <resources> <testResources> <finalName>

激活Profiles

激活profiles有下列幾種方式：

Explicitly Through Maven settings Based on environment variables OS settings Present or missing files

1）通過mvn命令的-P參數來顯示激活profiles，該參數值是profile id list（之間用逗號連接）。如：

mvn groupId:artifactId:goal -P profileId-1,profileId-2

2）通過在settings.xml裡設置<activeProfiles> element來激活（當然<profiles>也必須在settings.xml裡定義）

<settings> ... 　　　　　 <profiles> <profile> 　　 <id>profile1</id> 　 ... </profile> 　　　　　 </profiles> <activeProfiles> 　　 <activeProfile>profile-1</activeProfile> </activeProfiles> ... </settings>

列在<activeProfiles>裡的profiles list會在每一個project執行時被激活

3）Profiles還可以基於detect到的build environment 的state來自動激活，而不需要象上面2種方式顯式激活。這只需要在profile定義時使用<activation> element。如：

<profiles> <profile> 　　 <activation> 　　　 <jdk>1.4</jdk> 　　 </activation> 　　 ... </profile> </profiles>

上面的代碼表示：如果JDK version start with 1.4 （eg. "1.4.0_08", "1.4.2_07", "1.4"），該profile會被激活

<profiles> <profile> 　　 <activation> 　　　 <property> 　　　　 <name>debug</name> 　　　 </property> 　　 </activation> 　　 ... </profile> </profiles>

上面的代碼表示：如果存在system propertie “debug”，該profile會被激活。為了激活它，輸入的命令類似於：

mvn groupId:artifactId:goal –Ddebug

<profiles> <profile> 　　 <activation> 　　　 <property> 　　　　 <name>environment</name> 　　　　 <value>test</value> 　　　 </property> 　　 </activation> 　　 ... </profile> </profiles>

上面的代碼表示：如果存在system propertie “environment”的值為test，該profile會被激活。為了激活它，輸入的命令類似於：

mvn groupId:artifactId:goal -Denvironment=test

4）Profiles還可以基於OS setting來自動激活

<profiles> <profile> 　　 <activation> 　　　 <os> 　　　 <name>Windows XP</name> 　　　 <family>Windows</family> 　　　 <arch>x86</arch> 　　　 <version>5.1.2600</version> 　　 </os> 　　　　 </activation> ... </profile> </profiles>

上面的代碼表示：如果OS為windows xp，該profile會被激活

5）根據某個file不存在而激活profile。例如下面定義的profile是在target/generated-sources/axistools/wsdl2java/org/apache/maven不存在時激活

<profiles> <profile> 　　 <activation> 　　　 <file> 　　　　 <missing>target/generated-sources/axistools/wsdl2java/org/apache/maven</missing> 　　　 </file> 　　 </activation> 　　 ... </profile> </profiles>

使用Profiles時要注意的2個問題

第一、external properties

不是定義在pom.xml裡的properties都稱為external properties。舉例說明最明了：

pom.xml：

<project> ... <build> 　　 <plugins> 　　　 <plugin> 　　　　 <groupId>org.myco.plugins</groupId> 　　　　 <artifactId>spiffy-integrationTest-plugin</artifactId> 　　　　 <version>1.0</version> 　　　　 <configuration> 　　　　　 <appserverHome>${appserver.home}</appserverHome> 　　　　 </configuration> 　　　 </plugin> 　　　 ... 　　 </plugins> </build> ... </project> ~/.m2/settings.xml <settings> ... <profiles> 　　 <profile> 　　　 <id>appserverConfig</id> 　　　 <properties> 　　　　 <appserver.home>/path/to/appserver</appserver.home> 　　　 </properties> 　　 </profile> </profiles> <activeProfiles> 　　 <activeProfile>appserverConfig</activeProfile> </activeProfiles> ... </settings>

當你執行該pom時，運行正常。但如果another user執行時，則運行失敗，因為無法解析${appserver.home}（這是由於該properties是定義在user級別的settings.xml）。

解決方法就是把該profile放到pom.xml裡定義，但這樣做的缺點是所有使用該profile的pom.xml每個都要定義一次該profile。

最好的解決方法是：Since Maven provides good support for project inheritance, it's possible to stick this sort of configuration in the pluginManagement section of a team-level POM or similar, and simply inherit the paths

第二、pom.xml裡定義的profiles不符合激活條件

依然是舉個例子：

pom.xml：

<project> ... <profiles> 　　 <profile> 　　　 <id>appserverConfig-dev</id> 　　　 <activation> 　　　　 <property> 　　　　　 <name>env</name> 　　　　　 <value>dev</value> 　　　　 </property> 　　　 </activation> 　　　 <properties> 　　　　 <appserver.home>/path/to/dev/appserver</appserver.home> 　　　 </properties> 　　 </profile> 　　 <profile> 　　　 <id>appserverConfig-dev-2</id> 　　　 <activation> 　　　　 <property> 　　　　　 <name>env</name> 　　　　　 <value>dev-2</value> 　　　　 </property> 　　　 </activation> 　　　 <properties> 　　　　 <appserver.home>/path/to/dev/appserver2</appserver.home> 　　　 </properties> 　　 </profile> </profiles> <build> 　　 <plugins> 　　　 <plugin> 　　　　 <groupId>org.myco.plugins</groupId> 　　　　 <artifactId>spiffy-integrationTest-plugin</artifactId> 　　　　 <version>1.0</version> 　　　　 <configuration> 　　　　　 <appserverHome>${appserver.home}</appserverHome> 　　　　 </configuration> 　　　 </plugin> 　　　 ... 　　 </plugins> </build> ... </project>