《Spring注解驱动开发》第30章：使用@Profile注解实现开发、测试和生产环境的配置和切换

写在前面

在实际的企业开发环境中，往往都会将环境分为：开发环境、测试环境和生产环境，而每个环境基本上都是互相隔离的，也就是说，开发环境、测试环境和生产环境是互不相通的。在以前的开发过程中，如果开发人员完成相应的功能模块并通过单元测试后，会通过手动修改配置文件的形式，将项目的配置修改成测试环境，发布到测试环境进行测试。测试通过后，再将配置修改为生产环境，发布到生产环境。这样手动修改配置的方式，一方面增加了开发和运维的工作量，而且总是手工修改各项配置文件很容易出问题。那么，有没有什么方式可以解决这些问题呢？答案是：有！通过@Profile注解就可以完全做到。

关注 冰河技术 微信公众号，回复 “ Spring注解 ” 关键字领取源码。

如果文章对你有所帮助，欢迎大家留言、点赞、在看和转发，大家的支持是我持续创作的动力！

@Profile注解

在容器中如果存在同一类型的多个组件，也可以使用@Profile注解标识要获取的是哪一个bean，这在不同的环境使用不同的变量的情景特别有用。例如，开发环境、测试环境、生产环境使用不同的数据源，在不改变代码的情况下，可以使用这个注解来切换要连接的数据库。

步骤如下：

1. 在bean上加@Profile注解，其value属性值为环境标识，可以自定义
2. 使用无参构造方法创建容器
3. 设置容器环境，其值为第1步设置的环境标识
4. 设置容器的配置类
5. 刷新容器

注：2、4、5步其实是带参构造方法的步骤，相当于把带参构造方法拆开，在其中插入一条语句设置容器环境，这些我们可以在Spring的源码中可以看出，比如下面的代码。

public AnnotationConfigApplicationContext(Class<?>... annotatedClasses) {
   this();
   register(annotatedClasses);
   refresh();
}

接下来，我们再来看下@Profile注解的源码，如下所示。

package org.springframework.context.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.env.AbstractEnvironment;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Profiles;
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(ProfileCondition.class)
public @interface Profile {
	String[] value();
}

注意：@Profile不仅可以标注在方法上，也可以标注在配置类上。如果标注在配置类上，只有在指定的环境时，整个配置类里面的所有配置才会生效。如果一个bean上没有使用@Profile注解进行标注，那么这个bean在任何环境下都会被注册到IOC容器中

环境搭建

接下来，我们就一起来搭建使用@Profile注解实现开发、测试和生产环境的配置和切换的环境。这里，我们以不同的数据源为例。首先，我们在pom.xml文件中添加c3p0和MySQL驱动的依赖，如下所示。

<dependency>
    <groupId>c3p0</groupId>
    <artifactId>c3p0</artifactId>
    <version>0.9.1.2</version>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.44</version>
</dependency>

添加完项目依赖之后，我们在项目中新建ProfileConfig配置类，并在ProfileConfig配置类中模拟开发、测试、生产环境的数据源，如下所示。

package io.mykit.spring.plugins.register.config;

import com.mchange.v2.c3p0.ComboPooledDataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

/**
 * @author binghe
 * @version 1.0.0
 * @description 测试多数据源
 */
@Configuration
public class ProfileConfig {
    @Bean("devDataSource")
    public DataSource dataSourceDev() throws Exception{
        ComboPooledDataSource dataSource = new ComboPooledDataSource();
        dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_dev");
        dataSource.setUser("root");
        dataSource.setPassword("root");
        dataSource.setDriverClass("com.mysql.jdbc.Driver");
        return dataSource;
    }
    @Bean("testDataSource")
    public DataSource dataSourceTest() throws Exception{
        ComboPooledDataSource dataSource = new ComboPooledDataSource();
        dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_test");
        dataSource.setUser("root");
        dataSource.setPassword("root");
        dataSource.setDriverClass("com.mysql.jdbc.Driver");
        return dataSource;
    }
    @Bean("prodDataDource")
    public DataSource dataSourceProd() throws Exception{
        ComboPooledDataSource dataSource = new ComboPooledDataSource();
        dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_prod");
        dataSource.setUser("root");
        dataSource.setPassword("root");
        dataSource.setDriverClass("com.mysql.jdbc.Driver");
        return dataSource;
    }
}

