SpringBoot DispatchServlet分析

如何集成Tomcat和web服务

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

而且还配备了Tomcat的starter

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

这样，只需要根据自身需求，设置配置文件。启动web服务器只需要运行java application就可以了，不再需要部署到tomcat服务了。

springboot原理(核心原理、启动流程、执行流程)

image.png

我们可以知道，dispatcherServlet 是tomcat完成后初始化的。接下来一步一步的剖析DispatcherServlet

DispatcherServlet简介

DispatcherServlet是前端控制器设计模式的实现，提供了Spring Web MVC的集中访问点，而且负责职责的分派，而且与Spring Ioc容器无缝集成，从而可以获得Spring的所有好处。

DispatcherServlet作用

DispatcherServlet主要用作职责调度工作，本身主要用于控制流程，主要职责如下：

• 文件上传解析，如果请求类型是multipart将通过MultipartResolver进行文件上传解析；
• 通过HandlerMapping，将请求映射到处理器（返回一个HandlerExecutionChain，它包括一个处理器、多个HandlerInterceptor拦截器）；
• 通过HandlerAdapter支持多种类型的处理器(HandlerExecutionChain中的处理器)；
• 通过ViewResolver解析逻辑视图名到具体视图实现；
• 本地化解析；
• 渲染具体的视图等；
• 如果执行过程中遇到异常将交给HandlerExceptionResolver来解析。

DispatcherServlet工作流程

image

DispatcherServlet传统配置

DispatcherServlet作为前置控制器，通常配置在web.xml文件中的。拦截匹配的请求，Servlet拦截匹配规则要自已定义，把拦截下来的请求，依据相应的规则分发到目标Controller来处理，是配置spring MVC的第一步。

<servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/dispatcherServlet-servlet.xml</param-value> 
    </init-param>
</servlet> 
<servlet-mapping>
     <servlet-name>dispatcherServlet</servlet-name>
     <url-pattern>*.do</url-pattern> 
</servlet-mapping>

DospatcherServlet实际上是一个Servlet（它继承HttpServlet）。DispatcherServlet处理的请求必须在同一个web.xml文件里使用url-mapping定义映射。这是标准的J2EE servlet配置。

在上述配置中：

• servlet-name用来定义servlet的名称，这里是dispatcherServlet。
• servlet-class用来定义上面定义servlet的具体实现类，这里是org.springframework.web.servlet.DispatcherServlet。
• init-param用来定义servlet的初始化参数，这里指定要初始化WEB-INF文件夹下的dispatcherServlet-servlet.xml。如果spring-mvc.xml的命名方式是前面定义servlet-name+"-servlet",则可以不用定义这个初始化参数,（Spring默认配置文件为“/WEB-INF/[servlet名字]-servlet.xml”）,Spring会处理这个配置文件。由此可见，Spring的配置文件也可放置在其他位置，只要在这里指定就可以了。如果定义了多个配置文件，则用“,”分隔即可。
• servlet-mapping定义了所有以.do结尾的请求，都要经过分发器。

当DispatcherServlet配置好后，一旦DispatcherServlet接受到请求，DispatcherServlet就开始处理请求了。

DispatcherServlet相关源码

org.springframework.web.servlet.DispatcherServlet中doService方法部分源码：

protected void doService(HttpServletRequest request,
            HttpServletResponse response) throws Exception {
    // ......

    request.setAttribute(WEB_APPLICATION_CONTEXT_ATTRIBUTE,getWebApplicationContext());
    // ......
}

通过上面源码得知，DispatcherServlet会找到上下文WebApplicationContext(其指定的实现类为XmlWebApplicationContext)，并将它绑定到一个属性上（默认属性名为WEB_APPLICATION_CONTEXT_ATTRIBUTE），以便控制器能够使用WebApplicationContext。

initStrategies方法源码如下：

protected void initStrategies(ApplicationContext context) {
    initMultipartResolver(context);
    initLocaleResolver(context);
    initThemeResolver(context);
    initHandlerMappings(context);
    initHandlerAdapters(context);
    initHandlerExceptionResolvers(context);
    initRequestToViewNameTranslator(context);
    initViewResolvers(context);
    initFlashMapManager(context);
}

从如上代码可以看出，DispatcherServlet启动时会进行我们需要的Web层Bean的配置，如HandlerMapping、HandlerAdapter等，而且如果我们没有配置，还会给我们提供默认的配置。

DispatcherServlet处理流程

当配置好DispatcherServlet后，DispatcherServlet接收到与其对应的请求之时，处理就开始了。处理流程如下：

