基本概念说明(resources、filter和profile)

1.profiles定义了各个环境的变量id
2.filters中定义了变量配置文件的地址,其中地址中的环境变量就是上面profile中定义的值
3.resources中是定义哪些目录下的文件会被配置文件中定义的变量替换,一般我们会把项目的配置文件放在src/main/resources下,像db,bean等,里面用到的变量在打包时就会根据filter中的变量配置替换成固定值

在我们平常的java开发中,会经常使用到很多配制文件(xxx.properties,xxx.xml),而当我们在本地开发(dev),测试环境测试(test),线上生产使用(product)时,需要不停的去修改这些配制文件,次数一多,相当麻烦。现在,利用maven的filter和profile功能,我们可实现在编译阶段简单的指定一个参数就能切换配制,提高效率,还不容易出错,详解如下。

一,原理:

  1. 利用filter实现对资源文件(resouces)过滤

maven filter可利用指定的xxx.properties中对应的key=value对资源文件中的${key}进行替换,最终把你的资源文件中的username=${key}替换成username=value

  1. 利用profile来切换环境

maven profile可使用操作系统信息,jdk信息,文件是否存在,属性值等作为依据,来激活相应的profile,也可在编译阶段,通过mvn命令加参数 -PprofileId 来手工激活使用对应的profile
结合filter和profile,我们就可以方便的在不同环境下使用不同的配制

二,配置:

在工程根目录下添加3个配制文件:

  1. config-dev.properties -- 开发时用 <br /> config-test.properties -- 测试时用 <br /> config-product.properties -- 生产时用

工程根目录下的pom文件中添加下面的设置:

  1. <build>
  2. <resources>
  3. <!-- 先指定 src/main/resources下所有文件及文件夹为资源文件 -->
  4. <resource>
  5. <directory>src/main/resources</directory>
  6. <includes>
  7. <include>**/*</include>
  8. </includes>
  9. </resource>
  10. <!-- 设置对auto-config.properties,jdbc.properties进行过虑,即这些文件中的${key}会被替换掉为真正的值 -->
  11. <resource>
  12. <directory>src/main/resources</directory>
  13. <includes>
  14. <include>auto-config.properties</include>
  15. <include>jdbc.properties</include>
  16. </includes>
  17. <filtering>true</filtering>
  18. </resource>
  19. </resources>
  20. </build>
  21. <profiles>
  22. <profile>
  23. <id>dev</id>
  24. <!-- 默认激活开发配制,使用config-dev.properties来替换设置过虑的资源文件中的${key} -->
  25. <activation>
  26. <activeByDefault>true</activeByDefault>
  27. </activation>
  28. <build>
  29. <filters>
  30. <filter>config-dev.properties</filter>
  31. </filters>
  32. </build>
  33. </profile>
  34. <profile>
  35. <id>test</id>
  36. <build>
  37. <filters>
  38. <filter>config-dev.properties</filter>
  39. </filters>
  40. </build>
  41. </profile>
  42. <profile>
  43. <id>product</id>
  44. <build>
  45. <filters>
  46. <filter>config-product.properties</filter>
  47. </filters>
  48. </build>
  49. </profile>
  50. </profiles>

三,使用:

开发环境:

filter是在maven的compile阶段执行过虑替换的,所以只要触发了编译动作即可,如果像以前一样正常使用发现没有替换,则手工clean一下工程。
如果上面还不行,那么就使用maven插件或者手工控制台下打maven编译命令吧
因为pom.xml中设置了dev为默认激活的,所以默认会把config-dev拿来进行替换${key}

测试环境

手工编译,打包,激活id=”test”的profile :
maven clean install -Ptest

生产环境

手工编译,激活id=”product”的profile 打包:maven clean install -Pproduct