这个类相对来说比较简单，其中使用 @Bean("devDataSource")注解标注的是开发环境使用的数据源；使用 @Bean("testDataSource")注解标注的是测试环境使用的数据源；使用@Bean("prodDataDource")注解标注的是生产环境使用的数据源。

接下来，我们创建ProfileTest类，并在ProfileTest类中新建一个testProfile01()方法来进行测试，如下所示。

package io.mykit.spring.test;
import io.mykit.spring.plugins.register.config.ProfileConfig;
import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import javax.sql.DataSource;
import java.util.stream.Stream;
/**
 * @author binghe
 * @version 1.0.0
 * @description 测试类
 */
public class ProfileTest {
    @Test
    public void testProfile01(){
        //创建IOC容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ProfileConfig.class);
        String[] names = context.getBeanNamesForType(DataSource.class);
        Stream.of(names).forEach(System.out::println);
    }
}

运行ProfileTest类的testProfile01()方法，输出的结果信息如下所示。

devDataSource
testDataSource
prodDataDource

可以看到三种不同的数据源成功注册到了IOC容器中，说明我们的环境搭建成功了。

根据环境注册bean

我们成功搭建环境后，接下来，就是要实现根据不同的环境来向IOC容器中注册相应的bean。也就是说，我们要实现在开发环境注册开发环境下使用的数据源；在测试环境注册测试环境下使用的数据源；在生产环境注册生产环境下使用的数据源。此时，@Profile注解就显示出其强大的特性了。

我们在ProfileConfig类中为每个数据源添加@Profile注解标识，如下所示。

@Profile("dev")
@Bean("devDataSource")
public DataSource dataSourceDev() throws Exception{
    ComboPooledDataSource dataSource = new ComboPooledDataSource();
    dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_dev");
    dataSource.setUser("root");
    dataSource.setPassword("root");
    dataSource.setDriverClass("com.mysql.jdbc.Driver");
    return dataSource;
}
@Profile("test")
@Bean("testDataSource")
public DataSource dataSourceTest() throws Exception{
    ComboPooledDataSource dataSource = new ComboPooledDataSource();
    dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_test");
    dataSource.setUser("root");
    dataSource.setPassword("root");
    dataSource.setDriverClass("com.mysql.jdbc.Driver");
    return dataSource;
}
@Profile("prod")
@Bean("prodDataDource")
public DataSource dataSourceProd() throws Exception{
    ComboPooledDataSource dataSource = new ComboPooledDataSource();
    dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_prod");
    dataSource.setUser("root");
    dataSource.setPassword("root");
    dataSource.setDriverClass("com.mysql.jdbc.Driver");
    return dataSource;
}

我们使用@Profile("dev")注解来标识在开发环境下注册devDataSource；使用@Profile("test")注解来标识在测试环境下注册testDataSource；使用@Profile("prod")注解来标识在生产环境下注册prodDataDource。

此时，我们运行ProfileTest类的testProfile01()方法，发现命令行并未输出结果信息。说明我们为不同的数据源添加@Profile注解后，默认是不会向IOC容器中注册bean的，需要我们根据环境显示指定向IOC容器中注册相应的bean。

换句话说：通过@Profile注解加了环境标识的bean，只有这个环境被激活的时候，相应的bean才会被注册到IOC容器中。

如果我们需要一个默认的环境怎么办呢？

此时，我们可以通过@Profile("default")注解来标识一个默认的环境，例如，我们将devDataSource环境标识为默认环境，如下所示。

@Profile("default")
@Bean("devDataSource")
public DataSource dataSourceDev() throws Exception{
    ComboPooledDataSource dataSource = new ComboPooledDataSource();
    dataSource.setJdbcUrl("jdbc:mysql://localhost:3306/test_dev");
    dataSource.setUser("root");
    dataSource.setPassword("root");
    dataSource.setDriverClass("com.mysql.jdbc.Driver");
    return dataSource;
}

此时，我们运行ProfileTest类的testProfile01()方法，输出的结果信息如下所示。

