源码解析tomcat回调springmvc servlet init方法的原理

小鱼儿 2023-10-08 22:01 5阅读 0赞

我们知道Springmvc启动时会创建并注册servlet，然后tomcat会扫描并回调servlet的init方法。

那么tomcat是如何回调springmvc生成的servlet的init方法的呢，具体细节和时机呢。

下面首先给出结论：Tomcat是调用自身的StandWrapper的initServlet方法，最终回调到springmvc的HttpServletBean的init方法=》 initServletBean方法

![34bce7d06fdb4673aefc6b4e05089132.png][]

![910a36f9b34841febcfc28167dcbf7cd.png][]

**这里需要搞清楚两件事：**

1. Springmvc生成的DispatcherServlet如何加载到Tomcat上下文

2. Tomcat如何回调DispatcherServlet的init方法

**备注：本文讲解的是springmvc xml零配置启动方式，也就是通过注解/编程方式实现springmvc启动，而不是传统的xml文件配置方式。**

**根据Servlet 3.0规范的要求： springmvc启动是会**查找META-INF/services/路径下**ServletContainerInitializer接口的实现类:** **SpringServletContainerInitializer**

![5828bdb1a77340ed9c6c152035f22b40.png][]

而SpringServletContainerInitializer执行的时候又会扫描所有WebApplicationInitializer

的实现类或子类 ，然后在SpringServletContainerInitializer的onStartup方法中执行

WebApplicationInitializer的实现类或子类的onStartup方法：

![59242b3468114216808e170794e35f71.png][]

![fad0d27a5d5c4e8ca35b8fc063595269.png][]

**所以springmvc真正的启动入口是：WebApplicationInitializer的onStartup方法：**

![d3b15e63032f435e9480cde056f1890c.png][]

选择onStartup接口的实现方法为： **AbstractDispatcherServletInitializer**

![4e493f28917e4abb8badd80cd3c5477b.png][]

继续跟进里面的**registerDispatcherServlet方法：**

![b9225740357b4e3585632c6cf27c6e3f.png][]

备注：super.onStartup方法是创建spingmvc的根容器也就是父容器，该容器提供dipatcherservlet运行所需要的service,Dao等Bean对象

![057a36f9226745c0aa17d97cb4228ea6.png][]

![f944f8da17894c258faae76516519682.png][]

**registerDispatcherServlet方法里面：**

**a. 创建了springmvc子容器：WebApplicationContext**

**b. 使用WebApplicationContext创建dispatcherServelet**

**c. 通过addServlet方法将dispatcherServelet添加到tomcat上下文**

![ddc1177b20324abe8ca1fa1b645cdb40.png][]

![cee3097a96384b06af8d900ff60182e0.png][]

以上完成了Springmvc生成的DispatcherServlet加载到Tomcat上下文这件事

**调用链路：**

WebApplicationInitializer：onStartup =》AbstractDispatcherServletInitializer：onStartup：registerDispatcherServlet =》registerDispatcherServlet：createDispatcherServlet =》FrameworkServlet： init => HttpServletBean: init

**深入拓展：addServlet方法具体是如何将servlet添加到tomcat上下文的？具体机制是什么？**

跟进servletContext.addServlet方法：

![16f92d6ebbba4cf6994d08ba12ae1f6e.png][]

这里进入的addServlet接口实现是**ApplicationContextFade，这里涉及到外观设计模式**

**外观（Facade）模式：**又称为门面模式，它定义了一个高层接口（即为多个子系统提供统一的门面），客户端与通过 **门面** 与子系统通信，使这些子系统更加容易被访问。

外部客户端**不关心内部子系统的具体细节**，这样大大降低应用程序的复杂度，提高了程序的可维护性。

简单来说就是：解耦，对外提供统一的接口，屏蔽内部的实现细节，客户端只与 **门面** 通信，通过 **门面** 来隐藏系统的复杂性，降低耦合度。

然后继续跟进**ApplicationContextFade的addServlet方法**

![bc548e962345452f90158b355ad14f0e.png][]

此时来到了外观模式背后**真正的实现者**：**ApplicationContext，接着继续跟进它的addServlet方法：**

![c675039472ae4023a7f2827c4622f29a.png][]

![c87b958ae7454cb98e4969dfb6603e75.png][]

这里发现：tomcat在添加servlet之前会首先查询一下：这个servlet对应的wrapper是否存在，

如果不存在，才会创建一个wrapper对象，并将servlet的名字传进去，然后通过addChild方法把这个新的wrapper添加到tomcat容器

**于是继续跟进addChild方法：**

![6fd33709714f486898ac15d078d956da.png][]

