Spring Boot 配置文件启动加载顺序

news2024/12/27 16:37:15

前言

Spring Boot的启动加载顺序是一个涉及多个步骤和组件的过程。Spring Boot通过一系列默认设置简化了应用程序的配置,使得开发者能够快速地搭建和部署应用。为了实现这一目标,Spring Boot采用了一种分层和优先级机制来加载配置文件。

一、Spring Boot 配置文件的加载顺序

1)bootstrap.properties 或 bootstrap.yml (如果存在)

application.properties 或 application.yml

2)命令行参数

3)操作系统环境变量

4)从 RandomValuePropertySource 生成的 random.* 属性

5)由 @TestPropertySource 注解声明的属性

6)由 @SpringBootTest 注解并且 #properties 注解属性的测试属性

7)由 SpringBootApplication 注解的 exclude 属性排除的自动配置的类

8)由应用程序的 RandomValuePropertySource 生成的 random.* 属性

9)在 application.properties 或 application.yml 中使用 SpringApplication 的 setDefaultProperties 方法设置的属性

这个加载顺序是有意为此的,因为有些属性需要在后续加载的时候覆盖前面的同名属性。

这里是一个简单的例子,演示如何使用 bootstrap.properties 来配置一些在 Spring Boot 启动时需要的属性:

 bootstrap.properties

# bootstrap.properties
spring.application.name=myapp
spring.profiles.active=prod

或者 application.yml: 

# application.yml
server:
  port: 8080

命令行参数可以用于覆盖特定的属性,例如: 

java -jar myapp.jar --server.port=9090

 二、在Spring Boot中,配置文件的加载顺序遵循以下步骤

  1. 自动加载:Spring Boot在启动时会扫描特定位置的配置文件。这些位置包括jar包内的classpath路径、当前项目的根目录以及桌面上的文件路径。Spring Boot会优先加载高优先级的配置文件,并在低优先级配置文件被加载时覆盖掉冲突的属性。
  2. 自定义配置文件:开发者可以通过spring.config.name属性指定自定义配置文件名。Spring Boot会按照以下顺序查找这些配置文件:application.和application-default.,并根据扩展名的优先级进行加载。扩展名包括:.properties、.xml、.yml、.yaml。
  3. 命令行参数:开发者可以在命令行中指定一些参数来覆盖默认的配置值。这些参数将优先于任何其他配置文件中的值生效。
  4. 环境变量:环境变量也可以用来覆盖配置文件中的属性值。这些变量在应用程序启动时自动加载,无需额外操作。
  5. 属性占位符:在配置文件中,可以使用${...}语法来引用其他属性的值。这种方式可以创建依赖关系,使得某些属性在其他属性被解析后才能确定其值。
  6. 自动配置类:Spring Boot提供了一系列的自动配置类,可以根据项目需求自动配置一些组件。开发者可以通过禁用特定的自动配置类或自定义自动配置类来覆盖默认设置。
  7. 条件注解:Spring Boot允许使用条件注解来控制特定组件的创建。例如,只有当某个属性存在或满足特定条件时,某个bean才会被创建。
  8. 外部化配置:Spring Boot支持将部分配置移动到外部属性文件中,以提高可维护性和复用性。这些外部属性文件可以包含在jar包内部、当前项目根目录或其他指定位置。

总结来说,Spring Boot的配置加载顺序遵循以下原则:优先从高优先级的源加载配置,并在低优先级源加载时覆盖冲突的属性;开发者可以通过自定义配置文件、命令行参数和环境变量来覆盖默认值;自动配置类和条件注解允许更灵活地控制组件的创建;而外部化配置则提高了应用程序的维护性和复用性。了解这个加载顺序有助于更好地管理和优化Spring Boot应用程序的配置。

关键步骤划分的Spring Boot启动加载顺序的概述: 

三、启动准备阶段

  1. 装载核心启动器类:org.springframework.boot.SpringApplication
  2. 通过构造函数创建SpringApplication实例时,进行一系列的初始化工作。

四、配置加载阶段

  • Spring Boot项目会按照特定的顺序加载配置文件,这些配置文件可以是application.properties或application.yml格式。

配置文件的加载顺序(优先级由高到低):

  1. file:./config/(项目根路径下的config文件夹)
  2. file:./(项目根路径)
  3. classpath:/config/(类路径下的config文件夹)
  4. classpath:/(类路径)

外部配置文件的加载方式:

  1. 命令行参数:可以直接在启动命令后添加启动参数。
  2. spring.config.location:用于指定配置文件的新位置。

如果多个文件有相同的key,高优先级的值会覆盖低优先级的值。

五、上下文准备阶段

  • 准备并刷新应用上下文(Context)。
  • 加载所有的初始化器(如从META-INF/spring.factories配置文件中加载的)。
  • 加载所有的监听器(也是从META-INF/spring.factories配置文件中加载的)。

