maven內建屬性(${} properties)
Maven內建了三大特性:屬性、Profile和資源過濾來支援構建的靈活性。
Maven屬性
事實上有六種型別的Maven屬性:
- 內建屬性:主要有兩個常用內建屬性——${basedir}表示專案根目錄,即包含pom.xml檔案的目錄;${version}表示專案版本。
- POM屬性:pom中對應元素的值。例如${project.artifactId}對應了<project><artifactId>元素的值,常用的POM屬性包括: ${project.build.sourceDirectory}:專案的主原始碼目錄,預設為src/main/java/. ${project.build.testSourceDirectory}:專案的測試原始碼目錄,預設為/src/test/java/. ${project.build.directory}:專案構建輸出目錄,預設為target/. ${project.build.outputDirectory}:專案主程式碼編譯輸出目錄,預設為target/classes/. ${project.build.testOutputDirectory}:專案測試程式碼編譯輸出目錄,預設為target/testclasses/. ${project.groupId}:專案的groupId. ${project.artifactId}:專案的artifactId. ${project.version}:專案的version,於${version}等價 ${project.build.finalName}:專案打包輸出檔案的名稱,預設為${project.artifactId}${project.version}.
- 自定義屬性:在pom中<properties>元素下自定義的Maven屬性。例如
-
<project> <properties> <my.prop>hello</my.prop> </properties> </project>
- Settings屬性:與POM屬性同理。如${settings.localRepository}指向使用者本地倉庫的地址。
- Java系統屬性:所有Java系統屬性都可以使用Maven屬性引用,例如${user.home}指向了使用者目錄。可以通過命令列mvn help:system檢視所有的Java系統屬性
- 環境變數屬性:所有環境變數都可以使用以env.開頭的Maven屬性引用。例如${env.JAVA_HOME}指代了JAVA_HOME環境變數的值。也可以通過命令列mvn help:system檢視所有環境變數。
資源過濾
預設情況下,Maven屬性只有在POM中才會被解析。資源過濾就是指讓Maven屬性在資原始檔(src/main/resources、src/test/resources)中也能被解析。
在POM中新增下面的配置便可以開啟資源過濾
<build> <resources> <resource> <directory>${project.basedir}/src/main/resources</directory> <filtering>true</filtering> </resource> </resources> <testResources> <testResource> <directory>${project.basedir}/src/test/resources</directory> <filtering>true</filtering> </testResource> </testResources> </build>
從上面的配置中可以看出,我們其實可以配置多個主資源目錄和多個測試資源目錄。
Maven除了可以對主資源目錄、測試資源目錄過濾外,還能對Web專案的資源目錄(如css、js目錄)進行過濾。這時需要對maven-war-plugin外掛進行配置
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-war-plugin</artifactId>
<version>2.1-beta-1</version>
<configuration>
<webResources>
<resource>
<filtering>true</filtering>
<directory>src/main/webapp</directory>
<includes>
<include>**/*.css</include>
<include>**/*.js</include>
</includes>
</resource>
</webResources>
</configuration>
</plugin>
Maven Profile
每個Profile可以看作是POM的一部分配置,我們可以根據不同的環境應用不同的Profile,從而達到不同環境使用不同的POM配置的目的。
profile可以宣告在以下這三個檔案中:
- pom.xml:很顯然,這裡宣告的profile只對當前專案有效
- 使用者settings.xml:.m2/settings.xml中的profile對該使用者的Maven專案有效
- 全域性settings.xml:conf/settings.xml,對本機上所有Maven專案有效
非常值得注意的一點是,profile在pom.xml中可宣告的元素在settings.xml中可宣告的元素是不一樣的:
profile在pom.xml中可宣告的元素:
<project>
<repositories></repositories>
<pluginRepositories></pluginRepositories>
<distributionManagement></distributionManagement>
<dependencies></dependencies>
<dependencyManagement></dependencyManagement>
<modules></modules>
<properties></properties>
<reporting></reporting>
<build>
<plugins></plugins>
<defaultGoal></defaultGoal>
<resources></resources>
<testResources></testResources>
<finalName></finalName>
</build>
</project>
- profile在settings.xml中可宣告的元素:
<project>
<repositories></repositories>
<pluginRepositories></pluginRepositories>
<properties></properties>
</project>
啟用Profile
1.有多種啟用Profile的方式:命令列方式啟用,如有兩個profile id為devx和devy的profile:
mvn clean install -Pdevx,devy
2.settings檔案顯式啟用
<settings>
...
<activeProfiles>
<activeProfile>devx</activeProfile>
<activeProfile>devy</activeProfile>
</activeProfiles>
...
</settings>
3.系統屬性啟用,使用者可以配置當某系統屬性存在或其值等於期望值時啟用profile,如:
<profiles>
<profile>
<activation>
<property>
<name>actProp</name>
<value>x</value>
</property>
</activation>
</profile>
</profiles>
不要忘了,可以在命令列宣告系統屬性。如:
mvn clean install -DactProp=x
這其實也是一種從命令列啟用profile的方法,而且多個profile完全可以使用同一個系統屬性來啟用。別忘了,系統屬性可以通過mvn help:system來檢視
4.作業系統環境啟用,如
<profiles>
<profile>
<activation>
<os>
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
</activation>
</profile>
</profiles>
這裡的family值包括Window、UNIX和Mac等,而其他幾項對應系統屬性的os.name、os.arch、os.version
5.檔案存在與否啟用,Maven能根據專案中某個檔案存在與否來決定是否啟用profile
<profiles>
<profile>
<activation>
<file>
<missing>x.properties</missing>
<exists>y.properties</exists>
</file>
</activation>
</profile>
</profiles>
Notice:外掛maven-help-plugin提供了一個目標幫助使用者瞭解當前啟用的profile:
mvn help:active-profiles
另外還有一個目標來列出當前所有的profile:
mvn help:all-profiles