Maven插件之portable-config-maven-plugin(不同环境打包)

[html] view plain copy

 

1. <activation>  
2.     <activeByDefault>true</activeByDefault>  
3. </activation>  

[html] view plain copy

 

1. db.url=192.20.1.11  
2. db.username=admin  
3. db.password=confreesecurity  

[html] view plain copy

 

1. <profiles>  
2.     <profile>  
3.         <id>kaifa</id>  
4.         <activation>  
5.             <activeByDefault>true</activeByDefault>  
6.         </activation>  
7.         <build>  
8.             <filters>  
9.                 <filter>${basedir}/filters/kaifa/db.properties</filter>  
10.             </filters>  
11.         </build>  
12.     </profile>  
13.       
14.     <profile>  
15.         <id>shengchan</id>  
16.         <build>  
17.             <filters>  
18.                 <filter>${basedir}/filters/shengchan/db.properties</filter>  
19.             </filters>  
20.         </build>  
21.     </profile>  
22. </profiles>  

添加了<filters><filter>...</filter></filters>部分,使用指定的文件内容替换原文件中的变量;

如此之后,使用Maven命令进行构建即可。

细心的人会发现,以上Profile中的filters部分,除了使用的目录名称不同之外,其他代码全部相同,重复!!!

如果再多几个环境的话,代码冗余可想而知,因此需要优化,其实方法很简单,还是使用变量替换,修改后的pom.xml文件内容如下:

[html] view plain copy

 

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
3.   
4.     <modelVersion>4.0.0</modelVersion>  
5.   
6.     <groupId>com.test</groupId>  
7.     <artifactId>Profile</artifactId>  
8.     <version>0.0.1-SNAPSHOT</version>  
9.       
10.     <build>  
11.         <resources>  
12.             <resource>  
13.                 <directory>${project.basedir}/src/main/resources</directory>  
14.                 <filtering>true</filtering>  
15.             </resource>  
16.         </resources>  
17.         <filters>  
18.             <filter>${basedir}/filters/${filters.env}/db.properties</filter>  
19.         </filters>  
20.     </build>  
21.     <profiles>  
22.         <profile>  
23.             <id>kaifa</id>  
24.             <activation>  
25.                 <activeByDefault>true</activeByDefault>  
26.             </activation>  
27.             <properties>  
28.                 <filters.env>kaifa</filters.env>  
29.             </properties>  
30.         </profile>  
31.   
32.         <profile>  
33.             <id>shengchan</id>  
34.             <properties>  
35.                 <filters.env>shengchan</filters.env>  
36.             </properties>  
37.         </profile>  
38.     </profiles>  
39. </project>  

使用-P参数时,会激活<filters.env>属性,从而使用指定的过滤文件进行变量替换。

其实,以上方式使用久了,还是会有些想法,既然用变量,也就是说,必须使用Maven命令之后,才能部署到Tomcat等服务器中,多次重复的操作,还是有相当多的时间浪费在maven命令上,尤其在改动很少的代码的情况下;

此时又会提出新的需求,能否在不使用maven命令的情况下即可进行日常开发;测试环境(或生产环境)打包时,使用Maven命令和-P参数指定环境进行打包呢?

很幸运,Juven Xu--国内Maven第一人--为我们提供了这样的一个插件portable-config-maven-plugin,使用该插件,可以在不改变原有代码的基础上,进行不同环境的打包。

------以下应该算作最佳实践了

portable-config-maven-plugin插件的原理是内容替换(而不是变量替换);

插件代码地址:https://github.com/juven/portable-config-maven-plugin,目前最新版本为1.1.4;
该插件使用方法如下:

假设src/main/resources/db.properties文件代码如下:

[html] view plain copy

 

1. database.jdbc.username=dev  
2. database.jdbc.password=dev_pwd  

对于测试环境,创建一个属性替换文件src/main/portable/test.xml,代码如下:

[html] view plain copy

 