找到WebApplicationContext并将其绑定到请求的一个属性上，以便控制器和处理链上的其它处理器能使用WebApplicationContext。默认的属性名为DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE。

将本地化解析器绑定到请求上，这样使得处理链上的处理器在处理请求（准备数据、显示视图等等）时能进行本地化处理。如果不需要本地化解析，忽略它就可以了。

将主题解析器绑定到请求上，这样视图可以决定使用哪个主题。如果你不需要主题，可以忽略它。

如果你指定了一个上传文件解析器，Spring会检查每个接收到的请求是否存在上传文件，如果是，这个请求将被封装成MultipartHttpServletRequest以便被处理链中的其它处理器使用。（Spring's multipart (fileupload) support查看更详细的信息）

找到合适的处理器，执行和这个处理器相关的执行链（预处理器，后处理器，控制器），以便为视图准备模型数据。

如果模型数据被返回，就使用配置在WebApplicationContext中的视图解析器显示视图，否则视图不会被显示。有多种原因可以导致返回的数据模型为空，比如预处理器或后处理器可能截取了请求，这可能是出于安全原因，也可能是请求已经被处理过，没有必要再处理一次。

传统使用SpringMVC时需要在web.xml上配置DispatcherServlet（如需具体了解，请查看HttpServletRequest参数获取，HttpServletRequest详解）。而整合了SpringBoot后这些步骤都简化了。

为什么SpringBoot就不需要配置了，下面就进行完整的分析。

DispatchServlet添加流程

看着累？可以直接看步骤7，核心分析。

1、寻找入口，找到WebServlet自动配置类：EmbeddedServletContainerAutoConfiguration

org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration

@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
@Configuration
@ConditionalOnWebApplication
@Import(BeanPostProcessorsRegistrar.class)
public class EmbeddedServletContainerAutoConfiguration{
    ...省略代码
}

SpringBoot 自动配置功能类都以AutoConfiguration结尾

2、注入需要的Bean
从类上的注解可以看出，导入了BeanPostProcessorsRegistrar，来添加EmbeddedServletContainerCustomizerBeanPostProcessor。首先会查看工程是否有自定的EmbeddedServletContainerCustomizerBeanPostProcessor，如果没有，则注入默认的EmbeddedServletContainerCustomizerBeanPostProcessor。代码如下：

@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,BeanDefinitionRegistry registry) {
            if (this.beanFactory == null) {
                return;
            }
            if (ObjectUtils.isEmpty(this.beanFactory.getBeanNamesForType(
    EmbeddedServletContainerCustomizerBeanPostProcessor.class, true,
                    false))) {
                registry.registerBeanDefinition(                    "embeddedServletContainerCustomizerBeanPostProcessor",
                        new RootBeanDefinition(
        EmbeddedServletContainerCustomizerBeanPostProcessor.class));
            }
            if (ObjectUtils.isEmpty(this.beanFactory.getBeanNamesForType(
                    ErrorPageRegistrarBeanPostProcessor.class, true, false))) {
                registry.registerBeanDefinition("errorPageRegistrarBeanPostProcessor",
                        new RootBeanDefinition(
                                ErrorPageRegistrarBeanPostProcessor.class));

            }
        }

实现ImportBeanDefinitionRegistrar接口，实现注入需要的Bean到Spring容器中，Mybatis（MapperScannerRegistrar）也是通过此接口来完成Mapper类的定义。

3、步骤2注入了bean：EmbeddedServletContainerCustomizerBeanPostProcessor，该类实现了在ConfigurableEmbeddedServletContainer对象初始化前，进行行必要的参数配置。

1. 获取所有EmbeddedServletContainerCustomizer对象
2. 调用EmbeddedServletContainerCustomizer.customize方法
3. EmbeddedServletContainerCustomizer实现类根据自身需求设置WebServlet容器参数（如：端口号、连接数等等）
   核心代码如下：

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName)throws BeansException {
        if (bean instanceof ConfigurableEmbeddedServletContainer) {     postProcessBeforeInitialization((ConfigurableEmbeddedServletContainer) bean);
        }
        return bean;
    }
private void postProcessBeforeInitialization(ConfigurableEmbeddedServletContainer bean) {
        for (EmbeddedServletContainerCustomizer customizer : getCustomizers()) {
            customizer.customize(bean);
        }
    }

ConfigurableEmbeddedServletContainer：是Web容器的接口，默认注入的有

image.png

