springboot3.1.4前war包部署内存泄漏问题

前言

springboot3.1.4在2023-09-21release了，查看release note中一个bug fix引起了我的注意，查看这个oom问题的过程发现和我之前的文章springboot2.5日志系统的设计缺陷有关

• 这个问题说明了springboot3.1.0-3.1.3打包传统war包放在独立的tomcat中运行的话，会有内存泄漏的问题，war包反复部署卸载几次可能就会触发oom

https://github.com/spring-projects/spring-boot/issues/37096

• 问题原因是每部署一次war包启动就会增加一个shutdownHook的匿名类对象Runtime.getRuntime().addShutdownHook(new Thread(this, "SpringApplicationShutdownHook"));

springboot3.1.4之前的正常逻辑

springboot注册jvm ShutdownHook的过程和日志系统handler注册过程

• springboot启动spring容器过程如下，在refreshContext中完成jvm shutdownHook的注册

  
  

• 根据registerShutdownHook参数决定是否注册jvm shutdownHook，该参数受spring.register-shutdown-hook控制，默认true

  
  

• 将SpringApplicationShutdownHook注册到jvm shutdownhook的过程如下

  
  

• SpringApplicationShutdownHook执行过程如下，先关闭spring容器context，再串行执行handler里的所有额外注册的action(关闭日志系统的逻辑就是其中的一个action)

  
  
• 注册日志系统关闭逻辑到SpringApplicationShutdownHook的过程如下

REGISTER_SHUTDOWN_HOOK_PROPERTY(logging.register-shutdown-hook)控制是否注册，默认为true
可以看到，调用SpringApplication.getShutdownHandlers().add()方法，就是直接加入了SpringApplicationShutdownHook中handler对象的Set<Runnable> actions中

springboot打包成war的特殊配置

官方文档：https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto.traditional-deployment

• 使用springboot打war包的前提是启动类一定要继承SpringBootServletInitializer，该类中会直接设置registerShutdownHook为false，也就不会将SpringApplicationShutdownHook注册jvm shutdownHook

  
  

总结一下

• spring.register-shutdown-hook参数设置registerShutdownHook，是控制springboot的SpringApplicationShutdownHook是否注册到jvm shutdownHook的总开关
• logging.register-shutdown-hook是控制日志系统关闭逻辑注册到SpringApplicationShutdownHook的action的开关
• spring.register-shutdown-hook为false时，其他组件注册到SpringApplicationShutdownHook的action也没有意义
• 打war包时spring.register-shutdown-hook参数无效，SpringBootServletInitializer直接设置registerShutdownHook设置为false

springboot3.1.0-3.1.3的war包部署内存泄漏问题原因

• https://github.com/spring-projects/spring-boot/issues/34627 中做的优化造成了该问题
• 这个优化说的是，如果有用户在某些bean的初始化逻辑中调用了SpringApplication.getShutdownHandlers().add()添加了自己的逻辑，这些逻辑在某些场景不会被执行的问题
• 如果springboot启动的refreshContext完成前jvm就关闭(可以再回上面看下springboot启动spring容器的过程)，此时可能还没有将SpringApplicationShutdownHook注册到jvm shutdownHook中，所以就不会执行了
• 这个优化的实现如下，在SpringApplication.getShutdownHandlers().add()中直接调用了addRuntimeShutdownHookIfNecessary，相当于调用add就会将SpringApplicationShutdownHook注册jvm shutdownHook，不再受registerShutdownHook参数控制

https://github.com/spring-projects/spring-boot/commit/28b7c583a9944e98046133fdc353a44d86f7580c

• 聪明的你看到这里可能已经感觉不对劲了，这样修改后只要调用SpringApplication.getShutdownHandlers().add()就会直接注册jvm shutdownHook，如果把一个war包在tomcat中来回部署/卸载，shutdownHook的匿名类对象就会越来越多造成oom
• 不幸的是logging.register-shutdown-hook在springboot2.5之后就默认true了(详见前文springboot2.5日志系统的设计缺陷)，所以一定会调用SpringApplication.getShutdownHandlers().add()注册日志的关闭逻辑

修复方式

• 将logging.register-shutdown-hook设置为false并且保证自己代码中不调用SpringApplication.getShutdownHandlers().add()就可以，不过如果用了异步日志appender可能在程序关闭时丢日志
• springboot3.1.4修复如下，非常简单，只要在addRuntimeShutdownHookIfNecessary方法中也增加对registerShutdownHook参数的判断就可以和之前逻辑保持一致

https://github.com/spring-projects/spring-boot/commit/c187bd928a407c9fe9025953e98946a3c1baa2f4