Spring：SmartLifecycle：Lifecycle.stop() 未調用<mvc:annotation-driven />但它與@EnableWebMvc

Question

當我使用 java 配置但不使用 XML 配置進行配置時，我無法弄清楚為什么在 Tomcat 中運行的簡單 Spring 5.1.12 webapp 調用 Lifecycle.stop() 方法。 我有實現 SmartLifecycle 的有問題的 bean LifecycleLoggingBean，並且我已經覆蓋了所有方法（請參閱問題結尾）。

更新：如果我在 mvc-servlet.xml 中實例化我的 LifecycleLoggingBean，則會調用停止。 我想默認情況下沒有什么能阻止主應用程序上下文。 是否有一種“正確”的方式來觸發關閉主應用程序上下文？ 事實證明，它也是從主應用程序上下文中調用的，只是沒有記錄。

如果我這樣配置應用程序，則會調用 Lifecycle.stop()：

@EnableWebMvc
@Configuration
@ComponentScan({"some.package"})
public class SpringConfig implements WebMvcConfigurer {

    @Bean
    public InternalResourceViewResolver viewResolver() {
        InternalResourceViewResolver viewResolver
                = new InternalResourceViewResolver();
        viewResolver.setViewClass(JstlView.class);
        viewResolver.setPrefix("/WEB-INF/views/");
        viewResolver.setSuffix(".jsp");
        return viewResolver;
    }
}

如果我刪除 class 並將以下內容放入 web.xml：

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

<servlet>
    <servlet-name>mvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>mvc</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

以及 applicationContext.xml 中的以下內容：

<context:component-scan base-package="some.package" />
<mvc:annotation-driven />

<bean class = "org.springframework.web.servlet.view.InternalResourceViewResolver">
   <property name = "prefix" value = "/WEB-INF/jsp/"/>
   <property name = "suffix" value = ".jsp"/>
</bean>

並添加一個 mvc-servlet.xml：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
            http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
            ">
</beans>

然后 Lifecycle.stop() 不會被調用。

在所有情況下，Lifecycle.start() 都會被調用。

這是帶有 Java 配置的日志：

[org.springframework.web.servlet.DispatcherServlet]:525  -  - Initializing Servlet 'dispatcher'
[some.packge.testapp.LifecycleLoggingBean]:15   -  - ********** SmartLifecycle isAutoStartup
[some.packge.testapp.LifecycleLoggingBean]:21   -  - ********** SmartLifecycle getPhase
[some.packge.testapp.LifecycleLoggingBean]:43   -  - ********** Lifecycle isRunning false
[some.packge.testapp.LifecycleLoggingBean]:15   -  - ********** SmartLifecycle isAutoStartup
[some.packge.testapp.LifecycleLoggingBean]:27   -  - ********** Lifecycle start
[org.springframework.web.servlet.DispatcherServlet]:547  -  - Completed initialization in 953 ms
[some.packge.testapp.LifecycleLoggingBean]:21   -  - ********** SmartLifecycle getPhase
[some.packge.testapp.LifecycleLoggingBean]:43   -  - ********** Lifecycle isRunning true
[some.packge.testapp.LifecycleLoggingBean]:32   -  - ********** SmartLifecycle stop
[some.packge.testapp.LifecycleLoggingBean]:39   -  - ********** Lifecycle stop

這是帶有 xml 配置的日志：

[org.springframework.web.context.ContextLoader]:271  -  - Root WebApplicationContext: initialization started
[some.package.testapp.LifecycleLoggingBean]:15   -  - ********** SmartLifecycle isAutoStartup
[some.package.testapp.LifecycleLoggingBean]:21   -  - ********** SmartLifecycle getPhase
[some.package.testapp.LifecycleLoggingBean]:43   -  - ********** Lifecycle isRunning false
[some.package.testapp.LifecycleLoggingBean]:15   -  - ********** SmartLifecycle isAutoStartup
[some.package.testapp.LifecycleLoggingBean]:27   -  - ********** Lifecycle start
[org.springframework.web.context.ContextLoader]:307  -  - Root WebApplicationContext initialized in 1203 ms
[org.springframework.web.servlet.DispatcherServlet]:525  -  - Initializing Servlet 'dispatcher'
[org.springframework.web.servlet.DispatcherServlet]:547  -  - Completed initialization in 31 ms
[org.springframework.web.servlet.DispatcherServlet]:525  -  - Initializing Servlet 'mvc'
[org.springframework.web.servlet.DispatcherServlet]:547  -  - Completed initialization in 31 ms

這是 LifecycleLoggingBean：

@Component
public class LifecycleLoggingBean implements SmartLifecycle {
    private final Logger logger = LoggerFactory.getLogger(LifecycleLoggingBean.class);
    @Override
    public boolean isAutoStartup() {
        logger.info("********** SmartLifecycle isAutoStartup");
        return true;
    }
    @Override
    public int getPhase() {
        // start last and stop first
        logger.info("********** SmartLifecycle getPhase");
        return Integer.MAX_VALUE;
    }
    private AtomicBoolean isRunning = new AtomicBoolean(false);
    @Override
    public void start() {
        logger.info("********** Lifecycle start");
        isRunning.set(true);
    }
    @Override
    public void stop(Runnable callback) {
        logger.info("********** SmartLifecycle stop");
        stop();
        callback.run();
    }
    @Override
    public void stop() {
        isRunning.set(false);
        logger.info("********** Lifecycle stop");
    }
    public boolean isRunning() {
        boolean rval = isRunning.get();
        logger.info("********** Lifecycle isRunning {}", rval);
        return rval;
    }
}

Answer 1

事實證明，stop() 方法也是從主應用程序上下文調用的，只是沒有記錄。 Log4j2 自動將自身注冊為 web 片段，這意味着它在調用 ContextLoaderListener 的 contextDestroyed 方法之前關閉。 當最終調用 contextDestroyed 時，日志消息將丟失。 但是，通過登錄到 System.out，我能夠在 tomcat 日志中看到消息。

通過禁用 log4j 的正常自動注冊並以舊的（servlet 2.5 及之前）方式注冊它，我能夠顯示日志消息。

<context-param>
    <param-name>isLog4jAutoInitializationDisabled</param-name>
    <param-value>true</param-value>
</context-param>

<listener>
    <listener-class>org.apache.logging.log4j.web.Log4jServletContextListener</listener-class>
</listener>

<filter>
    <filter-name>log4jServletFilter</filter-name>
    <filter-class>org.apache.logging.log4j.web.Log4jServletFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>log4jServletFilter</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>FORWARD</dispatcher>
    <dispatcher>INCLUDE</dispatcher>
    <dispatcher>ERROR</dispatcher>
    <!-- Servlet 3.0 w/ disabled auto-initialization only; not supported in 2.5 -->
    <dispatcher>ASYNC</dispatcher>
</filter-mapping>

這最終成為一個次優的解決方案，因為我們的日志記錄基礎設施依賴於使用Web Lookup ${web:servletContextName}，它似乎沒有在默認注冊之外進行初始化。 所以我們將使用@EventListener 而不是SmartLifecycle。

@EventListener(classes = {
        ContextStoppedEvent.class,
        ContextClosedEvent.class
})
public void stop() {
    // still get to clean up.
}

log4j 問題跟蹤器中有一個未解決的問題，正是描述了這個問題： https://issues.apache.org/jira/browse/LOG4J2-2624