Maven屬性:
Maven中一共有6類屬性:
- 內置屬性:主要有兩個常用內置屬性:
- ${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.outputDirectory}:項目主代碼編譯輸出目錄,默認爲target/classes/
- ${project.testOutputDirectory}:項目測試代碼編譯輸出目錄,默認爲target/testclasses/
- ${project.groupId}:項目的groupId
- ${project.artifactId}:項目的artifactId
- ${project.version}:項目的version,與${version}等價
- ${project.build.finalName}:項目打包輸出文件的名稱,默認爲${project.artifactId}${project.version}.
這些屬性都對應了一個POM元素,它們中的一些屬性的默認值都是在超級POM中定義的。
- 自定義屬性:在POM中<properties>元素下自定義的Maven屬性。例如:
<project>
<properties>
<my.prop>hello</my.prop>
</properties>
</project>
然後在POM中其他地方使用${my.prop}的時候,就會被替換成hello。 - Settings屬性:與POM屬性同理,用戶使用以settings.開頭的屬性引用settings.xml文件中XML元素的值,如${settings.localRepository}指向用戶本地倉庫的地址。
- Java系統屬性:所有Java系統屬性都可以使用Maven屬性引用,例如:${user.home} 指向了用戶目錄。可以通過命令行mvn help:system查看所有的Java系統屬性
- 環境變量屬性:所有環境變量都可以使用以env.開頭的Maven屬性引用。例如:${env.JAVA_HOME} 指代了JAVA_HOME環境變量的值。也可以通過命令行mvn help:system查看所有環境變量。
資源過濾:
我們在實際開發的時候可能會遇到這樣的情況,開發,測試所使用的數據庫是不一樣的,我們當然可以針對不同的情況修改源碼,但是更好的方式是使用profile動態得配置他們,即把不同情況的數據庫地址,密碼等用Maven屬性來表示,默認情況下,Maven屬性只有在POM中才會被解析,而不會在項目的源碼中被解析。資源過濾就是指讓Maven屬性在資源文件(src/main/resources、src/test/resources)中也能被解析。在POM中添加下面的配置便可以開啓資源過濾。
我們針對開發環境在POM文件中定義一個profile
<profiles>
<profile>
<id>dev</id>
<properties>
<db.driver>com.mysql.jdbc.Driver</db.driver>
<db.url>jdbc:mysql://192.168.1.100:3306/test</db.driver>
<db.username>dev</db.username>
<db.password>dev</db.password>
</properties>
</profile>
</profiles>
然後繼續在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>
最後我們只需在命令行激活profile,Maven就能在構件項目的時候使用profile中的屬性值替換數據庫配置文件中的屬於引用。命令行如下:
$ mvn clean install -Pdev
mvn的 -P 參數表示在命令行激活一個profile,這裏激活了id爲dev的profile
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:
背景:項目在不同環境下構建是很不同的,有些環境需要配置插件使用本地文件,有些需要使用特定版本的依賴,所以爲了能讓構建在各個環境下方便得移植,Maven引入了profile,每個Profile可以看作是POM的一部分配置,我們可以根據不同的環境應用不同的Profile,從而達到不同環境使用不同的POM配置的目的。
Profile的種類:profile可以聲明在以下這三個文件中:
- pom.xml:很顯然,這裏聲明的profile只對當前項目有效。
- 用戶settings.xml:.m2/settings.xml中的profile對該用戶的Maven項目有效
- 全局settings.xml:conf/settings.xml,對本機上所有Maven項目有效
我們要注意,pom.xml中的profile能夠隨着pom.xml一起被提交到代碼倉庫中,被Maven安裝到本地倉庫,部署到遠程倉庫。
profile在pom.xml中可聲明的元素在settings.xml中可聲明的元素是不一樣的。
- profile在pom.xml中可聲明的元素:
- <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>:項目構件的默認名稱
與pom.xml中的profile對應的,是其他兩種profile,由於他們不是跟特點的項目綁定在一起的,所以不允許他們修改和添加大部分的POM元素。例如:有一個項目A,我們在自己的settings.xml中定義了一個profile,並且在這個profile中聲明瞭幾個插件和依賴,然後通過激活profile的方式將項目A構建成功了。但是當別人拿到項目A的源碼時,因爲沒有我們settings.xml中profile,這就導致了構建失敗。
- 所以在pom.xml外部的profile中只能聲明以下屬性:
- <repositories></repositories>:倉庫地址
- <pluginRepositories></pluginRepositories>:插件倉庫地址
- <properties></properties>:自定義的屬性
激活Profile:
- 命令行方式激活:命令行參數 -P 加上profile的id來激活,多個id以逗號分隔,如有兩個profile id爲devx和devy的profile:
mvn clean install -Pdevx,devy
- settings文件顯式激活:通過配置settings.xml文件中activeProfile元素,可以使其配置的profile對於所有項目都處於激活狀態:
<activeProfiles>
<activeProfile>devx</activeProfile>
<activeProfile>devy</activeProfile>
</activeProfiles>
- 系統屬性激活:用戶可以配置當某系統屬性存在或其值等於期望值時激活profile,如:
<profiles>
<profile>
<activation>
<property>
<name>actProp</name>
<value>x</value>
</property>
</activation>
</profile>
</profiles>
然後用戶可以在命令行聲明屬性且多個profile可以使用同一個系統屬性來激活:
mvn clean install -DactProp=x
- 操作系統環境激活:如果構建在不同的操作系統存在差異,則用戶可以把這些差異寫進profile裏,然後根據不同的操作系統來激活不同的profile,其中family的值包括windows,UNIX和mac。
<profiles>
<profile>
<activation>
<os>
<name>Windows XP</name>
<family>Windows</family>
<arch>x86</arch>
<version>5.1.2600</version>
</os>
</activation>
</profile>
</profiles>
- 文件存在與否激活: Maven根據文件存在與否來激活profile:
<profiles>
<profile>
<activation>
<file>
<missing>x.properties</missing>
<exists>y.properties</exists>
</file>
</activation>
</profile>
</profiles>
- 用戶也可以在定義profile的時候默認將其激活:
<profile>
<id>dev</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
但是有一點要注意,如果POM中有任意一個profile通過以上幾種方式中的任意一種方式激活了,那麼所有的默認激活配置都會失效。
- 注意:插件maven-help-plugin提供了一個目標幫助用戶瞭解當前激活的profile:
mvn help:active-profiles
- 另外還有一個目標來列出當前所有的profile:
mvn help:all-profiles