六、启动执行阶段

  • 触发所有CommandLineRunner执行。
  • 执行自定义的初始化逻辑(如果有的话)。

七、完成阶段

  • 启动完成,等待退出。

注意

  • 带profile的配置文件(如application-dev.yml)通常具有比不带profile的配置文件(如application.yml)更高的优先级。

代码演示,项目启动成功后执行一段初始化逻辑:

八、启动main方法中添加初始化逻辑

在Spring Boot的main入口启动方法中,执行SpringApplication.run(LimitApplication.class, args)是可以返回ApplicationContext对象的,我们可以从ApplicationContext中获取指定的bean对象,执行初始化逻辑。

@SpringBootApplication(scanBasePackages = {"com.xinda.springbootday01.service"})
public class OrderApplication {

    public static void main(String[] args){
        //启动的run方法
        ApplicationContext context =  SpringApplication.run(OrderApplication.class, args);

        //启动执行操作:从context中获取指定的bean,调度初始化逻辑
        OrderService orderService = (OrderService)context.getBean("OrderServiceImpl");
        orderService.preLoadCache();
    }

}

初始化逻辑: 

@Service
public class OrderServiceImpl implements OrderService {
    @Override
    public void preLoadCache(){
        System.out.println("应用启动完成:开始执行缓存预加载操作");
    }
}

九、实现ApplicationRunner或CommandLineRunner接口

在Spring Boot框架中,给我们提供了ApplicationRunner和CommandLineRunner接口来帮助我们解决项目启动后的初始化资源操作。
如果有多个ApplicationRunner、CommandLineRunner的实现类,可以通过@Order注解进行排序,参数值小的先执行。

实现CommandLineRunner接口:

@Order(1)
@Component
@Slf4j
public class CommandLineRunnerImpl implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("应用启动完成,开始执行CommandLineRunner方法完成资源初始化");
    }
}

实现ApplicationRunner接口:

@Order(2)
@Component
@Slf4j
public class ApplicationRunnerImpl implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("应用启动完成,开始执行ApplicationRunner方法完成资源初始化");
    }
}

源码分析:
在SpringApplication的run方法中,有这么一段核心代码

public ConfigurableApplicationContext run(String... args) {
        long startTime = System.nanoTime();
        DefaultBootstrapContext bootstrapContext = this.createBootstrapContext();
        ConfigurableApplicationContext context = null;
        this.configureHeadlessProperty();
        SpringApplicationRunListeners listeners = this.getRunListeners(args);
        listeners.starting(bootstrapContext, this.mainApplicationClass);

        try {
            ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
            ConfigurableEnvironment environment = this.prepareEnvironment(listeners, bootstrapContext, applicationArguments);
            this.configureIgnoreBeanInfo(environment);
            Banner printedBanner = this.printBanner(environment);
            context = this.createApplicationContext();
            context.setApplicationStartup(this.applicationStartup);
            this.prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
            this.refreshContext(context);
            this.afterRefresh(context, applicationArguments);
            Duration timeTakenToStartup = Duration.ofNanos(System.nanoTime() - startTime);
            if (this.logStartupInfo) {
                (new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), timeTakenToStartup);
            }

            listeners.started(context, timeTakenToStartup);
            this.callRunners(context, applicationArguments);
        } catch (Throwable var12) {
            this.handleRunFailure(context, var12, listeners);
            throw new IllegalStateException(var12);
        }

        try {
            Duration timeTakenToReady = Duration.ofNanos(System.nanoTime() - startTime);
            listeners.ready(context, timeTakenToReady);
            return context;
        } catch (Throwable var11) {
            this.handleRunFailure(context, var11, (SpringApplicationRunListeners)null);
            throw new IllegalStateException(var11);
        }
    }

十、ApplicationListener监听启动完成事件

通过源码,我们发现在Spring Boot启动过程中,框架内部定义了很多事件SpringApplicationEvent,用来通知SpringApplicationRunListeners监听器,以针对各种事件执行对应的逻辑处理。而Spring Boot启动完成的事件对应的是ApplicationStartedEvent,我们可以通过自定义监听器来监听ApplicationStartedEvent事件,然后执行初始化资源的相关操作。

@Component
class StartedEventListener implements ApplicationListener<ApplicationStartedEvent> {
    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        System.out.println("应用启动完成,通知监听器执行缓存预加载操作");
    }
}

总结

Spring Boot支持两种类型的配置文件:application.properties和application.yml。当同一个目录下同时存在这两种类型的配置文件时,application.properties会优先加载,但两种文件会进行互补配置。即,如果同一配置项在两个配置文件中都进行了设置,那么application.properties中的配置会覆盖application.yml中的配置。

