当前位置: 首页 > news >正文

Spring Boot 钩子全集实战(一):构造与配置阶段

Spring Boot 钩子全集实战(一):构造与配置阶段

在使用 Spring Boot 时,我们通常这样启动一个应用:

@SpringBootApplication public class DemoApplication { public static void void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } }

看起来简洁明了,对吧?但在这短短几行代码背后,Spring Boot 其实悄悄为我们预留了多个“钩子”,这些扩展点允许我们在应用启动的不同阶段注入自定义逻辑。

接下来,我将推出一个系列文章,带你系统掌握 Spring Boot 各个阶段的钩子机制。今天是第一篇:构造与配置阶段,通俗易懂、代码可运行!

一、什么是“构造与配置阶段”?

简单来说,就是你创建SpringApplication对象到执行run方法之前的这段时间。

这个阶段的关键特点是:还没有真正启动 Spring 容器!

二、该阶段的有哪些钩子?

在这一阶段,我们主要通过配置SpringApplication实例来注入自定义行为,常见钩子有:

钩子方法类型作用
addInitializers(...)方法调用手动添加ApplicationContextInitializer,用于在容器刷新前修改上下文
addListeners(...)方法调用手动添加ApplicationListener,监听 Spring 事件
setXXX(...)系列方法调用设置主类、Banner 模式、Web 类型等

三、 应用场景 + 代码示例

1.addInitializers(...)

应用场景
  • 在 Spring 容器刷新(refresh)之前,对ApplicationContext进行自定义配置,比如设置环境变量、注册自定义 Bean 定义、修改上下文的属性源等。
  • 适用于需要在容器初始化早期注入全局配置的场景,例如多环境配置增强、自定义属性加载、权限相关的上下文初始化等。
