项目中动态修改加载环境配置的几种方式

这段时间在开发一个内部项目，由于需求问题使项目开发进度一直不是很理想，当然了那都是产品经理的事情，我作为一个技术负责人要负责的也大概就是快速迭代、质量、扩展性问题。这文章我记录下如何根据环境来动态打包项目配置。

开发框架我这使用的是springboot，在开发中我们一般分为开发环境（dev）、测试环境（test）、正式环境（pro）三个环境，有时候我们可能需要针对不同环境使用不同的配置。

要想实现这种随着环境改变配置有以下几种方式可以参考，

1. 每次打包的时候手动修改配置文件。
2. 拆分配置文件，在启动jar的时候指定--spring.profiles.active参数。
3. 在maven打包的时候只将环境对应的配置文件放入jar。
4. 使用统一配置中心，如disconf、apollo等。

这里我简单记录下这几种方式的实现和不足，供参考。

第一种

针对第一种每次打包的时候手动修改配置文，假设，我现在有个一个application.propertis的文件，里面存放了连接mysql的配置，如下，

application.properties

## dev配置 ############
druid.datasource.driver-class-name=com.mysql.jdbc.Driver
druid.datasource.url=jdbc:mysql://192.168.31.101:3306/jobsconf
druid.datasource.username=root1
druid.datasource.password=root1
druid.datasource.initialsize=10
druid.datasource.druidminidle=10
druid.datasource.druidmaxactive=100

## test配置 ############
#druid.datasource.driver-class-name=com.mysql.jdbc.Driver
#druid.datasource.url=jdbc:mysql://192.168.31.102:3306/jobsconf
#druid.datasource.username=root2
#druid.datasource.password=root2
#druid.datasource.initialsize=10
#druid.datasource.druidminidle=10
#druid.datasource.druidmaxactive=100

## pro配置 ############
#druid.datasource.driver-class-name=com.mysql.jdbc.Driver
#druid.datasource.url=jdbc:mysql://192.168.31.103:3306/jobsconf
#druid.datasource.username=root3
#druid.datasource.password=root4
#druid.datasource.initialsize=10
#druid.datasource.druidminidle=10
#druid.datasource.druidmaxactive=100

这种方式就是我们把所有的配置放在一个配置文件里面，通过特殊的格式+配置块+注释说明来区分配置，如上面所示，这种方式好处是在初期、规模比较小的阶段可以使用，可以很快速的完成一个模块的开发、并且提交测试；缺点也是很多，配置文件过于复杂、庞大，可读性太差，而且这种方式也很容易出错，打出来的jar无法判断是什么配置。

如果把这复杂的配置文件拆分成3个小文件，每个文件中只维护对应的配置，那会不会好很多？

第二种

针对第二种方式，我们现在将application.propertis配置文件拆分成三个小文件，如下，

每个配置文件中都有自己独立的配置，如下，

application-dev.properties

druid.datasource.driver-class-name=com.mysql.jdbc.Driver
druid.datasource.url=jdbc:mysql://192.168.31.102:3306/jobsconf
druid.datasource.username=root2
druid.datasource.password=root2
druid.datasource.initialsize=10
druid.datasource.druidminidle=10
druid.datasource.druidmaxactive=100

application-test.properties

druid.datasource.driver-class-name=com.mysql.jdbc.Driver
druid.datasource.url=jdbc:mysql://192.168.31.102:3306/jobsconf
druid.datasource.username=root2
druid.datasource.password=root2
druid.datasource.initialsize=10
druid.datasource.druidminidle=10
druid.datasource.druidmaxactive=100

application-pro.properties

druid.datasource.driver-class-name=com.mysql.jdbc.Driver
druid.datasource.url=jdbc:mysql://192.168.31.103:3306/jobsconf
druid.datasource.username=root3
druid.datasource.password=root4
druid.datasource.initialsize=10
druid.datasource.druidminidle=10
druid.datasource.druidmaxactive=100

这样将每个环境的配置放在不同的文件中可读性增强，并且在运行的启动的时候可以通过--spring.profiles.active指定启动文件。

使用maven将程序打包，打包完毕以后使用java -jar命令启动该jar程序，并且可以在启动时候指定配置文件，如下，

java -jar myTest.jar --spring.profiles.active=test

上面代码启动时指定test配置文件。