除了上述默认的配置文件加载位置外,Spring Boot还支持多种外部配置方式,它们的优先级从高到低如下:

1)命令行参数:通过java -jar命令启动应用时,可以在命令后附加–配置项=值的形式来指定配置。

2)来自java:comp/env的JNDI属性。

3)Java系统属性(System.getProperties())。

4)操作系统环境变量。

5)RandomValuePropertySource配置的random.*属性值:用于生成随机值。

6)jar包外部的带profile的配置文件(如application-{profile}.properties或application-{profile}.yml)。

7)jar包内部的带profile的配置文件。

8)jar包外部的不带profile的配置文件(如application.properties或application.yml)。

9)jar包内部的不带profile的配置文件。

(由jar包外向jar包内进行寻找,优先加载带profile的,再加载不带profile的。)

10)@Configuration注解类上的@PropertySource。

11)通过SpringApplication.setDefaultProperties指定的默认属性。

另外,可以通过spring.config.location属性来改变默认的配置文件位置。

在项目打包后,可以使用命令行参数的形式来指定配置文件的新位置,指定的配置文件和默认加载的配置文件会共同起作用,形成互补配置。

当使用多环境配置时(如开发、测试、生产环境),可以通过激活不同的profiles来加载对应的配置文件。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2234537.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

C# Modbus RTU通讯回顾

涉及技术&#xff1a; 1.使用NMdbus4 库 2.ushort[]转int 记得之前刚学习的时候&#xff0c;是ushort[] → Hex字符串→byte[] → 翻转byte[] →BitConverter.ToInt32()&#xff0c;饶了一大圈&#xff1b;实际上可以直接转&#xff1b;这里也有小细节&#xff1a;使用BitCo…

HFSS学习笔记(五)金属过孔、复制模型带激励等问题(持续更新...)

HFSS学习笔记&#xff08;五&#xff09;金属过孔、复制模型带激励等问题&#xff08;持续更新…&#xff09; 一、金属过孔设计 方法一&#xff1a;用介质减去金属圆柱体&#xff0c;然后再添加金属圆柱体 方法二&#xff1a;嵌入金属圆柱 圆柱过孔选择材料为“copper” HFS…

Late Chunking×Milvus:如何提高RAG准确率

01. 背景 在RAG应用开发中&#xff0c;第一步就是对于文档进行chunking&#xff08;分块&#xff09;&#xff0c;高效的文档分块&#xff0c;可以有效的提高后续的召回内容的准确性。而对于如何高效的分块是个讨论的热点&#xff0c;有诸如固定大小分块&#xff0c;随机大小分…

大屏可视化:舞动数据与美观的“设计秘籍”

大屏可视化鉴赏&#xff1a;踏入软件系统产品设计之旅&#xff0c;让我们一同鉴赏那些闪耀在智慧农业、智慧园区、智慧社区及智慧港口等领域的大屏可视化杰作。每一帧画面&#xff0c;都是科技与创新的完美融合&#xff0c;数据跃然屏上&#xff0c;智慧触手可及。 >> 数…

基于STM32的智能声音跟随小车设计

引言 本项目基于STM32微控制器设计了一个智能声音跟随小车&#xff0c;通过集成麦克风阵列实现声音源定位和跟随功能。该系统可以检测环境中的声音信号&#xff0c;如手掌拍击声或语音指令&#xff0c;驱动小车向声源方向移动。项目涉及硬件设计、声音信号处理算法以及电机控制…

Bruno解决SSL验证问题

在测试接口的时候&#xff0c;我使用的是Bruno这个软件&#xff0c;开源离线的API测试软件。 主页是这样子的 今天在测试一个HTTPS的接口时候&#xff0c;因为这个HTTPS接口是用的是自签证书&#xff0c;所以就报错误了。 Error invoking remote method send-http-request: …

【论文速读】| APOLLO:一种基于 GPT 的用于检测钓鱼邮件并生成警告用户的解释的工具

基本信息 原文标题&#xff1a;APOLLO: A GPT-based tool to detect phishing emails and generate explanations that warn users 原文作者&#xff1a;Giuseppe Desolda, Francesco Greco, Luca Vigan 作者单位&#xff1a;University of Bari “A. Moro”, Italy, King’…

jfrog artifactory oss社区版,不支持php composer私库

一、docker安装 安装环境&#xff1a;centos操作系统&#xff0c;root用户。 如果是mac或ubuntu等操作系统的话&#xff0c;会有许多安装的坑等着你。 一切都是徒劳&#xff0c;安装折腾那么久&#xff0c;最后还是不能使用。这就是写本文的初衷&#xff0c;切勿入坑就对了。 …

WindowsDocker安装到D盘,C盘太占用空间了。

