SpringBoot 整合SpringMvc 原理探究(DispatchServlet添加流程)

通过SpringBoot整合各个框架是越来越方便了,整合SpringMVC只需要添加对应的starer依赖即可。

<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服务了。

之前一直很好奇,使用SpringMVC时需要在web.xml上配置DispatcherServlet。而整合了SpringBoot后为什么就不需要配置了,下面就进行完整的分析。

看着累?可以直接看步骤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容器的接口,默认注入的有


这里写图片描述

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实现类如下:


这里写图片描述

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的原因了。


这里写图片描述

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初始化之前或之后完成配置功能或初始化某些依赖功能

以上代码分析来自我的工程SpringBootLearning
SpringBootLean 是对springboot学习与研究项目,是根据实际项目的形式对进行配置与处理,欢迎star与fork。
[oschina 地址]
http://git.oschina.net/cmlbeliever/SpringBootLearning
[github 地址]
https://github.com/cmlbeliever/SpringBootLearning

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,724评论 6 342
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • 今天是训练营的第二天,还是那些时间,每天还是那些必须的事,伴随着昨天的开营,自己就有一种新鲜,好奇,紧迫感!早上睁...
    真诚永恒阅读 235评论 0 0
  • 我渴念过善良 我不善良 我也没说,我将善良 眼色冷惯了 才容易成活
    萝卜衣阅读 287评论 0 1
  • 优化主标题(模板相对年轻与所讲主题有出入) 个人照去底色会更融合 自我介绍内容重点不突出 字体可全部选用白色 可缩...
    松林walter阅读 224评论 0 0