Spring入門(七)：Spring Profile使用講解

申城異鄉人發表於2019-08-14

Spring

1. 使用場景

在日常的開發工作中，我們經常需要將程式部署到不同的環境，比如Dev開發環境，QA測試環境，Prod生產環境，這些環境下的一些配置肯定是不一樣的，比如資料庫配置，Redis配置，RabbitMQ配置。

如果每次切換髮布環境，都需要修改配置重新構建的話，那對程式設計師來說將是噩夢，針對這種場景，Spring提供了@Profile註解來實現按照不同的環境裝配不同的bean，進而實現程式只需構建一次，但可以部署到多個環境。

2. 配置profile bean

為了更好的理解，我們通過具體的程式碼示例來理解下Spring profile的使用方法，這裡我們以資料庫配置為例。

說明：本篇部落格的重點是講解@Profile註解的使用，資料庫的操作只是輔助理解@Profile，因此不會講解的太詳細，不過後續會單獨寫部落格講解

假設我們有3套環境（Dev，QA，Prod），這3套環境的資料庫都使用的是mysql，但是其地址，使用者名稱，密碼都不一樣，那麼在Java配置中，該如何宣告這些bean呢？

2.1 Java配置中配置profile bean

首先需要了解的是，@Profile註解是從Spring 3.1版本中開始引入的，並且在這個版本中，@Profile註解只能在類級別上使用。

因此我們可以按照環境分別建立資料庫配置，如下所示：

Dev環境下的資料庫配置：

package chapter03.profile;

import org.apache.commons.dbcp2.BasicDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

import javax.sql.DataSource;

@Configuration
@Profile("dev")
public class DevDataSourceConfig {
    @Bean
    public DataSource devDataSource() {
        System.out.println("This is dev DataSource");

        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        basicDataSource.setUrl("jdbc:mysql://localhost:3306/mybatis_action_db");
        basicDataSource.setUsername("dev");
        basicDataSource.setPassword("dev");

        return basicDataSource;
    }
}

使用上述程式碼需要在pom.xml中新增如下依賴：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-dbcp2</artifactId>
    <version>2.7.0</version>
</dependency>

注意事項：如果類級別上使用了@Profile("dev")，那麼該類中的所有bean都會在profile為dev時建立。

QA環境下的資料庫配置：

package chapter03.profile;

import org.apache.commons.dbcp2.BasicDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

import javax.sql.DataSource;

@Configuration
@Profile("qa")
public class QADataSourceConfig {
    @Bean
    public DataSource qaDataSource() {
        System.out.println("This is qa DataSource");

        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        basicDataSource.setUrl("jdbc:mysql://localhost:3307/mybatis_action_db");
        basicDataSource.setUsername("qa");
        basicDataSource.setPassword("qa");

        return basicDataSource;
    }
}

Prod環境下的資料庫配置：

package chapter03.profile;

import org.apache.commons.dbcp2.BasicDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

import javax.sql.DataSource;

@Configuration
@Profile("prod")
public class ProdDataSourceConfig {
    @Bean
    public DataSource prodDataSource() {
        System.out.println("This is prod DataSource");

        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        basicDataSource.setUrl("jdbc:mysql://localhost:3308/mybatis_action_db");
        basicDataSource.setUsername("prod");
        basicDataSource.setPassword("prod");

        return basicDataSource;
    }
}

不過從Spring 3.2開始，@Profile註解可以與@Bean註解一起在方法級別上使用。

這也就使得我們可以將剛剛的3個配置類合併成1個配置類（推薦該方式），如下所示：

package chapter03.profile;

import org.apache.commons.dbcp2.BasicDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {
    @Bean
    @Profile("dev")
    public DataSource devDataSource() {
        System.out.println("This is dev DataSource");

        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        basicDataSource.setUrl("jdbc:mysql://localhost:3306/mybatis_action_db");
        basicDataSource.setUsername("dev");
        basicDataSource.setPassword("dev");

        return basicDataSource;
    }

    @Bean
    @Profile("qa")
    public DataSource qaDataSource() {
        System.out.println("This is qa DataSource");

        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        basicDataSource.setUrl("jdbc:mysql://localhost:3307/mybatis_action_db");
        basicDataSource.setUsername("qa");
        basicDataSource.setPassword("qa");

        return basicDataSource;
    }

    @Bean
    @Profile("prod")
    public DataSource prodDataSource() {
        System.out.println("This is prod DataSource");

        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName("com.mysql.jdbc.Driver");
        basicDataSource.setUrl("jdbc:mysql://localhost:3308/mybatis_action_db");
        basicDataSource.setUsername("prod");
        basicDataSource.setPassword("prod");

        return basicDataSource;
    }
}

注意事項：沒有指定profile的bean始終都會建立，與啟用哪個profile無關。

2.2 xml中配置profile bean

我們也可以通過<beans>元素的profile屬性，在xml中配置profile bean，如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"
       profile="dev">
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
          p:driverClassName="com.mysql.jdbc.Driver"
          p:url="jdbc:mysql://localhost:3306/mybatis_action_db"
          p:username="dev"
          p:password="dev"/>
</beans>

可以參考該配置，分別建立qa和prod環境的profile xml檔案。

