SpringMVC源码分析之——Spring容器和SpringMVC子容器的启动

三个容器:

1. servletContext  tomcat的servlet容器
2. AnnotationConfigWebApplicationContext spring上下文
3. AnnotationConfigWebApplicationContext springmvc上下文

总流程梳理：

1. tomcat的spi调到META-INF/services/javax.servlet.ServletContainerInitializer文件中的ServletContainerInitializer子类
    spring-web提供的类是 SpringServletContainerInitializer
2. 并且会调到SpringServletContainerInitializer的onStartup方法
    该类上有@HandlesTypes,注解值为WebApplicationInitializer的class对象,
    onStartup参数中会传入WebApplicationInitializer类型的class对象集合
    反射实例化这些类,调用他们的onStartup(servletContext)
    
    主要调用以下类:
        AbstractContextLoaderInitializer
        AbstractDispatcherServletInitializer
    
    2.1. AbstractContextLoaderInitializer.onStartup(servletContext)
        2.1.1. 创建spring上下文
            1. 钩子方法,获取有@mapperScan的类,主要扫描非@Controller的bean
            2. new AnnotationConfigWebApplicationContext(传入上面获取的类)
            
        2.1.2 注册ContextLoaderListener监听器,根据servlet规范,会调用监听器的contextInitialized方法
            1. 调用spring上下文的.onRfresh()，启动该容器

    2.2 AbstractDispatcherServletInitializer.inStartup(servletContext)
        2.2.1. 创建springmvc上下文
            1. 同样的钩子方法,获取有@mapperScan的类,主要扫描@Controller类
        2.2.2. 创建DispatcherServlet,注册到servlet容器中
        2.2.3. DispatcherServlet.init() 
            1. 设置springmvc的父容器为spring容器
            2. springmvc上下文的onRefresh()方法，启动该容器

看下源码:

1.spring-web包下的SpringServletContainerInitializer类

根据servlet规范，该类会实现ServletContainerInitializer接口,并重写onStartup()方法

tomcat启动的时候会利用spi机制,去META-INF/services/javax.servlet.ServletContainerInitializer文件中SpringServletContainerInitializer类,并调用他的onStartup（）方法

tomcat获取到@HandlesTypes的WebApplicationInitializer.class对象值之后，将所有该类非抽象子类的class对象作为集合传入onStartup方法作为参数

onStartup方法后面就反射实例化这些类,分别调用这些类实例的onStartup()方法

这里需要注意,方法传入的class对象为WebApplicationInitializer接口非抽象的实现类,而spring提供的其子类全部是抽象的

这个意思肯定是需要我们去自己实现WebApplicationInitializer接口了，仔细想想也是,不管是spring容器和springmvc容器都是需要我们配置一些东西的，比如说bean的扫描,和类似于web.xml里面的一些东西:servlet-mapping,filter之类的，不然spring咋知道去扫描哪些包，注册哪些我们自己写的bean对吧。这又不是springboot。

但是,需要我们自己完全去实现如spring容器启动,springmvc容器启动这类繁琐，复杂的工作嘛？肯定不需要,那那些接口的抽象的实现类已经写好了，我们自己建一个类去实现AbstractAnnotationConfigDispatcherServletInitializer抽象类,然后重写需要自定义配置的一些方法就行啦。

后续所有的调用都会在这个类进行,这是一种典型的模板设计模式,容器初始化的步骤已经完全在父类中定义好了，需要自己自定义配置的方法，自己重写，类似于钩子方法，实际运行的时候会调用到自己的钩子方法。

由于自己写的WebAppInitializer类的onStartup方法没有重写，所以会调用到父类AbstractAnnotationConfigDispatcherServletInitializer的onStartup方法,父类也没有重写，就会调用到 AbstractDispatcherServletInitializer的onStartup方法

这个类中的onStartup又会去调用他的父类AbstractContextLoaderInitializer的onStartup(servletContext)方法

所以这里会调到这两个类的onStartup方法

AbstractContextLoaderInitializer.onStartup(servletContext)
AbstractDispatcherServletInitializer.onStartup(servletContext)

后续容器的启动都在这两个方法中完成的，接下来我们一一分析。

2.1 AbstractContextLoaderInitializer.onStartup(servletContext)

2.1.1 创建spring上下文

2.1.1.1 加载含有@MapperScan的类

这是一个抽象方法，但是我们当前自己写的类已经实现了 getRootConfigClasses()方法，所以会调用我们类的这个方法

钩子方法被调用到了

这个方法中，我们返回了这个SpringContainer这个类的class对象，并装到了数组中,这个类包含@MapperScan,就会扫描注解中配置的包路径下的bean，除@Controller之外 

2.1.1.2 创建spring上下文AnnotationConfigWebApplicationContext对象 

 并将含有@MapperScan的类弄进去了，后续这个容器启动的时候会解析这个注解，扫描bean

2.1.2 注册ContextLoaderListener到Servlet容器中

这个一个servlet中的监听器,类似于web.xml中配置的这种

根据servlet规范，tomcat加载时,后续肯定会调用到这个监听器中的contextInitialized(ServletContextEvent event) 方法,

这里我们先看下这个方法做了啥 

 最终会启动这个容器，完成初始化

2.2 AbstractDispatcherServletInitializer.inStartup(servletContext)

2.2.1 创建springmvc上下文

这里同样的会需要获取到configClass,并设置进springmvc上下文对象中

最终同样的会调到我们自己写的类WebAppInitializer的getServletConfigClasses()钩子方法,

在方法中,返回了MvcContainer类

该类上的@MapperScan注解负责扫描@Controller注解的bean

2.2.2 创建DispatcherServlet,注册到servlet容器中

并且下面设置了加载的优先级，这个DispatchServlet又优先加载

//设置优先级
registration.setLoadOnStartup(1);

//设置Servlet与路径的映射关系  
registration.addMapping(getServletMappings());

会调用到自己实现的方法

//设置Servlet与路径的映射关系

Filter[] filters = getServletFilters();

DispatchServlet他其实就是一个servlet，在springmvc中，所有的请求都会匹配到他，由它进行请求处理

2.2.3 DispatcherServlet的init()

在servlet生命周期中，会调用它的init()方法

自己没重写init()，看下继承FrameworkServlet父类的init()方法

 父类又调用父类，最终会调用到HttpServletBean的init方法

2.2.3.1 方法最后面会启动springmvc容器

2.2.3.2 设置sprignmvc容器的父容器为刚才启动的spring容器,

最后调用springmvc上下文的refresh()方法

至此,spring容器和springmvc子容器全部启动完毕

spring上下文和springmvc上下文的关系

两个容器之间是父子关系。

springmvc上下文getBean的时候会从spring上下文中找，如果父容器有该bean的BeanDefinition就会由父容器来初始化,否则就自己初始化

AbstractBeanFactory.doGetBean方法源码

 原文：springmvc源码分析:容器及spring父容器的启动工作