devDataSource

可以看到，我们在devDataSource数据源上使用@Profile("default")注解将其设置为默认的数据源，运行测试方法时命令行会输出devDataSource。

接下来，我们将devDataSource数据源的@Profile("default")注解还原成@Profile("dev")注解，标识它为一个开发环境下注册的数据源。

那么，我们如何根据不同的环境来注册相应的bean呢？

第一种方式就是根据命令行参数来确定环境，我们在运行程序的时候可以添加相应的命令行参数，例如，我们现在的环境是测试环境，那可以在运行程序的时候添加如下命令行参数。

-Dspring.profiles.active=test

第二种方式就是通过AnnotationConfigApplicationContext类的无参构造方法来实现。我们在程序中调用AnnotationConfigApplicationContext的无参构造方法来生成IOC容器，在容器进行初始化之前，我们就为IOC容器设置相应的环境，然后再为IOC容器设置主配置类。例如，我们将IOC容器设置为生产环境，如下所示。

@Test
public void testProfile02(){
    //创建IOC容器
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
    context.getEnvironment().setActiveProfiles("prod");
    context.register(ProfileConfig.class);
    context.refresh();
    String[] names = context.getBeanNamesForType(DataSource.class);
    Stream.of(names).forEach(System.out::println);
}

此时，我们运行testProfile02()方法，输出的结果信息如下所示。

prodDataDource

可以看到，命令行输出了prodDataDource，说明我们成功将IOC环境设置为了生产环境。

@Profile不仅可以标注在方法上，也可以标注在配置类上。如果标注在配置类上，只有在指定的环境时，整个配置类里面的所有配置才会生效。例如，我们在ProfileConfig类上标注@Profile("dev")注解，如下所示。

@Profile("dev")
@Configuration
public class ProfileConfig {
    /*********代码省略*********/
}

接下来，我们运行testProfile02()方法，发现命令行中未输出任何信息。

这是因为我们在testProfile02()方法中指定了当前的环境为生产环境，而ProfileConfig类上标注的注解为@Profile("dev")，说明ProfileConfig类中的所有配置只有在开发环境下才会生效。所以，此时没有任何数据源注册到IOC容器中，命令行不会打印任何信息。

重磅福利

关注「 冰河技术 」微信公众号，后台回复 “设计模式” 关键字领取《深入浅出Java 23种设计模式》PDF文档。回复“Java8”关键字领取《Java8新特性教程》PDF文档。回复“限流”关键字获取《亿级流量下的分布式限流解决方案》PDF文档，三本PDF均是由冰河原创并整理的超硬核教程，面试必备！！

好了，今天就聊到这儿吧！别忘了点个赞，给个在看和转发，让更多的人看到，一起学习，一起进步！！

星球服务

加入星球，你将获得：

1.项目学习：微服务入门必备的SpringCloud Alibaba实战项目、手写RPC项目—所有大厂都需要的项目【含上百个经典面试题】、深度解析Spring6核心技术—只要学习Java就必须深度掌握的框架【含数十个经典思考题】、Seckill秒杀系统项目—进大厂必备高并发、高性能和高可用技能。

2.框架源码：手写RPC项目—所有大厂都需要的项目【含上百个经典面试题】、深度解析Spring6核心技术—只要学习Java就必须深度掌握的框架【含数十个经典思考题】。

3.硬核技术：深入理解高并发系列（全册）、深入理解JVM系列（全册）、深入浅出Java设计模式（全册）、MySQL核心知识（全册）。

4.技术小册：深入理解高并发编程（第1版）、深入理解高并发编程（第2版）、从零开始手写RPC框架、SpringCloud Alibaba实战、冰河的渗透实战笔记、MySQL核心知识手册、Spring IOC核心技术、Nginx核心技术、面经手册等。

5.技术与就业指导：提供相关就业辅导和未来发展指引，冰河从初级程序员不断沉淀，成长，突破，一路成长为互联网资深技术专家，相信我的经历和经验对你有所帮助。

冰河的知识星球是一个简单、干净、纯粹交流技术的星球，不吹水，目前加入享5折优惠，价值远超门票。加入星球的用户，记得添加冰河微信：hacker_binghe，冰河拉你进星球专属VIP交流群。

