原文地址:http://www.cnblogs.com/qyf404/p/4833261.html?utm_source=tuicool&utm_medium=referral
介紹前我們先看一個(gè)問(wèn)題,比如我們有一個(gè)maven項(xiàng)目結(jié)構(gòu)如下:
一般我們都把一些配置文件放到像src/main/resources/jdbc.properties這樣的文件中。但是文件里我們更多的放的還是變量,內(nèi)容如下:
jdbc.driverClassName=${jdbc.driverClassName}jdbc.url=${jdbc.url}jdbc.username=${jdbc.username}jdbc.passWord=${jdbc.password}jdbc.validationQuery=${jdbc.validationQuery}具體的值我們會(huì)放到pom.xml中,用<properties>來(lái)配置,如下所示代碼:
<?xml version="1.0" encoding="UTF-8"?><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.qyf404</groupId> <artifactId>learn-maven</artifactId> <version>1.0-SNAPSHOT</version> <profiles></profiles> <properties> <jdbc.driverClassName>com.MySQL.jdbc.Driver</jdbc.driverClassName> <jdbc.url>jdbc:mysql://localhost/stock?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=utf-8&autoReconnect=true</jdbc.url> <jdbc.username>root</jdbc.username> <jdbc.password></jdbc.password> <jdbc.validationQuery>SELECT 1 + 1</jdbc.validationQuery> </properties> <build> <resources> <resource> <filtering>true</filtering> <directory>${project.basedir}/src/main/resources</directory> <includes> <include>*.properties</include> </includes> </resource> </resources> </build></project>按照上面的方式配置。我們執(zhí)行mvn package后,在target/classes/jdbc.properties里可以看到配置文件被成功替換。
由于某些原因(比如配置文件項(xiàng)比較多,為了讓pom.xml更精簡(jiǎn)),我們希望把這些配置項(xiàng)提取到一個(gè)properties文件中進(jìn)行配置。這時(shí)候就需要用到properties-maven-plugin了。properties-maven-plugin可以在執(zhí)行maven命令時(shí),讀取指定properties文件中的配置項(xiàng),來(lái)實(shí)現(xiàn)和pom.xml中配置<properties>一樣的效果。
2.properties-maven-plugin怎么用?
還拿上面的例子說(shuō),比如我們把pom.xml中的配置項(xiàng)放到一個(gè)全局的my.properties中。

profiles/dev/my.properties文件內(nèi)容如下:
jdbc.driverClassName=com.mysql.jdbc.Driverjdbc.url=jdbc:mysql://localhost/stock?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=utf-8&autoReconnect=truejdbc.username=rootjdbc.password=jdbc.validationQuery=SELECT 1 + 1pom.xml我們把插件加進(jìn)去,并把之前里面的配置項(xiàng)注釋掉.
<?xml version="1.0" encoding="UTF-8"?><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.qyf404</groupId><artifactId>learn-maven</artifactId><version>1.0-SNAPSHOT</version><!--<properties>--> <!--<jdbc.driverClassName>com.mysql.jdbc.Driver</jdbc.driverClassName>--> <!--<jdbc.url>jdbc:mysql://localhost/stock?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=utf-8&autoReconnect=true</jdbc.url>--> <!--<jdbc.username>root</jdbc.username>--> <!--<jdbc.password></jdbc.password>--> <!--<jdbc.validationQuery>SELECT 1 + 1</jdbc.validationQuery>--><!--</properties>--><build> <resources> <resource> <filtering>true</filtering> <directory>${project.basedir}/src/main/resources</directory> <includes> <include>*.properties</include> </includes> </resource> </resources> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>properties-maven-plugin</artifactId> <version>1.0-alpha-2</version> <executions> <execution> <id>default-cli</id> <phase>initialize</phase> <goals> <goal>read-project-properties</goal> </goals> <configuration> <files> <file>${user.dir}/profiles/dev/my.properties</file> </files> </configuration> </execution> </executions> </plugin> </plugins></build></project>我們執(zhí)行mvn package后,在target/classes/jdbc.properties里可以看到配置文件被成功替換。
3.進(jìn)階
把pom.xml里的配置項(xiàng)提取到properties文件中,這是properties-maven-plugin干的事情。但是我們用properties-maven-plugin要達(dá)到更好的效果。
想一個(gè)場(chǎng)景:
我們的項(xiàng)目有開(kāi)發(fā)環(huán)境的配置,測(cè)試環(huán)境的配置;而且開(kāi)發(fā)環(huán)境是mysql數(shù)據(jù)庫(kù),測(cè)試環(huán)境是hsqldb數(shù)據(jù)庫(kù);最后還要在一個(gè)文件中統(tǒng)一打印出配置項(xiàng)內(nèi)容。我們可以通過(guò)maven的profile來(lái)配上properties-maven-plugin實(shí)現(xiàn)針對(duì)不同環(huán)境的快速打包。
我們把項(xiàng)目做個(gè)改造,結(jié)構(gòu)如下:

profiles/dev/my.properties內(nèi)容如下:
jdbc.driverClassName=com.mysql.jdbc.Driverjdbc.url=jdbc:mysql://localhost/stock?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=utf-8&autoReconnect=truejdbc.username=rootjdbc.password=jdbc.validationQuery=SELECT 1 + 1profiles/test/my.properties內(nèi)容如下:
jdbc.driverClassName=org.hsqldb.jdbc.JDBCDriverjdbc.url=jdbc:hsqldb:hsql://localhost/stocktestjdbc.username=rootjdbc.password=jdbc.validationQuery=SELECT 1 + 1pom.xml 內(nèi)容如下:
<?xml version="1.0" encoding="UTF-8"?><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.qyf404</groupId><artifactId>learn-maven</artifactId><version>1.0-SNAPSHOT</version><!--<properties>--><!--<jdbc.driverClassName>com.mysql.jdbc.Driver</jdbc.driverClassName>--><!--<jdbc.url>jdbc:mysql://localhost/stock?createDatabaseIfNotExist=true&useUnicode=true&characterEncoding=utf-8&autoReconnect=true</jdbc.url>--><!--<jdbc.username>root</jdbc.username>--><!--<jdbc.password></jdbc.password>--><!--<jdbc.validationQuery>SELECT 1 + 1</jdbc.validationQuery>--><!--</properties>--><build> <resources> <resource> <filtering>true</filtering> <directory>${project.basedir}/src/main/resources</directory> <includes> <include>*.properties</include> </includes> </resource> </resources> <plugins> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>properties-maven-plugin</artifactId> <version>1.0-alpha-2</version> <executions> <execution> <id>default-cli</id> <phase>initialize</phase> <goals> <goal>read-project-properties</goal> <goal>write-project-properties</goal> </goals> <configuration> <files> <!--<file>${user.dir}/profiles/dev/my.properties</file>--> <file>${user.dir}/profiles/${profile.id}/my.properties</file> </files> <!--輸出全部配置項(xiàng)到指定文件--> <outputFile>${build.directory}/profile.properties</outputFile> </configuration> </execution> </executions> </plugin> </plugins></build><profiles> <profile> <id>dev</id> <activation> <activeByDefault>true</activeByDefault> </activation> <properties> <profile.id>dev</profile.id> </properties> <dependencies> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.31</version> <scope>runtime</scope> </dependency> </dependencies> </profile> <profile> <id>test</id> <properties> <profile.id>test</profile.id> </properties> <dependencies> <dependency> <groupId>org.hsqldb</groupId> <artifactId>hsqldb</artifactId> <version>2.2.6</version> <scope>runtime</scope> </dependency> </dependencies> </profile></profiles></project>我們現(xiàn)在只需要執(zhí)行命令mvn package -Pdev或者mvn package就可以打一個(gè)開(kāi)發(fā)的包。
執(zhí)行命令mvn package -Ptest就可以打一個(gè)測(cè)試用的包。
而且在target/profile.properties里查看項(xiàng)目打包的全部maven用到的配置項(xiàng)。內(nèi)容如下:
#Properties#Wed Sep 23 19:06:47 CST 2015jdbc.url=jdbc/:mysql/://localhost/stock?createDatabaseIfNotExist/=true&useUnicode/=true&characterEncoding/=utf-8&autoReconnect/=truejdbc.username=rootjdbc.validationQuery=SELECT 1 + 1jdbc.password=profile.id=devjdbc.driverClassName=com.mysql.jdbc.Driver示例代碼github地址: https://github.com/qyf404/learn-maven/tree/properties-maven-plugin
更多關(guān)于properties-maven-plugin請(qǐng)參閱這里:http://www.mojohaus.org/properties-maven-plugin/index.html
作者:辵鵵
新聞熱點(diǎn)
疑難解答
圖片精選
網(wǎng)友關(guān)注