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

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

前言

在使用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定义如下:


public interface Lifecycle {
    void start();
    void stop();
    boolean isRunning();
}

自定义Lifecycle实现类

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

@Component
public class MyLifeCycle implements Lifecycle {
    /**
     * 运行状态
     */
    private volatile boolean running = false;
    /**
     * 容器启动后调用
     */
    @Override
    public void start() {
        System.out.println("容器启动后执行MyLifeCycle操作...");
        running = true;
    }
    /**
     * 容器停止时调用
     */
    @Override
    public void stop() {
        System.out.println("收到关闭容器的信号MyLifeCycle操作...");
        running = false;
    }
    /**
     * 检查此组件是否正在运行。
     * 1. 只有该方法返回false时,start方法才会被执行。
     * 2. 只有该方法返回true时,stop(Runnable callback)或stop()方法才会被执行。
     */
    @Override
    public boolean isRunning() {
        System.out.println("检查MyLifeCycle组件的运行状态:" + running);
        return running;
    }
}

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


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

1

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


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


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


SmartLifecycle

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


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


public interface SmartLifecycle extends Lifecycle, Phased {
    int DEFAULT_PHASE = 2147483647;
    default boolean isAutoStartup() {
        return true;
    }
    default void stop(Runnable callback) {
        this.stop();
        callback.run();
    }
    default int getPhase() {
        return 2147483647;
    }
}

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

来看一下实例代码:

@Component
public class MySmartLifecycle implements SmartLifecycle {
    private volatile boolean running = false;
    /**
     * 如果该`Lifecycle`类所在的上下文在调用`refresh`时,希望能够自己自动进行回调,则返回`true`,
     * false的值表明组件打算通过显式的start()调用来启动,类似于普通的Lifecycle实现。
     */
    @Override
    public boolean isAutoStartup() {
        return true;
    }
    /**
     * SmartLifecycle子类的才有的方法,当isRunning方法返回true时,该方法才会被调用。
     * 很多框架中的源码中,都会把真正逻辑写在stop()方法内。
     * 比如quartz和Redis的spring支持包。
     */
    @Override
    public void stop(Runnable callback) {
        System.out.println("MySmartLifecycle容器停止,执行回调函数");
        stop();
        // 如果你让isRunning返回true,需要执行stop这个方法,那么就不要忘记调用callback.run()。
        // 否则在程序退出时,Spring的DefaultLifecycleProcessor会认为这个MySmartLifecycle没有stop完成,程序会一直卡着结束不了,等待一定时间(默认超时时间30秒)后才会自动结束。
        callback.run();
    }
    /**
     * 1. 主要在该方法中启动任务或者其他异步服务,比如开启MQ接收消息<br/>
     * 2. 当上下文被刷新(所有对象已被实例化和初始化之后)时,将调用该方法,
     * 默认生命周期处理器将检查每个SmartLifecycle对象的isAutoStartup()方法返回的布尔值。
     * 如果为“true”,则该方法会被调用,而不是等待显式调用自己的start()方法。
     */
    @Override
    public void start() {
        System.out.println("MySmartLifecycle容器启动完成 ...");
        running = true;
    }
    /**
     * 接口Lifecycle子类的方法,只有非SmartLifecycle的子类才会执行该方法。<br/>
     * 1. 该方法只对直接实现接口Lifecycle的类才起作用,对实现SmartLifecycle接口的类无效。<br/>
     * 2. 方法stop()和方法stop(Runnable callback)的区别只在于,后者是SmartLifecycle子类的专属。
     */
    @Override
    public void stop() {
        System.out.println("MySmartLifecycle容器停止 ...");
        running = false;
    }
    /**
     * 1. 只有该方法返回false时,start方法才会被执行。<br/>
     * 2. 只有该方法返回true时,stop(Runnable callback)或stop()方法才会被执行。
     */
    @Override
    public boolean isRunning() {
        System.out.println("MySmartLifecycle检查运行状态 ...");
        return running;
    }
    /**
     * 如果有多个实现接口SmartLifecycle的类,则这些类的start的执行顺序按getPhase方法返回值从小到大执行。<br/>
     * 例如:1比2先执行,-1比0先执行。stop方法的执行顺序则相反,getPhase返回值较大类的stop方法先被调用,小的后被调用。
     *
     */
    @Override
    public int getPhase() {
        return 0;
    }
}

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


