ServletContextListener的流程笔记

在之前我们学习springboot的时候大概的讲过启动tomcat的过程。说到tomcat也就是servlet容器的问题，至于今天所说的ServletContextListener其实有很多的联系。也就是说ServletServletContextListener其实是在tomcat启动后调用的。

我们看一下这个接口的方法：

public interface ServletContextListener extends EventListener {


    public default void contextInitialized(ServletContextEvent sce) {
    }


    public default void contextDestroyed(ServletContextEvent sce) {
    }
}

这么写直接写貌似不太友好，我们直接写demo吧

public class MyServletContextListener implements ServletContextListener {


    public void contextInitialized(ServletContextEvent sce) {
        System.out.println(sce.toString());
        System.out.println("--------wo de 初始化");
    }


    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println(sce.toString());
        System.out.println("--------emmm....wo死了。。。");
    }
}

@Configuration
public class MyServletConfig {
    /**
     * 初始化一个servlet监听器
     * @return servlet监听器注册器
     */
    @Bean
    public ServletListenerRegistrationBean servletListenerRegistrationBean(){
        ServletListenerRegistrationBean servletListenerRegistrationBean=new ServletListenerRegistrationBean();
        servletListenerRegistrationBean.setListener(new MyServletContextListener());
        return servletListenerRegistrationBean;
    }
}

启动和停止的效果如下：

功能是实现了，而且我们了解这块是在tomcat启动的时候进行初始化，并在tomcat停机的时候销毁的。Spring又是如何与这ServletContextListener 结合的，tomcat如何找到这ServletContextListener 。带着疑问我们定位到tomcat启动时候的server.start()方法。

        我们一路找到启动的方法，发现这块的过滤器也是在此进行初始化的。

我们重点看一下listerner的初始化

//获取所有的监听器
                Object instances[] = getApplicationLifecycleListeners();
        if (instances == null || instances.length == 0) {
            return ok;
        }




        ServletContextEvent event = new ServletContextEvent(getServletContext());
        ServletContextEvent tldEvent = null;
        if (noPluggabilityListeners.size() > 0) {
            noPluggabilityServletContext = new NoPluggabilityServletContext(getServletContext());
            tldEvent = new ServletContextEvent(noPluggabilityServletContext);
        }
        for (Object instance : instances) {
            if (!(instance instanceof ServletContextListener)) {
                continue;
            }
            ServletContextListener listener = (ServletContextListener) instance;
            try {
                fireContainerEvent("beforeContextInitialized", listener);
                if (noPluggabilityListeners.contains(listener)) {
                    listener.contextInitialized(tldEvent);
                } else {
                    listener.contextInitialized(event);
                }
                fireContainerEvent("afterContextInitialized", listener);
            } catch (Throwable t) {
                ExceptionUtils.handleThrowable(t);
                fireContainerEvent("afterContextInitialized", listener);
                getLogger().error(sm.getString("standardContext.listenerStart",
                        instance.getClass().getName()), t);
                ok = false;
            }
        }
        return ok;

        我们发现我们的applicationContext就包括了我们的listener

    而上层调用我们的serveletlistener是谁？我们在装配到spring上下文的时候是registerBean，那么肯定和这个类具有很大的关系。我们一直跟踪。

        发现在tomcat启动的时候会将将所有的register传入，并执行onstarter方法，而每个register都自带了其listerner之类的子成员。所以操作起来也没有任何问题。

        我们一路跟踪，寻找我们得beanregister是如何传入到tomcat得启动代码中。

我们继续向上查看。

        在创建tomcat服务端得时候，会将initializer作为参数传入。而这里得initializer就是我们得ServletListenerRegistrationBean注册器，作为spring上下文得子类，可以获取到注册到ioc中得得任何对象。所以这块我们就明白了其与spring得整合原理。因为其本身就是spring得一部分。

        之所以和tomcat发生了关系，是因为我们在初始化得时候将spring注册得这些servletcontextlistener、filter等等当作参数去初始化tomcat，这就完成了从spring得bean到servlet容器得一般过程。

        上边分析了很多，大概得过程就是那样。这里再小结一下：我们通过@Bean注解将我们得servletlistener、filter等注册到spring容器中，但是在tomcat初始化的时候将这些servlet容器需要的类通过beanfactory拿到并作为参数去初始化tomcat。从而完成bean的管理在spring中，而具体使用在tomcat中。ServletContextListener的用处还是比较广泛的，因为很多时候我们需要在项目启动之前做一些事情，或者在项目停止之后做一些事情，而且这些事情是专门针对servlet容器的这种应用。现在想一下有那些场景呐？比如说我们做一些异步的监控，那么我们可以采用ServletContextListener 去创建定时任务线程然后去收集一些数据，当然这只是一种方式，我们也可以采用springapplicationlisenter的事件监听器都可以做。好了，文章就写这里了。

安了~