Spring中SmartLifecycle和Lifecycle的作用和区别

2024-08-31 18:08
文章标签 java 作用 spring 区别 lifecycle smartlifecycle

本文主要是介绍Spring中SmartLifecycle和Lifecycle的作用和区别，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本文基于SpringBoot 2.5.0-M2讲解Spring中Lifecycle和SmartLifecycle的作用和区别，以及如何控制SmartLifecycle的优先级。
并讲解SpringBoot中如何通过SmartLifecycle来启动/停止web容器.

SmartLifecycle & Lifecycle作用和区别

SmartLifecycle和Lifecycle作用

  1. 都是让开发者可以在所有的bean都创建完成(getBean) 之后执行自己的初始化工作，或者在退出时执行资源销毁工作。

SmartLifecycle和Lifecycle区别

  1. SmartLifecycle接口继承Lifecycle接口，同时继承了org.springframework.context.Phased接口用于控制多个SmartLifecycle实现之间的优先级。
  2. 在SpringBoot应用中，或在Spring应用中没有调用AbstractApplicationContext#start方法，如果一个Bean只是实现了Lifecycle接口的情况下:
    • 不会执行Lifecycle接口中的启动方法，包括Lifecycle#isRunning方法也不会被执行。
    • 但是在应用 退出时 会执行Lifecycle#isRunning方法判断该Lifecycle是否已经启动，如果返回true则调用Lifecycle#stop()停止方法。
  3. 如果一个Bean实现了SmartLifecycle接口，则会执行启动方法。先会被根据Phased接口优先级分组，封装在LifecycleGroup，然后循环调用LifecycleGroup#start()方法，SmartLifecycle#isRunning判断是否已经执行，返回false表示还未执行，则调用SmartLifecycle#start()执行。Phased返回值越小，优先级越高。
  4. SmartLifecycle中还有个isAutoStartup方法，如果返回false，在启动时也不会执行start方法，默认返回true

源码分析

SmartLifecycle和Lifecycle都是在org.springframework.context.support.DefaultLifecycleProcessor中被调用，
DefaultLifecycleProcessor#onRefresh方法在执行AbstractApplicationContext#finishRefresh时会被调用，调用栈如下:

startBeans:142, DefaultLifecycleProcessor (org.springframework.context.support)
onRefresh:123, DefaultLifecycleProcessor (org.springframework.context.support)
finishRefresh:934, AbstractApplicationContext (org.springframework.context.support)
refresh:585, AbstractApplicationContext (org.springframework.context.support)
refresh:144, ServletWebServerApplicationContext (org.springframework.boot.web.servlet.context)
refresh:755, SpringApplication (org.springframework.boot)
refreshContext:426, SpringApplication (org.springframework.boot)
run:326, SpringApplication (org.springframework.boot)
run:1299, SpringApplication (org.springframework.boot)
run:1288, SpringApplication (org.springframework.boot)
main:31, DemoApplication (com.example.demo)

DefaultLifecycleProcessor#onRefresh源码:

@Override
public void onRefresh() {startBeans(true);  //autoStartupOnly = truethis.running = true;
}

DefaultLifecycleProcessor#startBeans源码如下:
autoStartupOnly 在onRefresh时传入的是true，表示只执行可以自动启动的bean，即为：SmartLifecycle的实现类，并且SmartLifecycle#isAutoStartup返回值必须为true。

private void startBeans(boolean autoStartupOnly) {Map<String, Lifecycle> lifecycleBeans = getLifecycleBeans();Map<Integer, LifecycleGroup> phases = new TreeMap<>();lifecycleBeans.forEach((beanName, bean) -> {if (!autoStartupOnly || (bean instanceof SmartLifecycle && ((SmartLifecycle) bean).isAutoStartup())) {int phase = getPhase(bean);phases.computeIfAbsent(phase, p -> new LifecycleGroup(phase, this.timeoutPerShutdownPhase, lifecycleBeans, autoStartupOnly)).add(beanName, bean);}});if (!phases.isEmpty()) {phases.values().forEach(LifecycleGroup::start);}
}

而Spring AbstractApplicationContext#doClose退出时，无论是SmartLifecycle或Lifecycle都会执行isRunning方法，判断是否已经启动，返回true表示已经启动，则执行SmartLifecycle或Lifecycle的stop方法。
源码见:org.springframework.context.support.DefaultLifecycleProcessor#doStop方法。

而执行AbstractApplicationContext#doClose一般是应用进程退出，通过jvm注册的钩子方法，或者应用程序编码调用。
AbstractApplicationContext#registerShutdownHook源码

