【Spring Boot 3】应用启动执行特定逻辑
【Spring Boot 3】应用启动执行特定逻辑
- 背景
- 介绍
- 开发环境
- 开发步骤及源码
- 工程目录结构
- 总结
背景
软件开发是一门实践性科学,对大多数人来说,学习一种新技术不是一开始就去深究其原理,而是先从做出一个可工作的DEMO入手。但在我个人学习和工作经历中,每次学习新技术总是要花费或多或少的时间、检索不止一篇资料才能得出一个可工作的DEMO,这占用了我大量的时间精力。因此本文旨在通过一篇文章即能还原出可工作的、甚至可用于生产的DEMO,期望初学者能尽快地迈过0到1的这一步骤,并在此基础上不断深化对相关知识的理解。
为达以上目的,本文会将开发环境、工程目录结构、开发步骤及源码尽量全面地展现出来,文字描述能简则简,能用代码注释的绝不在正文中再啰嗦一遍,正文仅对必要且关键的信息做重点描述。
介绍
日常开发中有一些代码逻辑是需要在应用启动时自动执行的,譬如加载自定义的初始化配置,本文介绍开发Spring Boot应用常用的五种方法:
- 实现
org.springframework.boot.ApplicationRunner
接口run
方法; - 实现
org.springframework.boot.CommandLineRunner
接口run
方法; - 实现
org.springframework.beans.factory.InitializingBean
接口afterPropertiesSet
方法; - 使用
jakarta.annotation.PostConstruct
注解; - 使用
org.springframework.scheduling.annotation.Scheduled
注解,设置initialDelay
。
执行顺序:
ApplicationRunner
和CommandLineRunner
接口是在Spring Boot应用程序启动后回调的接口,因此需要等待启动完成后才能执行的逻辑要使用这两种方法实现;@PostConstruct
在Bean初始化之前执行,InitializingBean
的afterPropertiesSet
方法在Bean属性初始化后执行,他们只与当前Bean相关,并不会等到应用完全启动完成,因此他们的执行要早于ApplicationRunner
和CommandLineRunner
;@Scheduled
也不依赖于应用完全启动,通过设置initialDelay
延迟执行时间可以尽量确保在应用完全启动后执行,但这种方法用得较少。- 默认情况下
ApplicationRunner
的执行在CommandLineRunner
之前,通过org.springframework.boot.SpringApplication
的callRunner