发现addChild方法会调用父类ContainerBase的addChild方法：

![465d2052b5554826bae555de6e865eaf.png][]

发现addChild=>addChildInternal=>最终走到了**children.put方法**，

**这里很像是将servlet添加到一个Map当中**

然后看一下这个children的定义，果然是一个HashMap，key就是servlet的名称

/**
         * The child Containers belonging to this Container, keyed by name.
         */
        protected final HashMap<String, Container> children = new HashMap<>();

**Tomcat的addServlet方法：实际就是将被添加的servlet对象包装成wrapper，然后存储到HashMap，key是原始servlet的名称，value是这个wrapper的实例**

**至此：Tomcat的addServlet方法就分析完毕了**

**备注：addChild(Container child)方法中入参child实际就是前面的Wrapper, 之所以可以归结到Container类，是因为Container是它的父接口，参考下面的类图继承关系就清楚了：**

![a23fc37d33f54fd98493f263533c860e.png][]

而下面一个问题又是如何完成的呢：

Tomcat如何回调DispatcherServlet的init方法

要搞清楚这个问题，需要参考我写的另外一篇文章：

[从tomcat源码分析它的启动流程是如何初始化servlet的][tomcat_servlet]

tomcat源码中ContainerBase的startInternal方法里面有个findChildren方法

![28806f97530f41fd9eee8f1f1723e854.png][]

![7576f2d581b843fdb0334ee229a9226c.png][]

![351f6c5a9a984e9f92abb06055e176ba.png][]

findChildren是找到Engine底下所有的嵌套容器：包括Host,Context, Wrapper等，因为Children是一个HashMap,key是容器名，而它的value就是容器实例。

**而StardardWrapper就是Wrapper的实现类，它定义的就是一个servlet容器：**

![3863377f9bf14f4d86fad12185760dab.png][]

根据之前的分析tomcat的addServlet方法会将dispatcherServlet所在的wrapper添加到children这个hashMap中，那么findChildren方法也必然能找到之前的那个dispatcherServlet所在的wrapper。

继续跟进findChildren后面的代码，可以发现：这里会遍历四层嵌套容器，并通过线程池启动他们的start方法 :

// Start our child containers, if any
            Container children[] = findChildren();
            List<Future<Void>> results = new ArrayList<>();
            for (Container child : children) {
                // 遍历四层嵌套容器，并通过线程池启动他们的start方法
                results.add(startStopExecutor.submit(new StartChild(child)));
    
       }

可以看到StartChild是一个Callable函数式接口的实现类，构造器参数就是Container实例，并重写了call方法，在该方法里面执行container容器的start方法。

![f7f102688eb145dcbfee67e6688a5066.png][]

而Wrapper是由它父级容器Context启动的，所以从加载的因果关系来看：我们应该先进入到Context的实现类StandardContext的start方法：

它的start方法执行会按照以下的模板方法套路：

自身start方法 =》 Lifecycle的start方法=》LifecycleBase的start方法=》 StandardContext的 startInternal方法

所以我们跳过这些重复的模板方法，直接进入StandardContext的 startInternal方法

而**StandardContext 作为**wrapper**的父容器会通过 startInternal方法层层调用=》loadOnStartup方法=》wrapper.load方法=》initServlet方法**

**最终调用到了initServlet方法，也就是调用到了Servlet的init方法：**

![1c4fdb2077b742ae8c007022b102455c.png][]

但是**Servlet（javax.servlet.Servlet）只是一个接口，根据下面的类图结构：**

**因为dispatcherServlet的类型实际是FrameworkSevlet, 调用init方法时最终会调用到它的父类**HttpServletBean的init方法，换句话说**tomcat最终应该调用到HttpServletBean的init方法**：

![bf89def5f0dc48d88611ebe021ecfb26.png][]

![5011364b850a4dedb50e7f8dc5b37f80.png][]

![c0e9a202d79f4ed6908f25d501203bc0.png][]而 HttpServletBean的init方法会最终调用到initServletBean方法

![b9063eb7eb1d45998482ab0dd6584882.png][]

**以下 断点调试也证明了：tomcat的StandardWrapper通过调用自身的initServlet方法，最终调用到了HttpServletBean的init方法**

![4721b5c061f243afb376dc4b84ccb4e0.png][]

**到此已经完整分析了：Springmvc启动时tomcat如何回调其Servlet init方法的原理**