BeanPostProcessor ： 是Spring容器的回调接口，在所有Bean初始化之前和之后分别回调此接口的postProcessBeforeInitialization，postProcessAfterInitialization方法。这样就可以根据需求在Bean初始化前后配置设置需要的功能。

通过步骤1-3完成了Web容器启动前的参数配置功能。

4、EmbeddedWebApplicationContext入场
Spring容器配置加载完成后，会回调EmbeddedWebApplicationContext.refresh方法。EmbeddedWebApplicationContext在执行refresh方法中，调用了onRefresh方法进行ServletContainer配置。代码如下：

@Override
    public final void refresh() throws BeansException, IllegalStateException {
             ...省略
            super.refresh();
             ...省略
    }

    @Override
    protected void onRefresh() {
        ...省略
        //创建ServletContainer
        createEmbeddedServletContainer();
         ...省略
    }

EmbeddedWebApplicationContext实现了接口ConfigurableApplicationContext,Spring容器配置加载完成后会回调所有的ConfigurableApplicationContext对象的refresh方法。

1. 在onRefresh方法中，获取EmbeddedServletContainerFactory对象，因为工程上使用Tomcat，所以这里就是TomcatEmbeddedServletContainerFactory
2. 执行EmbeddedServletContainerFactory.getEmbeddedServletContainer方法

5、TomcatEmbeddedServletContainerFactory.getEmbeddedServletContainer这里是Tomcat容器核心功能完的地方。主要完成了对Tomcat配置（不是这篇重点，省略代码），在configureContext方法添加Tomcat容器启动回调接口（重点）。

protected void configureContext(Context context,
            ServletContextInitializer[] initializers) {
        TomcatStarter starter = new TomcatStarter(initializers);
        if (context instanceof TomcatEmbeddedContext) {
            // Should be true
            ((TomcatEmbeddedContext) context).setStarter(starter);
        }
        ...省略
    }

ServletContainerInitializer是Tomcat容器启动的一个回调接口。
在Tomcat启动前，SpringBoot通过TomcatStarter完成Servlet，Filter等Web组件的组注入

6、TomcatStarter，在Tomcat启动后回调onStartup。

7、EmbeddedWebApplicationContext在onStartup回调中完成SpringMvc功能注入

7.1、在selfInitialize方法中获取到所有ServletContextInitializer对象，并调用其onStartup方法，
7.2、ServletContextInitializer实现类如下：

image.png

7.3、通过上图就很清楚的说明了Servlet，Filter等Web组件实现类
7.4、在ServletRegistrationBean向ServletContainer添加Servlet

@Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        Assert.notNull(this.servlet, "Servlet must not be null");
        String name = getServletName();
        if (!isEnabled()) {
            logger.info("Servlet " + name + " was not registered (disabled)");
            return;
        }
        logger.info("Mapping servlet: '" + name + "' to " + this.urlMappings);
        Dynamic added = servletContext.addServlet(name, this.servlet);
        if (added == null) {
            logger.info("Servlet " + name + " was not registered "
                    + "(possibly already registered?)");
            return;
        }
        configure(added);
    }

7.5、这里也就解释了SpringBoot官方文档70.1节上为什么是通过RegistrationBean添加Servlet与Filter的原因了。

image.png

7.6、DispatcherServletAutoConfiguration.DispatcherServletRegistrationConfiguration此处添加SpringMVC核心功能类DispatcherServlet

    @Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
        @ConditionalOnBean(value = DispatcherServlet.class, name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
        public ServletRegistrationBean dispatcherServletRegistration(
                DispatcherServlet dispatcherServlet) {
            ServletRegistrationBean registration = new ServletRegistrationBean(
                    dispatcherServlet, this.serverProperties.getServletMapping());
            registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
            registration.setLoadOnStartup(
                    this.webMvcProperties.getServlet().getLoadOnStartup());
            if (this.multipartConfig != null) {
                registration.setMultipartConfig(this.multipartConfig);
            }
            return registration;
        }

以上只是将重要点抽出来说明，贴上全部源码也是无意义的。要理解其中过程还需要自行查看源码。

通过以上步骤分析了SpringBoot集成SpringMVC和Tomcat功能简要步骤。其实只要找到了入口，即可Debug一步一步的走下去，来查看内部实现。

总结

通过以上分析和Mybatis功能分析，发现满满的都是套路。在SpringBoot上实现自定义Starter功能应该都是如下套路：
1、在自定义的XXAutoConfiguration上Import一个ImportBeanDefinitionRegistrar来注入指定Bean
2、添加自定义的BeanPostProcessor在Bean初始化之前或之后完成配置功能或初始化某些依赖功能