MySmartLifecycle检查运行状态 ...

MySmartLifecycle容器启动完成 ...

1

2

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


MySmartLifecycle检查运行状态 ...

MySmartLifecycle容器停止,执行回调函数

MySmartLifecycle容器停止 ...

1

2

3

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


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


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


小结

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




目录
相关文章
|
4月前
|
XML 前端开发 Java
Spring Boot中怎么使用BPMN
在Spring Boot中集成BPMN工作流,如Camunda,能实现业务流程自动化。以请假流程为例,步骤包括:创建Spring Boot项目并添加Camunda依赖;使用Camunda Modeler设计请假流程,涵盖提交申请、经理审批、HR记录及流程完成阶段;保存BPMN文件至`src/main/resources`目录,以便Camunda自动部署;实现流程逻辑,如通过REST API启动流程实例,并传递请假请求数据。整个过程展示了BPMN流程从设计到部署的完整周期,使业务流程自动化变得高效且直接。 **注意:**摘要已压缩至240字符内,部分内容被省略。
262 2
Spring Boot中怎么使用BPMN
|
5月前
|
Java Spring 容器
Spring中的SmartLifecycle与Lifecycle
Spring中的SmartLifecycle与Lifecycle
104 0
Spring Security 为啥是个垃圾框架?
免责声明~ 任何文章不要过度深思! 万事万物都经不起审视,因为世上没有同样的成长环境,也没有同样的认知水平,更「没有适用于所有人的解决方案」; 不要急着评判文章列出的观点,只需代入其中,适度审视一番自己即可,能「跳脱出来从外人的角度看看现在的自己处在什么样的阶段」才不为俗人。 怎么想、怎么做,全在乎自己「不断实践中寻找适合自己的大道」
|
安全 NoSQL Java
spring security为啥是个垃圾框架?
spring security为啥是个垃圾框架?
126 0
|
Java Spring
Spring5源码 - 07 Spring Bean 生命周期流程 源码解读02
Spring5源码 - 07 Spring Bean 生命周期流程 源码解读02
86 0
|
Java Spring 容器
Spring5源码 - 11 Spring事件监听机制_源码篇
Spring5源码 - 11 Spring事件监听机制_源码篇
105 0
|
XML Java 数据格式
Spring官网阅读(九)Spring中Bean的生命周期(上)(2)
Spring官网阅读(九)Spring中Bean的生命周期(上)(2)
108 0
Spring官网阅读(九)Spring中Bean的生命周期(上)(2)
|
XML Java 数据格式
Spring官网阅读(九)Spring中Bean的生命周期(上)(1)
Spring官网阅读(九)Spring中Bean的生命周期(上)(1)
70 0
Spring官网阅读(九)Spring中Bean的生命周期(上)(1)
|
缓存 Java Spring
Spring官网阅读(十)Spring中Bean的生命周期(下)
在上篇文章中,我们已经对Bean的生命周期做了简单的介绍,主要介绍了整个生命周期中的初始化阶段以及基于容器启动停止时LifeCycleBean的回调机制,另外对Bean的销毁过程也做了简单介绍。但是对于整个Bean的生命周期,这还只是一小部分,在这篇文章中,我们将学习完成剩下部分的学习,同时对之前的内容做一次复习。整个Bean的生命周期,按照我们之前的介绍,可以分为四部分 实例化 属性注入 初始化 销毁
70 0
Spring官网阅读(十)Spring中Bean的生命周期(下)
|
XML Java 数据格式
Spring-Lifecycle的使用
小杰在前面的文章讲过可以使用 `@PostConstruct`、`InitializingBean `等等方式来处理 Bean 的初始化和销毁,上述这些操作是属于 Bean 生命周期的。
817 0
下一篇
无影云桌面