文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

Spring的Lifecycle和SmartLifecycle,可以没用过,但不能不知道!

2024-12-03 04:14

关注

前言

在使用Spring的过程中,我们通常会用@PostConstruct和@PreDestroy在Bean初始化或销毁时执行一些操作,这些操作属于Bean声明周期级别的。

那么,就存在一些遗漏的场景,比如我们想在容器本身的生命周期(比如容器启动、停止)的事件上做一些工作,很典型的就是Spring Boot中启动内嵌的Web容器。该怎么办?

这就需要用到Spring提供的另外一个接口Lifecycle。这篇文件就介绍一下Lifecycle接口,以及比它更聪明(Smart)的SmartLifecycle。

Lifecycle接口

Lifecycle是一个接口,它的作用是让开发者可以在所有的bean都创建完成(getBean)之后执行自己的初始化工作,或者在退出时执行资源销毁工作。

Lifecycle定义了三个方法,任何Bean实现了Lifecycle方法,当ApplicationContext收到start、stop和restart等信号时,就会调用对应的方法。因此可以通过实现Lifecycle接口获得容器生命周期的回调,实现业务扩展。

LifeCycle定义如下:

  1. public interface Lifecycle { 
  2.  
  3.     void start(); 
  4.  
  5.     void stop(); 
  6.  
  7.     boolean isRunning(); 

自定义Lifecycle实现类

首先我们来自定义一个类,实现Lifecycle接口,来看看具体的实践效果:

  1. @Component 
  2. public class MyLifeCycle implements Lifecycle { 
  3.  
  4.      
  5.     private volatile boolean running = false
  6.  
  7.      
  8.     @Override 
  9.     public void start() { 
  10.         System.out.println("容器启动后执行MyLifeCycle操作..."); 
  11.         running = true
  12.     } 
  13.  
  14.      
  15.     @Override 
  16.     public void stop() { 
  17.         System.out.println("收到关闭容器的信号MyLifeCycle操作..."); 
  18.         running = false
  19.     } 
  20.  
  21.      
  22.     @Override 
  23.     public boolean isRunning() { 
  24.         System.out.println("检查MyLifeCycle组件的运行状态:" + running); 
  25.         return running; 
  26.     } 

单纯的将上述代码添加的Spring Boot项目当中,你会发现启动时并没有打印出任何相关的日志,只有在关闭应用时会打印出:

  1. 检查MyLifeCycle组件的运行状态:false 

这是因为,在SpringBoot或Spring应用中如果没有调用AbstractApplicationContext#start方法,只是实现了Lifecycle接口,是不会执行Lifecycle接口中的启动方法和isRunning方法的。但在应用退出时会执行Lifecycle#isRunning方法判断该Lifecycle是否已经启动,如果返回true则调用Lifecycle#stop()停止方法。

这个实例有一个很明显的问题,那就是需要使用者显式的调用容器的start()和stop()方法,Lifecycle的接口方法才会被执行。

而在一般的项目中,我们很少这样显式的去调用,所以就需要一个更“聪明”的类来处理,这就是SmartLifecycle。

SmartLifecycle

SmartLifecycle继承自Lifecycle,提供了更丰富的功能:第一,start()方法无需容器显式调用就可以被执行;第二,可以控制多SmartLifecycle实例的执行顺序。

先来看一下SmartLifecycle接口的源码:

  1. public interface SmartLifecycle extends Lifecycle, Phased { 
  2.     int DEFAULT_PHASE = 2147483647; 
  3.  
  4.     default boolean isAutoStartup() { 
  5.         return true
  6.     } 
  7.  
  8.     default void stop(Runnable callback) { 
  9.         this.stop(); 
  10.         callback.run(); 
  11.     } 
  12.  
  13.     default int getPhase() { 
  14.         return 2147483647; 
  15.     } 

可以看出该接口除了继承Lifecycle接口外,还继承了Phased。其中getPhase方法便是来自Phased。也正是基于Phased接口的这个方法来控制SmartLifecycle的执行顺序的。

来看一下实例代码:

  1. @Component 
  2. public class MySmartLifecycle implements SmartLifecycle { 
  3.  
  4.     private volatile boolean running = false
  5.  
  6.      
  7.     @Override 
  8.     public boolean isAutoStartup() { 
  9.         return true
  10.     } 
  11.  
  12.      
  13.     @Override 
  14.     public void stop(Runnable callback) { 
  15.         System.out.println("MySmartLifecycle容器停止,执行回调函数"); 
  16.         stop(); 
  17.         // 如果你让isRunning返回true,需要执行stop这个方法,那么就不要忘记调用callback.run()。 
  18.         // 否则在程序退出时,Spring的DefaultLifecycleProcessor会认为这个MySmartLifecycle没有stop完成,程序会一直卡着结束不了,等待一定时间(默认超时时间30秒)后才会自动结束。 
  19.         callback.run(); 
  20.     } 
  21.  
  22.      
  23.     @Override 
  24.     public void start() { 
  25.         System.out.println("MySmartLifecycle容器启动完成 ..."); 
  26.         running = true
  27.     } 
  28.  
  29.      
  30.     @Override 
  31.     public void stop() { 
  32.         System.out.println("MySmartLifecycle容器停止 ..."); 
  33.         running = false
  34.     } 
  35.  
  36.      
  37.     @Override 
  38.     public boolean isRunning() { 
  39.         System.out.println("MySmartLifecycle检查运行状态 ..."); 
  40.         return running; 
  41.     } 
  42.  
  43.      
  44.     @Override 
  45.     public int getPhase() { 
  46.         return 0; 
  47.     } 

关于每个方法的功能,注释部分已经明确说明了,下面启动SpringBoot项目,打印日志如下:

  1. MySmartLifecycle检查运行状态 ... 
  2. MySmartLifecycle容器启动完成 ... 

关闭SpringBoot项目,打印日志如下:

  1. MySmartLifecycle检查运行状态 ... 
  2. MySmartLifecycle容器停止,执行回调函数 
  3. MySmartLifecycle容器停止 ... 

通过上述实例可以看出:如果一个Bean实现了SmartLifecycle接口,则会执行启动方法。SmartLifecycle#isRunning判断是否已经执行,返回false表示还未执行,则调用SmartLifecycle#start()执行。

当关闭时,同样先检查运行状态,如果正在运行,则执行关闭操作。关闭时,还可以处理对应的回调函数。

其中,Phased返回值越小,优先级越高。

小结

 

当需要基于Spring容器的生命周期来处理一些逻辑时,通常可以实现SmartLifecycle接口来完成。像Spring Cloud,Spring Boot中都有大量的实践案例。所以,无论实战或阅读源码,不了解Lifecycle相关接口,都是一种损失。本文的产生也是在遇到Spring Cloud集成Nacos的源码中获得的灵感。

 

来源:程序新视界内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