代码示例
importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.context.ApplicationContextInitializer;importorg.springframework.context.ConfigurableApplicationContext;importorg.springframework.core.env.ConfigurableEnvironment;@SpringBootApplicationpublicclassDemoApplication{publicstaticvoidmain(String[]args){SpringApplicationapplication=newSpringApplication(DemoApplication.class);// 自定义 ApplicationContextInitializerApplicationContextInitializer<ConfigurableApplicationContext>customInitializer=context->{// 获取环境配置ConfigurableEnvironmentenvironment=context.getEnvironment();// 新增自定义环境变量environment.getSystemProperties().put("custom.app.name","SpringHookDemo");// 打印初始化日志System.out.println("ApplicationContext 初始化前:添加自定义环境变量 custom.app.name");};// 添加初始化器(钩子方法)application.addInitializers(customInitializer);// 启动应用ConfigurableApplicationContextcontext=application.run(args);// 验证:获取并打印自定义变量StringappName=context.getEnvironment().getProperty("custom.app.name");System.out.println("启动后获取的自定义变量:"+appName);}}
执行结果
ApplicationContext 初始化前:添加自定义环境变量 custom.app.name 启动后获取的自定义变量:SpringHookDemo

2.addListeners(...)

应用场景
  • 监听 Spring Boot 生命周期中的核心事件(如ApplicationStartedEventApplicationReadyEventApplicationFailedEvent等),实现自定义的事件响应逻辑。
  • 典型场景:应用启动成功后发送通知(邮件 / 钉钉)、启动失败时记录告警日志、监听上下文刷新事件做数据预热等。
代码示例
importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.context.ApplicationListener;importorg.springframework.boot.context.event.ApplicationStartedEvent;importorg.springframework.boot.context.event.ApplicationReadyEvent;@SpringBootApplicationpublicclassDemoApplication{publicstaticvoidmain(String[]args){SpringApplicationapplication=newSpringApplication(DemoApplication.class);// 监听应用启动事件(Started:容器已启动,但未处理请求)ApplicationListener<ApplicationStartedEvent>startedListener=event->{System.out.println("事件监听:应用已启动(Started),开始初始化业务数据...");// 模拟:初始化缓存、加载字典数据等};// 监听应用就绪事件(Ready:可处理请求)ApplicationListener<ApplicationReadyEvent>readyListener=event->{System.out.println("事件监听:应用已就绪(Ready),发送启动成功通知...");// 模拟:调用通知接口、记录启动日志等};// 添加事件监听器(钩子方法)application.addListeners(startedListener,readyListener);// 启动应用application.run(args);}}
执行结果
事件监听:应用已启动(Started),开始初始化业务数据... 事件监听:应用已就绪(Ready),发送启动成功通知...

3.setXXX(...)系列方法

应用场景
  • setMainApplicationClass(Class<?> mainApplicationClass):手动指定应用主类(默认自动识别,特殊场景下需显式指定);
  • setBannerMode(Banner.Mode mode):控制启动 Banner 的显示(关闭 / 控制台 / 日志文件);
  • setWebApplicationType(WebApplicationType type):指定应用的 Web 类型(NONE:非 Web 应用、SERVLET:Servlet 容器、REACTIVE:响应式 Web);
  • setAdditionalProfiles(String... profiles):设置额外的激活配置文件(如测试 / 生产环境)。
代码示例(常用 set 方法组合)
importorg.springframework.boot.SpringApplication;importorg.springframework.boot.WebApplicationType;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.boot.Banner;@SpringBootApplicationpublicclassDemoApplication{publicstaticvoidmain(String[]args){SpringApplicationapplication=newSpringApplication(DemoApplication.class);// 1. 关闭启动 Bannerapplication.setBannerMode(Banner.Mode.OFF);// 2. 指定为非 Web 应用(即使引入 Web 依赖,也不会启动 Tomcat 等容器)application.setWebApplicationType(WebApplicationType.NONE);// 3. 激活 test 配置文件application.setAdditionalProfiles("test");// 4. 手动指定主类(可选,默认自动识别)application.setMainApplicationClass(DemoApplication.class);// 启动应用application.run(args);System.out.println("非 Web 应用启动完成,激活的配置文件:test");}}
执行结果
非 Web 应用启动完成,激活的配置文件:test

(注:启动时不会显示 Spring Boot 的默认 Banner,也不会启动 Tomcat 容器)

四、总结

  1. addInitializers核心作用是容器刷新前修改上下文,适用于早期全局配置注入;
  2. addListeners用于监听 Spring 事件,实现启动 / 运行阶段的自定义响应逻辑;
  3. setXXX系列是配置 SpringApplication 核心属性,覆盖 Banner、Web 类型、配置文件等基础行为。

这些钩子均在SpringApplication.run()执行前调用

📌关注我,每天5分钟,带你从 Java 小白变身编程高手!
👉 点赞 + 关注+转发,让更多小伙伴一起进步!

👉 私信"SpringBoot钩子源码" 获取源码!

http://www.cnnetsun.cn/news/54542.html

相关文章:

  • 【Java毕设全套源码+文档】基于springboot的电影院订票信息管理系统设计与实现(丰富项目+远程调试+讲解+定制)
  • Unity反向遮罩黑科技:彻底颠覆传统UI设计思维
  • 3大技巧玩转Equalizer APO:从入门到精通的音频增强终极指南
  • 10分钟精通AMD处理器调试:SMU工具的完整使用指南
  • GridPlayer终极指南:轻松实现多视频同步播放的免费神器
  • 如何用OneMore插件实现终极笔记管理:开源免费的效率神器
  • Bilibili-Evolved终极评测:从基础体验到专业玩家的全面升级指南
  • ubuntu常用命令
  • wvp-GB28181-pro国标视频平台完整使用教程:从零搭建到实战应用
  • 终极指南:LXMusic音源全面解析与使用技巧
  • GridPlayer:免费开源的多视频网格播放器终极解决方案
  • Terraria地图编辑器终极使用指南:5步轻松打造完美游戏世界
  • iStore插件中心终极指南:5步轻松搞定OpenWRT插件安装与管理
  • OneMore插件:让OneNote效率提升10倍的神器
  • 终极指南:快速上手轻量级文本转语音引擎eSpeak NG
  • 云顶之弈智能挂机助手:解放双手的自动化游戏神器
  • 图像分割标注转换:从入门到精通的全方位指南
  • 3步精通Draw.io Mermaid插件:小白也能快速上手的文本转图表神器
  • 12.14周报
  • 3分钟掌握Easy-Scraper:零基础网页数据抓取神器
  • 飞书文档批量导出终极指南:告别手动烦恼,实现高效迁移
  • SuperCom串口调试工具:终极免费解决方案与5分钟快速部署指南
  • Vulkan显存检测利器:memtest_vulkan快速验证显卡稳定性
  • 揭秘BlenderGIS:5分钟搞定专业级地形生成的秘密武器
  • 终极Mac桌面歌词神器LyricsX完整使用指南
  • TranslucentTB中文版下载安装保姆级教程(附安装包,非常详细)
  • 3分钟轻松退出Windows Insider计划:OfflineInsiderEnroll离线工具完全指南
  • 为什么需要多智能体?
  • openMES制造执行系统:5步快速部署完整指南
  • 万元级旗舰值不值?三星三折叠价格和功能深度拆解