[34bce7d06fdb4673aefc6b4e05089132.png]: https://img-blog.csdnimg.cn/34bce7d06fdb4673aefc6b4e05089132.png
[910a36f9b34841febcfc28167dcbf7cd.png]: https://img-blog.csdnimg.cn/910a36f9b34841febcfc28167dcbf7cd.png
[5828bdb1a77340ed9c6c152035f22b40.png]: https://img-blog.csdnimg.cn/5828bdb1a77340ed9c6c152035f22b40.png
[59242b3468114216808e170794e35f71.png]: https://img-blog.csdnimg.cn/59242b3468114216808e170794e35f71.png
[fad0d27a5d5c4e8ca35b8fc063595269.png]: https://img-blog.csdnimg.cn/fad0d27a5d5c4e8ca35b8fc063595269.png
[d3b15e63032f435e9480cde056f1890c.png]: https://img-blog.csdnimg.cn/d3b15e63032f435e9480cde056f1890c.png
[4e493f28917e4abb8badd80cd3c5477b.png]: https://img-blog.csdnimg.cn/4e493f28917e4abb8badd80cd3c5477b.png
[b9225740357b4e3585632c6cf27c6e3f.png]: https://img-blog.csdnimg.cn/b9225740357b4e3585632c6cf27c6e3f.png
[057a36f9226745c0aa17d97cb4228ea6.png]: https://img-blog.csdnimg.cn/057a36f9226745c0aa17d97cb4228ea6.png
[f944f8da17894c258faae76516519682.png]: https://img-blog.csdnimg.cn/f944f8da17894c258faae76516519682.png
[ddc1177b20324abe8ca1fa1b645cdb40.png]: https://img-blog.csdnimg.cn/ddc1177b20324abe8ca1fa1b645cdb40.png
[cee3097a96384b06af8d900ff60182e0.png]: https://img-blog.csdnimg.cn/cee3097a96384b06af8d900ff60182e0.png
[16f92d6ebbba4cf6994d08ba12ae1f6e.png]: https://img-blog.csdnimg.cn/16f92d6ebbba4cf6994d08ba12ae1f6e.png
[bc548e962345452f90158b355ad14f0e.png]: https://img-blog.csdnimg.cn/bc548e962345452f90158b355ad14f0e.png
[c675039472ae4023a7f2827c4622f29a.png]: https://img-blog.csdnimg.cn/c675039472ae4023a7f2827c4622f29a.png
[c87b958ae7454cb98e4969dfb6603e75.png]: https://img-blog.csdnimg.cn/c87b958ae7454cb98e4969dfb6603e75.png
[6fd33709714f486898ac15d078d956da.png]: https://img-blog.csdnimg.cn/6fd33709714f486898ac15d078d956da.png
[465d2052b5554826bae555de6e865eaf.png]: https://img-blog.csdnimg.cn/465d2052b5554826bae555de6e865eaf.png
[a23fc37d33f54fd98493f263533c860e.png]: https://img-blog.csdnimg.cn/a23fc37d33f54fd98493f263533c860e.png
[tomcat_servlet]: https://blog.csdn.net/jiaohuizhuang6019/article/details/129694839
[28806f97530f41fd9eee8f1f1723e854.png]: https://img-blog.csdnimg.cn/28806f97530f41fd9eee8f1f1723e854.png
[7576f2d581b843fdb0334ee229a9226c.png]: https://img-blog.csdnimg.cn/7576f2d581b843fdb0334ee229a9226c.png
[351f6c5a9a984e9f92abb06055e176ba.png]: https://img-blog.csdnimg.cn/351f6c5a9a984e9f92abb06055e176ba.png
[3863377f9bf14f4d86fad12185760dab.png]: https://img-blog.csdnimg.cn/3863377f9bf14f4d86fad12185760dab.png
[f7f102688eb145dcbfee67e6688a5066.png]: https://img-blog.csdnimg.cn/f7f102688eb145dcbfee67e6688a5066.png
[1c4fdb2077b742ae8c007022b102455c.png]: https://img-blog.csdnimg.cn/1c4fdb2077b742ae8c007022b102455c.png
[bf89def5f0dc48d88611ebe021ecfb26.png]: https://img-blog.csdnimg.cn/bf89def5f0dc48d88611ebe021ecfb26.png
[5011364b850a4dedb50e7f8dc5b37f80.png]: https://img-blog.csdnimg.cn/5011364b850a4dedb50e7f8dc5b37f80.png
[c0e9a202d79f4ed6908f25d501203bc0.png]: https://img-blog.csdnimg.cn/c0e9a202d79f4ed6908f25d501203bc0.png
[b9063eb7eb1d45998482ab0dd6584882.png]: https://img-blog.csdnimg.cn/b9063eb7eb1d45998482ab0dd6584882.png
[4721b5c061f243afb376dc4b84ccb4e0.png]: https://img-blog.csdnimg.cn/4721b5c061f243afb376dc4b84ccb4e0.png