星球重磅福利

跟冰河一起从根本上提升自己的技术能力，架构思维和设计思路，以及突破自身职场瓶颈，冰河特推出重大优惠活动，扫码领券进行星球，直接立减149元，相当于5折， 这已经是星球最大优惠力度！

领券加入星球，跟冰河一起学习《SpringCloud Alibaba实战》、《手撸RPC专栏》和《Spring6核心技术》，更有已经上新的《大规模分布式Seckill秒杀系统》，从零开始介绍原理、设计架构、手撸代码。后续更有硬核中间件项目和业务项目，而这些都是你升职加薪必备的基础技能。

100多元就能学这么多硬核技术、中间件项目和大厂秒杀系统，如果是我，我会买他个终身会员！

其他方式加入星球

• 链接 ：打开链接 http://m6z.cn/6aeFbs (opens new window) 加入星球。
• 回复 ：在公众号 冰河技术 回复 星球 领取优惠券加入星球。

特别提醒： 苹果用户进圈或续费，请加微信 hacker_binghe 扫二维码，或者去公众号 冰河技术 回复 星球 扫二维码加入星球。

星球规划

后续冰河还会在星球更新大规模中间件项目和深度剖析核心技术的专栏，目前已经规划的专栏如下所示。

中间件项目

• 《大规模分布式定时调度中间件项目实战（非Demo）》：全程手撸代码。
• 《大规模分布式IM（即时通讯）项目实战（非Demo）》：全程手撸代码。
• 《大规模分布式网关项目实战（非Demo）》：全程手撸代码。
• 《手写Redis》：全程手撸代码。
• 《手写JVM》全程手撸代码。

超硬核项目

• 《从零落地秒杀系统项目》：全程手撸代码，在阿里云实现压测（已上新）。
• 《大规模电商系统商品详情页项目》：全程手撸代码，在阿里云实现压测。
• 其他待规划的实战项目，小伙伴们也可以提一些自己想学的，想一起手撸的实战项目。。。

既然星球规划了这么多内容，那么肯定就会有小伙伴们提出疑问：这么多内容，能更新完吗？我的回答就是：一个个攻破呗，咱这星球干就干真实中间件项目，剖析硬核技术和项目，不做Demo。初衷就是能够让小伙伴们学到真正的核心技术，不再只是简单的做CRUD开发。所以，每个专栏都会是硬核内容，像《SpringCloud Alibaba实战》、《手撸RPC专栏》和《Spring6核心技术》就是很好的示例。后续的专栏只会比这些更加硬核，杜绝Demo开发。

小伙伴们跟着冰河认真学习，多动手，多思考，多分析，多总结，有问题及时在星球提问，相信在技术层面，都会有所提高。将学到的知识和技术及时运用到实际的工作当中，学以致用。星球中不少小伙伴都成为了公司的核心技术骨干，实现了升职加薪的目标。

联系冰河

加群交流

本群的宗旨是给大家提供一个良好的技术学习交流平台，所以杜绝一切广告！由于微信群人满 100 之后无法加入，请扫描下方二维码先添加作者 “冰河” 微信(hacker_binghe)，备注：星球编号。

冰河微信

公众号

分享各种编程语言、开发技术、分布式与微服务架构、分布式数据库、分布式事务、云原生、大数据与云计算技术和渗透技术。另外，还会分享各种面试题和面试技巧。内容在 冰河技术 微信公众号首发，强烈建议大家关注。

公众号：冰河技术

视频号

定期分享各种编程语言、开发技术、分布式与微服务架构、分布式数据库、分布式事务、云原生、大数据与云计算技术和渗透技术。另外，还会分享各种面试题和面试技巧。

视频号：冰河技术

星球

加入星球 冰河技术 (opens new window)，可以获得本站点所有学习内容的指导与帮助。如果你遇到不能独立解决的问题，也可以添加冰河的微信：hacker_binghe， 我们一起沟通交流。另外，在星球中不只能学到实用的硬核技术，还能学习实战项目！

关注 冰河技术 (opens new window)公众号，回复 星球 可以获取入场优惠券。

知识星球：冰河技术