不過還是推薦使用巢狀的<beans>元素，在一個xml檔案中配置好3個環境的資料來源，程式碼如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:p="http://www.springframework.org/schema/p"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    <beans profile="dev">
        <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
              p:driverClassName="com.mysql.jdbc.Driver"
              p:url="jdbc:mysql://localhost:3306/mybatis_action_db"
              p:username="dev"
              p:password="dev"/>
    </beans>
    <beans profile="qa">
        <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
              p:driverClassName="com.mysql.jdbc.Driver"
              p:url="jdbc:mysql://localhost:3307/mybatis_action_db"
              p:username="qa"
              p:password="qa"/>
    </beans>
    <beans profile="prod">
        <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource"
              p:driverClassName="com.mysql.jdbc.Driver"
              p:url="jdbc:mysql://localhost:3308/mybatis_action_db"
              p:username="prod"
              p:password="prod"/>
    </beans>
</beans>

3. 啟用profile

截止目前，我們按照環境的維度建立了3個bean，但實際執行時，只會建立1個bean，具體建立哪個bean取決於處於啟用狀態的是哪個profile。

那麼，我們該如何啟用某個profile呢？

Spring在確定啟用哪個profile時，需要依賴2個屬性：

spring.profiles.active
spring.profiles.default

spring.profiles.active的優先順序比spring.profiles.default高，即如果沒有配置spring.profiles.active，就使用spring.profiles.default配置的值，如果配置了spring.profiles.active，就不會再使用spring.profiles.default配置的值。

如果兩者都沒有配置，就只會建立那些沒有定義profile的bean。

Web應用中，在web.xml中設定spring.profiles.active的程式碼如下所示：

<context-param>
    <param-name>spring.profiles.active</param-name>
    <param-value>dev</param-value>
</context-param>

也可以使用程式碼方式啟用：

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();

context.getEnvironment().setActiveProfiles("dev");

4. 單元測試

新建Main類，在其main()方法中新增如下測試程式碼：

package chapter03.profile;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Main {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();

        context.getEnvironment().setActiveProfiles("dev");
        context.register(DataSourceConfig.class);
        context.refresh();

        context.close();
    }
}

輸出結果如下所示：

This is dev DataSource

如果將程式碼修改為context.getEnvironment().setActiveProfiles("qa");，輸出結果為：

This is qa DataSource

如果將程式碼修改為context.getEnvironment().setActiveProfiles("prod");，輸出結果為：

This is prod DataSource

5. 原始碼及參考

原始碼地址：https://github.com/zwwhnly/spring-action.git，歡迎下載。

汪雲飛《Java EE開發的顛覆者：Spring Boot實戰》

Craig Walls 《Spring實戰（第4版）》

6. 最後

打個小廣告，歡迎掃碼關注微信公眾號：「申城異鄉人」，定期分享Java技術乾貨，讓我們一起進步。

Spring入門(七)：Spring Profile使用講解

Spring @Profile註解使用和原始碼解析
2023-04-13
Spring原始碼
Spring入門(四)：使用Maven管理Spring專案
2019-05-20
SpringMaven
原創：spring入門介紹第一講
2020-04-06
Spring
spring5入門與實踐第三講Spring的其他特性
2018-03-20
Spring
Spring入門之IOC詳解
2020-10-15
Spring
Spring 入門
2020-12-22
Spring
Spring Boot 中使用 thrift 入門
2018-05-23
Spring Boot
Spring Boot 中使用 grpc 入門
2018-05-26
Spring BootRPC
Spring Boot入門(七)：使用MyBatis訪問MySql資料庫(xml方式)
2019-06-14
Spring BootMyBatisMySql資料庫XML
Spring Boot 2.X(七)：Spring Cache 使用
2019-10-15
Spring Boot
spring-boot入門程式詳解
2021-09-09
Springboot
spring Cloud Gateway 入門簡單使用
2019-03-12
SpringCloudGateway
spring入門(二)
2020-11-18
Spring
1、Spring入門
2018-03-26
Spring
Spring入門指南
2024-07-26
Spring
spring 快速入門
2021-09-03
Spring
Spring Boot入門
2021-06-08
Spring Boot
Spring入門(一)：建立Spring專案
2019-03-07
Spring
Spring Cloud Gateway入門 - spring.io
2019-06-22
SpringCloudGateway
Spring Boot 整合 Spring Security 入門案例教程
2020-04-21
Spring Boot
Spring Boot系列(一)：Spring Boot 入門篇
2019-04-26
Spring Boot
Spring Boot整合 Geodesy講解
2024-06-09
Spring Boot
Spring Security 快速入門
2019-03-02
Spring
Spring Security（一）入門
2018-09-15
Spring
Spring MVC 入門程式
2018-08-19
SpringMVC
Spring Cloud Gateway 入門
2018-03-11
SpringCloudGateway
Spring Boot HttpExchange 入門
2024-05-14
Spring BootHTTP
#Spring JdbcTemplate入門@FDDLC
2020-09-28
SpringJDBC
spring mvc 快速入門
2020-04-05
SpringMVC
Spring Boot Dubbo 入門
2020-04-19
Spring Boot
入門Spring6
2024-09-05
Spring
spring boot快速入門
2021-11-09
Spring Boot
Spring Security 入門篇
2021-05-10
Spring
spring入門學習
2020-12-12
Spring
Spring系列第三講 Spring容器基本使用及原理
2020-10-28
Spring
Spring Boot - Profile不同環境配置
2018-05-04
Spring Boot
Spring5（七）——AOP註解
2021-09-15
Spring
專題一之Spring Boot入門詳解
2019-04-04
Spring Boot

Spring入門(七)：Spring Profile使用講解

1. 使用場景

2. 配置profile bean

2.1 Java配置中配置profile bean

2.2 xml中配置profile bean

3. 啟用profile

4. 單元測試

5. 原始碼及參考

6. 最後

相關文章