说说 Spring Boot 的条件化配置 profile

亦凉 2022-12-17 13:00 153阅读 0赞

因为部署环境的不同，应用所使用的配置参数也可能不同。比如开发环境与生产环境之间的配置参数就存在很大的区别。比如开发环境可能使用 H2 数据库，而在生产环境用的是 Oracle 数据库。

虽然在生产环境可以使用环境变量来配置参数，但如果参数太多，就不怎么方便。

更好的方式是使用 Spring profile，它是一种条件化配置机制， Spring Boot 启动时，会根据处于激活状态 profile 来加载相应的配置参数。

> profile /ˈproʊfaɪl/  
> A representation of an object or a structure seen from the side.

## 1 定义 profile ##

定义的 profile 文件需要遵守以下规则：

1.  application-\{profileName\}.yml
2.  application-\{profileName\}.properties

假设有开发与生产环境，开发环境需要关闭 thymeleaf 的缓存，而生产环境需要开启 thymeleaf 的缓存。

创建一个名为 application-production.yml，内容如下：

spring:
      # 开启缓存
      thymeleaf:
        cache: true

如果不想新建，也可以直接写在原 application.yml 中：

...
    ---
    spring:
      profiles: production
      thymeleaf:
        cache: true

原 application.yml 内容与 profile 之间使用3个中划线进行分割，然后使用 spring.profiles 属性来命名 profile。

## 2 激活指定 profile ##

**（1）application.yml**  
可以在 application.yml 中指定需要激活的 profile 名称：

spring:
      # 激活
      profiles:
        active:
          - production

这种方式不够灵活，因为每次都需要修改配置文件。

**（2）环境变量**  
在生产环境中更合适的方式是通过环境变量来设置需要激活的profile。形如：  
`export SPRING_PROFILES_ACTIVE= production`

> Linux 的export 命令可用于设置环境变量。

**（3）命令行参数**

如果是以可执行 JAR 文件的形式来启动应用， 就可以按照命令行参数的形式来指定需要激活的profile。形如：`java -jar xxx.jar –spring.profiles.active=production`。

如果有多个需要激活的 profile，那么在环境变量中以逗号来分隔多个 profile，形如：`export SPRING_PROFILES_ACTIVE= production1, production2`。

在 yml 中，需要以列表语法来设置多个需要激活的 profile，形如：

spring:
      # 激活
      profiles:
        active:
          - production1
    	  - production2

## 3 控制 Bean 类或类中方法 ##

可以在 profile 中指定需要创建Bean或者某些方法，用于这个 profile 下的特定场景。这时就会用到 @Profile 注解。

假设在应用的 xxxApplication中有一个初始化测试环境的方法，我们需要让这个方法只在 profile 为 test 时才执行，那么可以这样配置：

@Bean
    @Profile("test")
    public void initTestEnvironment(){
    	……
    }

如果需要适配多个 profile，那么可以把 @Profile 的入参设定为数组，形如：`@Profile({"test","development"})`；  
如果只有某个 profile 不适用，比如总共定义了三个 profile，它们分别适用于开发、测试与生产环境。某个方法只在生产环境不需要执行，那么我们可以使用否定语法，形如：`@Profile("! production")`

当然也可以在类上应用 @Profile 注解，语法与作用与应用在 Bean 方法上相同。

发表评论取消回复

表情：

评论列表（有 0 条评论，153人围观）

还没有评论，来说两句吧...

相关阅读

相关 Spring Boot：条件化注解。

<table> <thead> <tr> <th>条件化注解</th> <th>配置生效条件</th> </tr> </thead> <

向右看齐/ 2024年02月19日 14:44/ 0 赞/ 68 阅读

相关说说 Spring Boot 插件化开发？

一、前言插件化开发模式正在很多编程语言或技术框架中得以广泛的应用实践，比如大家熟悉的jenkins，docker可视化管理平台rancher，以及日常编码使用的编辑器ide

逃离我推掉我的手/ 2023年10月14日 18:33/ 0 赞/ 79 阅读

相关 Spring boot使用Maven Profile配合Spring Profile进行多环境配置和打包

引言参考文章：[https://cloud.tencent.com/developer/article/1769239][https_cloud.tencent.com

妖狐艹你老母/ 2023年09月24日 23:23/ 0 赞/ 170 阅读

相关【Spring Boot】条件化自动装配

【引言】在前面的博客中，了解了Spring Boot的自动装配是如何实现的，这只是一个基础，对于自动装配，更专业的使用是可以做到条件化自动装配。【条件注解】 Spri

Bertha 。/ 2023年06月10日 03:24/ 0 赞/ 28 阅读

相关说说 Spring Boot 的条件化配置 profile

因为部署环境的不同，应用所使用的配置参数也可能不同。比如开发环境与生产环境之间的配置参数就存在很大的区别。比如开发环境可能使用 H2 数据库，而在生产环境用的是 Oracle

亦凉/ 2022年12月17日 13:00/ 0 赞/ 154 阅读

相关 Spring Boot的Profile切换方式

引言： Spring Boot是Spring社区基于之前的技术积累，而开发出来的一套快速开发框架，针对不同的profile来如何切换呢？这个和之前的mvn方式有所区别。

浅浅的花香味﹌/ 2022年08月23日 03:49/ 0 赞/ 203 阅读

相关 spring boot 使用profile来分区配置

很多时候，我们项目在开发环境和生成环境的环境配置是不一样的，例如，数据库配置，在开发的时候，我们一般用测试数据库，而在生产环境的时候，我们是用正式的数据，这时候，我们可以利用p

蔚落/ 2022年08月21日 10:55/ 0 赞/ 175 阅读

相关 Spring Boot Profiles

为不同的环境设置配置文件来看项目结构图： ![这里写图片描述][70] application.yml： spring: profiles

今天药忘吃喽~/ 2022年05月31日 05:36/ 0 赞/ 225 阅读

相关 Spring boot的profile文件

Profile Spring对不同环境，提供不同配置功能的支持可以通过激活、指定参数等方式快速的切换环境环境就是平常的开发环境、测试环境、生产环境等多p

心已赠人/ 2022年05月13日 22:04/ 0 赞/ 211 阅读

相关（3）spring boot配置（2）多profiles的配置

实际开发中使用的是多个环境，比如开发环境dev，测试环境prod：在不同的环境中使用不同的端口：比如开发环境使用端口号：8083，测试环境使用端口号：8084. 可以有如下几

男娘i/ 2022年02月04日 19:31/ 0 赞/ 267 阅读