項目中動態修改加載環境配置的幾種方式

這段時間在開發一個內部項目，由於需求問題使項目開發進度一直不是很理想，當然了那都是產品經理的事情，我作爲一個技術負責人要負責的也大概就是快速迭代、質量、擴展性問題。這文章我記錄下如何根據環境來動態打包項目配置。

開發框架我這使用的是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