1. <?xml version="1.0" encoding="utf-8" ?>  
2. <portable-config>  
3.     <config-file path="WEB-INF/classes/db.properties">  
4.         <replace key="database.jdbc.username">test</replace>  
5.         <replace key="database.jdbc.password">test_pwd</replace>  
6.     </config-file>  
7. </portable-config>  

此文件为替换内容描述文件,<config-file>标签的path属性的值是基于war包的

,指需要被内容替换的文件;

配置portable-config-maven-plugin插件(

):

[html] view plain copy

 

1. <plugin>  
2.     <groupId>com.juvenxu.portable-config-maven-plugin</groupId>  
3.     <artifactId>portable-config-maven-plugin</artifactId>  
4.     <version>1.1.4</version>  
5.     <executions>  
6.         <execution>  
7.             <goals>  
8.                 <goal>replace-package</goal>  
9.             </goals>  
10.         </execution>  
11.     </executions>  
12.     <configuration>  
13.         <portableConfig>src/main/portable/test.xml</portableConfig>  
14.     </configuration>  
15. </plugin>  

或在命令行指定替换内容描述文件:mvn clean package -DportableConfig="src/main/portable/test.xml"

打包完成后,db.properties文件内容会被替换。

该插件目前支持的内容替换文件格式有:

.properties

[html] view plain copy

 

1. database.jdbc.username=dev  
2. database.jdbc.password=dev_pwd  
3. 使用  
4. <replace key="database.jdbc.username">test</replace>  
5. <replace key="database.jdbc.password">test_pwd</replace>  
6. 替换为:  
7. database.jdbc.username=test  
8. database.jdbc.password=test_pwd  

.xml(xml元素和属性可以使用xPath进行替换)

[html] view plain copy

 

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <server>  
3.     <port>8080</port>  
4.     <hosts>  
5.         <host id="1">localhost</host>  
6.         <host id="2">localhost</host>  
7.     </hosts>  
8.     <mode value="debug" />  
9. </server>  
10. 使用  
11. <replace xpath="/server/port">80</replace>  
12. <replace xpath="//host/[@id=‘1‘]">192.168.1.1</replace>  
13. <replace xpath="//host/[@id=‘2‘]">192.168.1.2</replace>  
14. <replace xpath="/server/mode/@value">run</replace>  
15. 替换为:  
16. <?xml version="1.0" encoding="UTF-8"?>  
17. <server>  
18.     <port>80</port>  
19.     <hosts>  
20.         <host id="1">192.168.1.1</host>  
21.         <host id="2">192.168.1.2</host>  
22.     </hosts>  
23.     <mode value="run"/>  
24. </server>  

.sh

[html] view plain copy

 

1. 无引号、单引号、双引号、输出的shell变量可被替换  
2. BIN_HOME=/tmp/bin  
3. OUT_HOME="/tmp/out"  
4. LOG_HOME=‘/tmp/log‘  
5. export APP_HOME="/tmp/app"  
6. 使用  
7. <replace key="BIN_HOME">/home/juven/bin</replace>  
8. <replace key="OUT_HOME">/home/juven/out</replace>  
9. <replace key="LOG_HOME">/home/juven/log</replace>  
10. <replace key="APP_HOME">/home/juven/app</replace>  
11. 替换为:  
12. BIN_HOME=/home/juven/bin  
13. OUT_HOME="/home/juven/out"  
14. LOG_HOME=‘/home/juven/log‘  
15. export APP_HOME="/home/juven/app"  

类似.properties格式

[html] view plain copy

 

1. 假如有个key=value类型的配置文件,但扩展名不是.properties,可按照以下方式指定:  
2. <?xml version="1.0" encoding="utf-8" ?>  
3. <portable-config>  
4.     <config-file path="db.ini" type=".properties">  
5.         <replace key="mysql.host">192.168.1.100</replace>  
6.     </config-file>  
7. </portable-config>  
8. 使用type属性强制指定文件类型。  

对该插件的介绍到此为止。

回头看看,发现内容和标题不符,说是介绍portable-config-maven-plugin插件,

却花了大篇幅的内容介绍了Maven其他的标签使用,不过以上内容总有相同之处--针对不同环境打包的一些解决方法。