maven的profile和filter插件管理配置项

摘要: 针对不同的环境使用不同的配置

一、概述

项目开发中，工程需要经历开发人员本地测试环境(dev),进入测试阶段后有测试环境(test),测试无误后需要将程序发布到生产环境(production)下，而对于这三个不同的项目环境，应用程序要在该环境下运行，必须有不同的配置项，如开发和生产环境使用不同的数据库地址，不同的线程池参数，因此需要对不同的项目环境进行不同的配置，为了简化和规范这些参数配置，需要对其进行统一规范管理。

二、配置管理项

2.1 三种环境

开发环境：该环境下的配置项只影响开发人员本地代码配置，在项目初期代码本地编写调试时启用。

测试环境：该环境配置影响整个测试环境。

生产环境：程序最终发布后所需要的参数配置，该环境下的配置项修改将直接影响最终用户的使用和应用程序的运行。

系统的配置项统一放在src/main/filters/目录下，三个环境的配置文件分别为

filter-dev-env.properties

filter-test-env.properties

filter-production-env.properties

配置内容如下：

##################### DB config start #####################

user.jdbc.url=jdbc:mysql://172.0.0.1:3306/user?autoReconnect=true&rewriteBatchedStatements=true&socketTimeout=30000&connectTimeout=3000

user.jdbc.username=user

user.jdbc.password=user

2.2 定义profile

项目工程统一使用maven的profile插件定义不同的项目构建环境(dev, test, production),通过filter插件为不同环境下的配置项注入对应的参数值来实现动态配置目标。eg:

<profiles>

<!-- 开发集成环境-->

<profile>

<id>dev</id>

<properties>

<env>dev</env>

</properties>

<activation>

<activeByDefault>true</activeByDefault><!--默认启用的是dev环境配置-->

</activation>

</profile>

<!-- 生产环境 -->

<profile>

<id>production</id>

<properties>

<env>production</env>

</properties>

</profile>

<!-- 测试环境 -->

<profile>

<id>test</id>

<properties>

<env>test</env>

</properties>

</profile>

</profiles>

<properties>元素的内容则是以key-value的形式出现的键值对，如我们定义了一个变量<env>，其值在不同的环境下(不同id)被赋予了不同的值(dev, production, test),要激活不同的环境打包，我们可以在命令行通过mvn package –P${profileId}来让其运行，为了开发便利，默认激活的是dev开发环境，即开发人员不需要通过命令行手动输入-p参数也能运行dev环境的打包。

2.3 定义filter

使用Maven来对项目资源进行变量替换。在资源过滤被激活的时候，Maven会扫描资源，寻找由${}包围的Maven属性的引用。一旦它找到这些引用，它就会使用合适的值去替换它们。可以根据目标部署平台使用不同的配置来参数化，这就非常有用。Filter的配置(在<build>元素下添加节点)如下：

<build>

<filters>

<filter>src/main/filters/filter-${env}-env.properties</filter>

</filters>

<!-- 配置需要被替换的资源文件地址 -->

<resources>

<resource>

<directory>src/main/resources</directory>

<filtering>true</filtering>

</resource>

</resources>

</build>

如在src/main/resources/目录下的env.properties文件的内容如下：

##################### DB config start #####################

user.jdbc.url=${user.jdbc.url}

user.jdbc.username=${user.jdbc.username}

user.jdbc.password=${user.jdbc.password}