这种方式好处就是将配置文件分开了，提高可读性、维护性，通过命令行参数在启动的时候可以动态指定环境。缺点也是很明显的，由于打包的时候是将所有的配置文件都打到一个jar中，即在一个jar中存在了dev、test、pro等环境配置，如果加入我在test环境使用pro环境启动那结果过可想而知，或许pro环境和test环境是相互隔离的，不会有影响，但是这也算是一个潜在的风险。

第三种

我们在打包的时候，能不能将指定的环境的配置文件打入jar中，例如：test环境的包中只有test环境的配置。要实现这种方式可以在maven打包的时候进行配置。

首先在pom.xml中添加配置，如下，

<profiles>
    <profile>
        <id>dev</id>
        <properties>
            <profiles.active>dev</profiles.active>
        </properties>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
    <profile>
        <id>test</id>
        <properties>
            <profiles.active>test</profiles.active>
        </properties>
    </profile>
    <profile>
        <id>pro</id>
        <properties>
            <profiles.active>pro</profiles.active>
        </properties>
    </profile>
</profiles>

接着在pom.xml中配置resources，如下，

<resources>
    <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
        <includes>
            <include>log4j2.xml</include>
            <include>application.properties</include>
            <include>application-${profiles.active}.properties</include>
        </includes>
    </resource>
</resources>

在includes节点中，可以指定打包的时候将目录中哪些文件放入jar中，接着在application.properties中加入如下代码，

spring.profiles.active=@profiles.active@

完整的pom.xml配置如下，

<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.eju.ess</groupId>
    <artifactId>rizal</artifactId>
    <version>0.0.1-snapshot</version>
    <packaging>jar</packaging>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.2.RELEASE</version>
    </parent>
    <dependencies>

    </dependencies>

    <profiles>
        <profile>
            <id>dev</id>
            <properties>
                <profiles.active>dev</profiles.active>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>
        <profile>
            <id>test</id>
            <properties>
                <profiles.active>test</profiles.active>
            </properties>
        </profile>
        <profile>
            <id>pro</id>
            <properties>
                <profiles.active>pro</profiles.active>
            </properties>
        </profile>
    </profiles>

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <filtering>true</filtering>
                <includes>
                    <include>log4j2.xml</include>
                    <include>application.properties</include>
                    <include>application-${profiles.active}.properties</include>
                </includes>
            </resource>
        </resources>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.eju.ess.Startup</mainClass>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>utf8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

完整的application.properties配置如下，

spring.profiles.active=@profiles.active@

这种方式利用的也是spring的spring.profiles.active特性，只不过这里的profiles.active@会随着打包时指定环境变量改变而改变成test或者pro，maven会自动的来修改application.properties文件中的内容。

执行maven打包命令，如下，

mvn clean package -Dmaven.test.skip=true -P test

解压刚才打的jar文件，进入到‘BOOT-INF\classes’目录中可以看到这里的配置文件只有test的，如下，

并且在application.properties中被自动替换成了spring.profiles.active=test，在启动该jar的时候就不需要指定spring.profiles.active了，如下

java -jar myTest.jar

由于jar中只存在test环境的配置，因此启动的时候也不会出现环境不一致的情况，前提是你在打包的时候要正确指定，风险可控。这种方式的缺点就是配置会分散在各个程序中，没有办法统一管理，并且修改了配置还需要重新发包、重启。不过这已经可以满足我的需求了，目前我在线上就是使用这种方式，对于我们这种规模的项目足以。

第四种

分布式配置中心这是一种比较高级的配置方式了，常见的有disconf、apollo、spring cloud config，这种配置方式就是将所有的配置通过界面维护在一个数据库中，对外提供api可供拉取配置，并且具有远程模式和本地模式两种。通过在界面维护可以看到每个配置的使用情况、使用在那台机器上一目了然，可控性管理非常高，并且可以实现热刷新，比如我在界面上修改一个配置，对应的系统中会自动更新成该配置。

这类系统太多，我不写了，思路都一样，可以学习参考。毕竟这种架构不适合我们目前的环境。

完。

原文链接

参考内容

---

http://www.cnblogs.com/softidea/p/6063629.html

http://blog.csdn.net/lihe2008125/article/details/50443491

http://zhaoshijie.iteye.com/blog/2094478