资讯专栏INFORMATION COLUMN

一文掌握 Spring Boot Profiles

Eidesen / 1865人阅读

摘要:需要注意的是必须要使用版本为以上才支持属性。与格式文件不同,正对不同的,无法在一个文件设置,官方采用命名形式为格式来达成一样的效果。采用方式添加的是属于额外激活的,也就是说覆盖掉外部传入的指定的。

Spring Boot Profiles 简介

Profile 的概念其实很早在 Spring Framework 就有了,在 Spring Framework 3.1 版本引入了注解 @ProfileEnvironment 环境配置的抽象,只是在 Spring Boot 框架里再进一步将 Profiles 功能进行扩展,使它也成为了 Spring Boot 特性之一,为此多带带在 官方文档 25. Profiles 一节里介绍,文档里把 Spring Boot Profiles 也叫做 Spring Profiles。

那么什么又是 Spring Profiles,为什么需要它呢?我们先来看一个熟悉的场景:我们平常项目开发,经常需要根据不同的环境进行配置的修改,比如在本地开发会加载本机的配置和开发环境数据库,在测试服务器上部署时就需要加载测试环境配置和数据库,同样地,当项目发布生产环境时就需要设置为生产环境配置和数据库。这样一来,不同的环境部署都需要额外的处理来调整环境的配置,维护起来十分繁琐,还容易出错。

为了解决不同环境需要的配置切换问题,Spring Profiles 提供了一种方式允许我们指定在特定环境下只加载对应的程序配置,每一种环境配置对应一个 Profile,只有当前 Profile 处于激活状态时,才会将该 Profile 所对应的配置和 Bean 加载到 Spring 程序中。

Spring Profiles 就是针对应用程序,不同环境需要不同配置加载的一种解决方案。

当然 Spring 允许多个 Profile 处于激活状态,比如将应用配置进行细分成数据库配置,消息中间件配置,缓存配置等,都为各自在不同环境定义不同的 Profile 名称,在需要激活环境对应配置时,指定多个 Profile。

Spring Profiles 实战

在 Spring 程序中有两种方式使用 Profiles:XML 配置和注解 @Profile

XML 配置定义 Profile

虽然现在 XML 配置方式使用越来越少,还是简单介绍下,通常我们在 XML 文件定义的 Bean 时都有根元素 ,在 beans 元素上多了一个属性 profile 可以指定环境,比如说把开发环境的 profile 定义为 dev,生产环境的 profile 为:prod。

需要注意的是:必须要使用 Spring XML Beans Schema 版本为 4.0 以上才支持 profile 属性。在 XML 文件定义之后我们只需要激活指定的 Profile 名称就可以加载对应的 Bean 对象了,在 Spring 程序中激活的方式主要两种:

Java API 方式,获取当前 Spring 容器的环境 Bean,设置 activeProfiles 属性,然后启动容器

采用启动参数方式指定,固定格式:-Dspring.profiles.active=dev

注解 @Profiles 定义Profile

使用注解定义 Profile 也比较简单,引入一个新的注解 @Profiles,通常 @Profiles 配合 @Component 或者 @Configuration 使用,如下示例:

激活 Profile 的方式都是一样的,只要指定 Profile 被激活,其对应的 Bean 才会加载。在 Spring 程序中 Profile 默认为 default,当前我们可以通过 spring.profiles.default 配置方式或者 org.springframework.core.env.AbstractEnvironment#setDefaultProfiles API 方式修改。

Spring Boot Profile 实战

好了,现在我们再来看下在 Spring Boot 程序中如何使用 Profile。通常一个 Spring Boot 程序的配置文件为 yml 或者 properties 格式,由于 yml 格式文件的结构简洁已读,备受官方推崇,我们可以看下如何在 application.yml 定义 Profile 和对应的配置。

与yml格式文件不同,正对不同的 Profile,无法在一个 properties 文件设置,官方采用命名形式为 applications-${profile}.properties 格式来达成一样的效果。为了看到指定 Profile 激活后的效果,我们可以通过下方的一个例子实践下,通过激活不同 Profile 启动程序,来请求 /enviroment 接口来获取当前的环境配置变量。

这里我们介绍如何在配置文件中激活 Profile 的方式:在 application.yml 顶部添加如下配置,表明当前所激活的 Profile 为 prod,当然也可以前文介绍的启动参数方式激活:

然后启动程序,curl 方式访问 http://localhost:9000/enviroment 可以得到如下输出结果:

同样如果上述的 active 属性值指定为 dev,将输出内容: current app enviroment is prod

Spring Boot API 方式激活 Profile

在 Spring Boot 程序除了上述的方法来激活 Profile 外,还可以使用 Spring Boot API 方式激活:

SpringApplication.setAdditionalProfiles(…)

SpringApplicationBuilder.profiles(...)

但需要注意的是使用 Spring Boot API 的话需要在程序启动前设置,也就是 SpringApplication.run(...) 方法执行前,否则没有效果。 采用 Spring Boot API 方式添加的Profile 是属于额外激活的 Profile,也就是说覆盖掉外部传入的 spring.profiles.activie 指定的 Profile。

总结

在Spring Boot 程序中,我们通常定义不同 Profiles 的配置文件,如 application-{profile}.properties,在默认配置文件 application.properties 中设置 spring.profiles.active=dev ,用于平常开发使用,当需要打包上传服务器时,通过启动参数方式 jar -Dspring.profiles.active=prod xxx.jar 指定对应环境的 Profile 启动程序来加载对应环境的配置,到这里我们学习如何通过 Spring Boot Profiles 特性来应对程序中不同环境配置的切换,希望对工作中的小伙伴有所帮助,也欢迎小伙伴留言分享应对项目环境配置区分加载的实践心得。若有错误或者不当之处,还请大家批评指正,一起学习交流。

下篇文章将通过解读源码的方式具体讲解 Spring Boot Profiles 实现原理,敬请关注期待。

示例代码

本文示例代码可以通过下面仓库地址获取:

springboot-actions-profiles:https://github.com/wrcj12138a...

环境支持:

JDK 8

SpringBoot 2.1.6

Maven 3.6.0

参考资料

How to use profiles in Spring Boot Application:http://1t.click/yUj

Spring Boot Doc:http://1t.click/yUh

Spring Doc:http://1t.click/yUg

全面解读 Spring Profile 的用法:https://mp.weixin.qq.com/s/0i...

推荐阅读

如何优雅关闭 Spring Boot 应用

需要接口管理的你了解一下?

Java 之 Lombok 必知必会

Java 微服务新生代之 Nacos

掌握设计模式之适配器模式

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/75694.html

相关文章

  • 源码解读 Spring Boot Profiles

    摘要:有了配置文件之后,启动程序,我们首先可以看到日志输入,由此可以看出程序读取了的配置。首先,根据的全局查找功能,直接搜索这些词出现的位置,进行定位,可以找到这个日志出现于方法之中。由于我们的配置文件在下,所以只要留意当为的程序执行情况即可。 前言 上文《一文掌握 Spring Boot Profiles》 是对 Spring Boot Profiles 的介绍和使用,因此本文将从源码角度...

    Dionysus_go 评论0 收藏0
  • 一起来学SpringBoot | 第二篇:SpringBoot配置详解

    摘要:如何测试进入到项目目录,此处以我本地目录为主然后打开程序,不会在当前目录打开的请自行百度,输入打包完毕后进入到目录中去,我们可以发现一个名为的包接着在打开程序,输入。 SpringBoot 是为了简化 Spring 应用的创建、运行、调试、部署等一系列问题而诞生的产物,自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置,我们只需遵循规范,引入相关的依赖就可以轻易的搭建出...

    leap_frog 评论0 收藏0
  • Maven profile整合Spring profile

    摘要:此时可以尝试或命令打包,安装包内的文件中占位符已被替换。整合原理项目中一般都会加上可以查看的文件,里面包含定义的值是这样插件会将或文件中的替换为中对应的值。 在Maven和Spring中,都有profile这个概念。profile是用于区分各种环境的,例如开发环境、测试环境、正式环境等。Maven的profile用于在打包时根据指定环境替换不同环境的配置文件配置,如数据库配置。Spri...

    用户84 评论0 收藏0
  • Spring Cloud Alibaba基础教程:Nacos配置的多环境管理

    摘要:第二步在应用的配置文件中,增加环境配置第三步启动应用,我们可以看到日志中打印了,加载的配置文件使用实现在中是用来对做集合管理的重要概念。深入思考上面我们分别利用配置管理功能中的几个不同纬度来实现多环境的配置管理。 前情回顾: 《Spring Cloud Alibaba基础教程:使用Nacos实现服务注册与发现》 《Spring Cloud Alibaba基础教程:支持的几种服务消费方...

    CNZPH 评论0 收藏0
  • Spring Boot 框架介绍和使用

    摘要:使用还是,根据个人喜好即可。如果错误页面也需要使用模板引擎动态生成,那么放在下面的路径。数据库自动配置嵌入式数据库如果类路径中包含或的相应包,那么就会自动配置这些嵌入式数据库的实例和数据源。 本文参考自Spring Boot文档。 Spring Boot 简介 Spring框架功能很强大,但是就算是一个很简单的项目,我们也要配置很多东西。因此就有了Spring Boot框架,它的作用很...

    Zack 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<