0

0

SpringBoot怎么通过Profile实现不同环境下的配置切换

王林

王林

发布时间:2023-05-10 19:16:04

|

2055人浏览过

|

来源于亿速云

转载

springboot 通过 profile 实现在不同环境下的配置切换,比如常见的开发环境、测试环境、生产环境。

SpringBoot 常用配置文件主要有 2 种:properties 文件和 yml 文件。对于 properties 文件来说,主要通过多 profile 配置文件的方式来实现;对于 yml 文件来说,主要通过多片段的方式来实现(在一个 yml 文件中通过 3 个横杠来划分配置片段)。

Profile 在实际工作中使用比较方便,SpringBoot 程序开发好后,最终会打包成 jar 包进行使用,我们可以把配置文件放在外部,在外部的配置文件中指定 profile 名称,从而决定采用哪种环境(开发环境、测试环境、生产环境)的配置参数。

一、搭建工程

本篇博客的 Demo 搭建了 2 个 SpringBoot 工程,分别展示 2 种 profile 的使用方式。

Demo1 通过多个 properties 文件来实现,Demo2 通过单个 yml 文件来实现,搭建结果如下所示:

SpringBoot怎么通过Profile实现不同环境下的配置切换

对于 SpringBoot 来说,如果编写的类,在启动类所在的包或子包下时,那么就不需要再启动类上配置扫描包了,因为 SpringBoot 默认情况下就会扫描启动类所在的包及其子包下所有的类文件中的注解。因此为了演示方便,后续的 Demo 都在启动类所在的包或子包下编写类文件。

在两个 Demo 中都编写了相同代码的 TestController 类,用于提供无参数接口访问,返回的结果是当前所启用的 profile 名称和 profile 配置文件中配置的端口号,方便大家在进行 Demo 测试时进行验证结果,其实也可以直接看 IDEA 控制台中打印的信息进行验证结果。下面列出 TestController 类的具体内容:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @Autowired
    private Environment env;

    @RequestMapping("/getport")
    public String getPort()
    {
        StringBuilder sb = new StringBuilder();

        String[] activeProfiles = env.getActiveProfiles();
        sb.append("启动的 profile 名称为:").append(activeProfiles[0]);

        sb.append("
"); String portValue = env.getProperty("server.port"); sb.append("启动的端口为:").append(portValue); return sb.toString(); } }

二、多文件配置方式

Demo1 中的 SpringBoot 程序采用 properties 文件作为配置文件,因此采用多文件的配置方式实现 profile 。

SpringBoot 的配置文件,必须以 application 开头,对于 properties 文件来说,采用 application-profile名称.properties 的命名形式实现 profile 多环境配置,在 Demo1 中使用了 application-dev.properties ,application-test.properites ,application-pro.properties 三个文件来代表开发环境、测试环境、生产环境的配置文件,配置内容分别如下,为了方便,这里仅仅配置 SpringBoot 的启动端口来进行演示:

# application-dev.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 dev 表示 profile 配置文件的名称
server.port=8081
# application-test.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 test 表示 profile 配置文件的名称
server.port=8082
# application-pro.properties 配置内容
# 配置文件必须以 application 开头
# 后面的 pro 表示 profile 配置文件的名称
server.port=8083

要想使用具体的一种 profile 配置文件,需要在 application.properties 进行配置 profile 名称:

# application-pro.properties 配置内容
# 本 Demo 中编写了多个以 application 开头的配置文件
# 通过以下配置项指定 profile 名称,设置所要启动的配置文件
spring.profiles.active=test

然后启动 Demo1 的 SpringBoot 程序,如上面的例子采用的是 profile 是 test ,对应的启动端口是 8082 ,因此访问 TestController 中提供的 localhost:8082/getport 接口,即可对 profile 配置信息进行验证。

三、多片段配置方式

Demo2 中的 SpringBoot 程序采用 yml 文件作为配置文件,因此采用多片段的配置方式实现 profile 。

HTTPie AI
HTTPie AI

AI API开发工具

下载

在 application.yml 中采用三个横杠(---)来分隔配置片段,如下所示:

# 本 Demo 中只编写了一个 application.yml 的配置文件
# 通过三个横杠(---)来分隔开 3 种配置文件
# 通过 spring.config.activate.on-profile 设置 profile 的名称

# 通过以下配置项指定 profile 名称,设置所要启动的配置文件
spring:
  profiles:
    active: pro
---
server:
  port: 9091

spring:
  config:
    activate:
      on-profile: dev
---
server:
  port: 9092

spring:
  config:
    activate:
      on-profile: test
---
server:
  port: 9093

spring:
  config:
    activate:
      on-profile: pro

然后启动 Demo2 的 SpringBoot 程序,如以上的例子中采用的 profile 是 pro,对应的启动端口是 9093 ,因此访问 TestController 中提供的 localhost:9093/getport 接口,即可对 profile 配置信息进行验证。

四、使用外部配置文件

SpringBoot 程序开发好之后,会连同配置文件一起打包成 jar 包,导致无法更改配置文件。因此我们可以将配置文件复制一份到外部,与 jar 包放在一起,采用命令行启动 SpringBoot 程序,并通过命令行参数(--spring.config.location)指定所使用的外部配置文件路径。在外部配置文件中可以修改 profile 配置,实现不同环境下配置的切换。

我们将 Demo1 打包的 jar 包和配置文件,放在 d:\javacode\demo1 文件夹中,如下图所示:

SpringBoot怎么通过Profile实现不同环境下的配置切换

然后在此目录下运行以下命令行,启动 SpringBoot 程序:

D:\javacode\demo1> java -jar .\demo1-0.0.1-SNAPSHOT.jar --spring.config.location=.\application.properties

由于在 application.properties 中配置的 profile 是 test ,因此启动的是 8082 端口。

我们将 Demo2 打包的 jar 包和配置文件,放在 d:\javacode\demo2 文件夹中,如下图所示:

SpringBoot怎么通过Profile实现不同环境下的配置切换

然后在此目录下运行以下命令行,启动 SpringBoot 程序:

D:\javacode\demo2> java -jar .\demo2-0.0.1-SNAPSHOT.jar --spring.config.location=.\application.yml

由于在 application.yml 中配置的 profile 是 pro,因此启动的是 9093 端口。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

98

2025.08.06

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

989

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

50

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

200

2025.12.29

location.assign
location.assign

在前端开发中,我们经常需要使用JavaScript来控制页面的跳转和数据的传递。location.assign就是JavaScript中常用的一个跳转方法。通过location.assign,我们可以在当前窗口或者iframe中加载一个新的URL地址,并且可以保存旧页面的历史记录。php中文网为大家带来了location.assign的相关知识、以及相关文章等内容,供大家免费下载使用。

224

2023.06.27

idea快捷键大全
idea快捷键大全

本专题为大家提供idea快捷键相关的文章,帮助大家解决问题。

162

2023.08.03

idea如何集成Tomcat
idea如何集成Tomcat

idea集成Tomcat的步骤:1、添加Tomcat服务器配置;2、配置项目部署;3、运行Tomcat服务器;4、访问项目;5、注意事项;6、关闭Tomcat服务器。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

164

2024.02.23

idea怎么配置maven
idea怎么配置maven

idea配置maven的步骤:1、打开intellij idea,并确保已安装maven integration插件,可以在"file"菜单中选择"settings",然后在"plugins"选项卡中搜索并安装maven integration插件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

116

2024.02.23

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

0

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Redis6入门到精通超详细教程
Redis6入门到精通超详细教程

共47课时 | 5.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号