@Override
public void registerShutdownHook() {if (this.shutdownHook == null) {// No shutdown hook registered yet.this.shutdownHook = new Thread(SHUTDOWN_HOOK_THREAD_NAME) {@Overridepublic void run() {synchronized (startupShutdownMonitor) {doClose();}}};Runtime.getRuntime().addShutdownHook(this.shutdownHook);}
}

自定义LifecycleProcessor处理Lifecycle

在源码分析中提到了DefaultLifecycleProcessor，其实现了LifecycleProcessor接口。然而我们自己也可以实现该接口，替换默认的DefaultLifecycleProcessor。SpringBoot中则是自己配置了DefaultLifecycleProcessor，我们可以按照同样的方式，覆盖默认的实现。例如可以让Lifecycle中的start()方法在onRefresh()时也能被执行。

org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration源码:

/*** {@link EnableAutoConfiguration Auto-configuration} relating to the application* context's lifecycle.** @author Andy Wilkinson* @since 2.3.0*/
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(LifecycleProperties.class)
public class LifecycleAutoConfiguration {@Bean(name = AbstractApplicationContext.LIFECYCLE_PROCESSOR_BEAN_NAME)@ConditionalOnMissingBean(name = AbstractApplicationContext.LIFECYCLE_PROCESSOR_BEAN_NAME,search = SearchStrategy.CURRENT)public DefaultLifecycleProcessor defaultLifecycleProcessor(LifecycleProperties properties) {DefaultLifecycleProcessor lifecycleProcessor = new DefaultLifecycleProcessor();lifecycleProcessor.setTimeoutPerShutdownPhase(properties.getTimeoutPerShutdownPhase().toMillis());return lifecycleProcessor;}
}

SpringBoot中内嵌web容器启动时机

SpringBoo中就是通过实现SmartLifecycle来启动内嵌的web容器，实现类为WebServerStartStopLifecycle。

ServletWebServerApplicationContext在onRefresh方法中调用createWebServer，createWebServer方法中创建org.springframework.boot.web.server.WebServer实例，该对象则包含了控制web容器(tomcat、jetty)的启动与停止方法。

@Override
protected void onRefresh() {super.onRefresh();try {createWebServer();}catch (Throwable ex) {throw new ApplicationContextException("Unable to start web server", ex);}
}

ServletWebServerApplicationContext#createWebServer源码:

private void createWebServer() {WebServer webServer = this.webServer;ServletContext servletContext = getServletContext();if (webServer == null && servletContext == null) {StartupStep createWebServer = this.getApplicationStartup().start("spring.boot.webserver.create");ServletWebServerFactory factory = getWebServerFactory();createWebServer.tag("factory", factory.getClass().toString());this.webServer = factory.getWebServer(getSelfInitializer());createWebServer.end();getBeanFactory().registerSingleton("webServerGracefulShutdown",new WebServerGracefulShutdownLifecycle(this.webServer));getBeanFactory().registerSingleton("webServerStartStop",new WebServerStartStopLifecycle(this, this.webServer));}else if (servletContext != null) {try {getSelfInitializer().onStartup(servletContext);}catch (ServletException ex) {throw new ApplicationContextException("Cannot initialize servlet context", ex);}}initPropertySources();
}

createWebServer方法会将创建的webServer封装在WebServerStartStopLifecycle对象中，并注册到Spring容器中。

org.springframework.boot.web.servlet.context.WebServerStartStopLifecycle源码如下:

class WebServerStartStopLifecycle implements SmartLifecycle {private final ServletWebServerApplicationContext applicationContext;private final WebServer webServer;private volatile boolean running;WebServerStartStopLifecycle(ServletWebServerApplicationContext applicationContext, WebServer webServer) {this.applicationContext = applicationContext;this.webServer = webServer;}@Overridepublic void start() {this.webServer.start();this.running = true;this.applicationContext.publishEvent(new ServletWebServerInitializedEvent(this.webServer, this.applicationContext));}@Overridepublic void stop() {  this.webServer.stop();   }@Overridepublic boolean isRunning() {	return this.running;  }@Overridepublic int getPhase() {    return Integer.MAX_VALUE - 1;  }
}

WebServerStartStopLifecycle则实现了SmartLifecycle接口，当Spring回调到SmartLifecycle接口方法时则调用this.webServer.start();启动web容器，web容器启动完成之后会通过applicationContext发布ServletWebServerInitializedEvent事件，表示web容器启动成功，可以接收http请求。

和SmartInitializingSingleton区别

相同点：SmartInitializingSingleton和Lifecycle、SmartLifecycle都是在所有的单实例bean创建(getBean方法)之后执行。

不同点：

  1. SmartInitializingSingleton优先于Lifecycle、SmartLifecycle执行。
  2. SmartInitializingSingleton只有一个afterSingletonsInstantiated方法。而Lifecycle有start,stop,isRunning等方法。
  3. 多个SmartInitializingSingleton实现之间无法排序控制执行的顺序，而SmartLifecycle实现了Phased接口，可以通过int getPhase()控制执行循序。
  4. SmartInitializingSingleton之间可以通过@DependsOn来控制执行顺序，但这是由Spring中@DependsOn注解的作用及原理来实现的. 并不是对SmartInitializingSingleton做了排序。

这篇关于Spring中SmartLifecycle和Lifecycle的作用和区别的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1124620。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
在cscode中通过maven创建java项目

在cscode中通过maven创建java项目

在cscode中创建java项目 可以通过博客完成maven的导入 建立maven项目 使用快捷键 Ctrl + Shift + P 建立一个 Maven 项目 1 Ctrl + Shift + P 打开输入框2 输入 "> java create"3 选择 maven4 选择 No Archetype5 输入 域名6 输入项目名称7 建立一个文件目录存放项目，文件名一般为项目名8 确定
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2