Spring.profile實現開發、測試和生產環境的配置和切換

軟件開發過程通常涉及「開發 -> 測試 -> 部署上線」多個階段，每一個階段的環境的配置參數會有不一樣，如數據源，文件路徑等。爲避免每次切換環境時都要進行參數配置等繁瑣的操做，能夠經過spring的profile功能來進行配置參數的切換。

以我用到的項目的實際狀況爲例，首先能夠在resources文件夾下分別爲每一個環境創建單獨的文件夾（也能夠額外創建一個common文件夾，用於存放公共的參數配置文件），每一個文件夾下面存放對應的環境所需的配置文件，就像這樣子：

在resources文件夾下創建applicationContext-profile.xml文件，用來定義不一樣的profile：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:c="http://www.springframework.org/schema/c" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:p="http://www.springframework.org/schema/p" xmlns:jdbc="http://www.springframework.org/schema/jdbc"
    xmlns:jee="http://www.springframework.org/schema/jee" xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
    http://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/context 
    http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/jdbc 
    http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
    http://www.springframework.org/schema/jee 
    http://www.springframework.org/schema/jee/spring-jee.xsd">

    <description>spring profile配置</description>

    <!-- 開發環境配置文件 -->
    <beans profile="development">
        <context:property-placeholder
            location="classpath*:common/*.properties, classpath*:development/*.properties" />
    </beans>

    <!-- 測試環境配置文件 -->
    <beans profile="test">
        <context:property-placeholder
            location="classpath*:common/*.properties, classpath*:test/*.properties" />
    </beans>
    
    <!-- 生產環境配置文件 -->
    <beans profile="production">
        <context:property-placeholder
            location="classpath*:common/*.properties, classpath*:production/*.properties" />
    </beans>

</beans>

這樣就實現了經過profile標記不一樣的環境，接下來就能夠經過設置spring.profiles.default和spring.profiles.active這兩個屬性來激活和使用對應的配置文件。default爲默認，若是沒有經過active來指定，那麼就默認使用default定義的環境。

這兩個屬性能夠經過多種方法來設置：

• 在web.xml中做爲web應用的上下文參數context-param；
• 在web.xml中做爲DispatcherServlet的初始化參數；
• 做爲JNDI條目；
• 做爲環境變量；
• 做爲JVM的系統屬性；
• 在集成測試類上，使用@ActiveProfiles註解配置。

前二者均可以在web.xml文件中設置：

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">

    <display-name>Archetype Created Web Application</display-name>

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
            classpath*:/applicationContext*.xml
        </param-value>
    </context-param>

    <!-- 在上下文context-param中設置profile.default的默認值 -->
    <context-param>
        <param-name>spring.profiles.default</param-name>
        <param-value>development</param-value>
    </context-param>

    <!-- 在上下文context-param中設置profile.active的默認值 -->
    <!-- 設置active後default失效，web啓動時會加載對應的環境信息 -->
    <context-param>
        <param-name>spring.profiles.active</param-name>
        <param-value>development</param-value>
    </context-param>

    <servlet>
        <servlet-name>appServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 在DispatcherServlet參數中設置profile的默認值，active同理 -->
        <init-param>
            <param-name>spring.profiles.default</param-name>
            <param-value>development</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>appServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

激活指定的環境，也能夠經過JVM參數來設置，能夠在tomcat的啓動腳本中加入如下JVM參數來激活：

-Dspring.profiles.active="production"

 

在程序中，也能夠經過 @Profile("...") 對某些資源進行註解，這樣只有當選擇對應的環境時，纔會產生對應的bean，如：

@Bean
@Profile("production")    
    public DataSource jndiDataSource(){
        JndiObjectFactoryBean jofb=new JndiObjectFactoryBean();
        jofb.setJndiName("jndi/iDS");
        jofb.setResourceRef(true);
        jofb.setProxyInterface(xxx.class);
        return (DataSource) jofb.getObject();
    }
}

 

參考：

1.  Spring-profile設置

2.  經過 spring 容器內建的 profile 功能實現開發環境、測試環境、生產環境配置自動切換