Windows安装 Docker Desktop的时候,默认位置是安装在C盘,使用Docker下载的镜像文件也是保存在C盘,如果对Docker使用评率比较高的小伙伴,可能C盘空间,会被耗尽,有没有一种办法可以将Docker安装到其它磁盘,同时Docker的数据文件也保存在其他磁盘呢? 答案是有的,我们可以…

vue常见题型(1-10)

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 2.2双向绑定的原理是什么vue框架采用的是数据双向绑定的方式&#xff0c;由三个重要部分构成2.2.1.ViewModel2.2.2 双向绑定2.2.3.1.编译Compile2.2.3.2.依赖收集 3…

python怎么将字符串转换为数字

python如何将列表中的字符串转为数字&#xff1f;具体方法如下&#xff1a; 有一个数字字符的列表&#xff1a; numbers [1, 5, 10, 8] 想要把每个元素转换为数字&#xff1a; numbers [1, 5, 10, 8] 用一个循环来解决&#xff1a; new_numbers []; for n in numbers:new_n…

大数据新视界 -- 大数据大厂之 Impala 性能优化:解锁大数据分析的速度密码(上)(1/30)

&#x1f496;&#x1f496;&#x1f496;亲爱的朋友们&#xff0c;热烈欢迎你们来到 青云交的博客&#xff01;能与你们在此邂逅&#xff0c;我满心欢喜&#xff0c;深感无比荣幸。在这个瞬息万变的时代&#xff0c;我们每个人都在苦苦追寻一处能让心灵安然栖息的港湾。而 我的…

Flutter 插件 sliding_up_panel 实现从底部滑出的面板

前言 sliding_up_panel 是一个 Flutter 插件&#xff0c;用于实现从底部滑出的面板。它在设计上非常灵活&#xff0c;能够适应多种 UI 场景&#xff0c;比如从底部滑出的菜单、可拖动的弹出面板等。以下是 sliding_up_panel 的详细用法&#xff0c;包括常用的参数说明和示例代…

大客户营销数字销售实战讲师培训讲师唐兴通专家人工智能大模型销售客户开发AI大数据挑战式销售顾问式销售专业销售向高层销售业绩增长创新

唐兴通 销售增长策略专家、数字销售实战导师 专注帮助企业构建面向AI数字时代新销售体系&#xff0c;擅长运用数字化工具重塑销售流程&#xff0c;提升销售业绩。作为《挑战式销售》译者&#xff0c;将全球顶尖销售理论大师马修狄克逊等理论导入中国销售业界。 核心专长&…

es数据同步(仅供自己参考)

数据同步的问题分析&#xff1a; 当MySQL进行增删改查的时候&#xff0c;数据库的数据有所改变&#xff0c;这个时候需要修改es中的索引库的值&#xff0c;这个时候就涉及到了数据同步的问题 解决方法&#xff1a; 1、同步方法&#xff1a; 当服务对MySQL进行增删改的时候&…

入门车载以太网(3) -- 网络层

目录 1. 网络通信示例 2. IP地址类别 3. IP数据报 4. 小结 今天继续车载以太网&#xff0c;聊聊网络层。 1. 网络通信示例 我们首先回顾车载以太网的数据传输模型。 从7层开始(车载以太网模糊了5-7层&#xff0c;统称应用层)&#xff0c;每个中间层都为上层提供功能&…

六个核桃斥资千万研究脑健康,核桃健脑作用科学具象化了

健康&#xff0c;是这两年热度居高不下的社会话题。对健康的追求影响了诸多领域的发展&#xff0c;上至尖端科研&#xff0c;下至日常接触的食品饮料&#xff0c;都已被卷入大势。 其中&#xff0c;“脑健康”这个听起来更前沿的话题&#xff0c;又已经成为格外重要的一个领域…

基于Multisim光控夜灯LED电路(含仿真和报告)

【全套资料.zip】光控夜灯LED电路设计Multisim仿真设计数字电子技术 文章目录 功能一、Multisim仿真源文件二、原理文档报告资料下载【Multisim仿真报告讲解视频.zip】 功能 1.采用纯数字电路&#xff0c;非单片机。 2.通过检测周围光线&#xff0c;光线暗且有声音时自动开灯…

【go从零单排】go中的基本数据类型和变量

Don’t worry , just coding! 内耗与overthinking只会削弱你的精力&#xff0c;虚度你的光阴&#xff0c;每天迈出一小步&#xff0c;回头时发现已经走了很远。 基本类型 go中的string、int、folat都可以用连接boolen可以用逻辑表达式计算 package mainimport "fmt&quo…

前端学习笔记—Vue3特性

一、 Vue3与Vite构建工具简介 image.png image.png image.png image.png Vite构建工具&#xff08;其他的打包工具有webpack&#xff0c;grunt&#xff0c;gulp&#xff09; image.png image.png 构建 二、创建Vue3项目 vite在TypeScript结合使用上&#xff0c;直接开箱即用&am…