2.spring整合SpringMVC基于servlet3.0的SPI规范原理解析

一、servlet3.0提供的SPI规范

从servlet3.0开始，web容器启动时为提供给第三方组件机会做一些初始化的工作，
例如注册servlet或者filtes等，servlet规范中通过ServletContainerInitializer实现此功能。
每个框架要使用ServletContainerInitializer就必须在对应的jar包的META-INF/services
 目录创建一个名为javax.servlet.ServletContainerInitializer的文件，文件内容指定具体的
ServletContainerInitializer实现类，那么，当web容器启动时就会运行这个初始化器做一些
组件内的初始化工作。
一般伴随着ServletContainerInitializer一起使用的还有HandlesTypes注解，通过
HandlesTypes可以将感兴趣的一些类注入到ServletContainerInitializerde的onStartup方法
作为参数传入。

tomcat7之后的版本都实现了servlet3.0的SPI规范

servlet3.0之前开发一个web应用必须要配置web.xml作为web应用的入口，定义一个
servlet也必须在web.xml中定义才能够被加载；servlet3.0之后，web容器（tomcat）
在进行初始化时，根据SPI规范会调用实现了javax.servlet.ServletContainerInitializer
接口的类的onStartup方法，servlet可以在onStartup方法中定义，这就可以省略web.xml,
springboot也是基于这个原理，所以在springboot中已经看不到web.xml的踪影。

二、传统springMVC项目web.xml的配置方式

<!DOCTYPE web-app PUBLIC
        "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
        "http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
    <display-name>Archetype Created Web Application</display-name>
    <!--listener作用：在web应用启动的时候能够加载Spring 环境-->
   <listener>
       <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
   </listener>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <<param-value>spring.xml</param-value>
    </context-param>
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>spring-mvc.xml</param-value>
        </init-param>
        <!--web容器启动时加载这个servlet(实例化并调用init()方法)-->
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>*.do</url-pattern>
    </servlet-mapping>
</web-app>

三、基于Servlet3.0自定义spring及SpringMVC的整合

1.在项目目录下添加接口配置文件

image.png
image.png

2.创建javax.servlet.ServletContainerInitializer的实现类

package com.mjw.service;
import javax.servlet.ServletContainerInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.HandlesTypes;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
@HandlesTypes(WebInit.class)
public class MjwServletContainerInitializer implements ServletContainerInitializer {
    /**
     * 在web容器启动时会调用onStartup方法,
     * 在调用onStartup方法之前把实现了@HandlesTypes注解中WebInit.class接口的Class对象封装成参数
     * 作为onstartup方法的参数传进来
     * @param set 
     * @param servletContext
     * @throws ServletException
     */
    @Override
    public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
        System.out.println(".........start...............");
        List<WebInit> list = new ArrayList<>();
        for (Class<?> aClass : set) {
            try {
                list.add((WebInit) aClass.newInstance());
            } catch (InstantiationException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
        for (WebInit webInit : list) {
            webInit.start(servletContext);
        }
    }
}

3.定义Webinit接口并创建实现类

package com.mjw.service;
import javax.servlet.ServletContext;
public interface WebInit {
    void start(ServletContext context);
}

package com.mjw.service;
import com.mjw.config.AppConfig;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.servlet.DispatcherServlet;
import javax.servlet.ServletContext;
import javax.servlet.ServletRegistration;

/**
 * 在这个类的start方法中实现spring容器环境的加载及初始化
 * 配置SpringMvc的DispatcherServlet
 */
public class MyWebInit implements WebInit {
    @Override
    public void start(ServletContext context) {
        //创建spring环境
        AnnotationConfigWebApplicationContext ac = new AnnotationConfigWebApplicationContext();
        ac.register(AppConfig.class);
        //创建servlet
        DispatcherServlet servlet = new DispatcherServlet(ac);
        //讲servlet注册到web容器中
        ServletRegistration.Dynamic spmvc = context.addServlet("spmvc", servlet);
        //配置web容器初始化完成后调用该servlet的初始化方法
        spmvc.setLoadOnStartup(1);
        //请求路径映射
        spmvc.addMapping("*.do");
    }
}

4.定义启动类并启动tomcat

package com.mjw;
import org.apache.catalina.Context;
import org.apache.catalina.LifecycleListener;
import org.apache.catalina.startup.Tomcat;
public class App {
    public static void main(String[] args) throws Exception {
        Tomcat tomcat = new Tomcat();
        tomcat.setPort(8080);
        Context context = tomcat.addContext("/", System.getProperty("java.io.tmpdir"));
        context.addLifecycleListener((LifecycleListener) Class.forName(tomcat.getHost().getConfigClass()).newInstance());
        tomcat.start();
        tomcat.getServer().await();
    }
}

四、spring整合SpringMvc的真实代码

image.png
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.web;

import java.lang.reflect.Modifier;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import javax.servlet.ServletContainerInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.annotation.HandlesTypes;
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
import org.springframework.lang.Nullable;
import org.springframework.util.ReflectionUtils;

@HandlesTypes({WebApplicationInitializer.class})
public class SpringServletContainerInitializer implements ServletContainerInitializer {
    public SpringServletContainerInitializer() {
    }

    public void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext) throws ServletException {
        List<WebApplicationInitializer> initializers = new LinkedList();
        Iterator var4;
        if (webAppInitializerClasses != null) {
            var4 = webAppInitializerClasses.iterator();

            while(var4.hasNext()) {
                Class<?> waiClass = (Class)var4.next();
                if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) && WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
                    try {
                        initializers.add((WebApplicationInitializer)ReflectionUtils.accessibleConstructor(waiClass, new Class[0]).newInstance());
                    } catch (Throwable var7) {
                        throw new ServletException("Failed to instantiate WebApplicationInitializer class", var7);
                    }
                }
            }
        }
        if (initializers.isEmpty()) {
            servletContext.log("No Spring WebApplicationInitializer types detected on classpath");
        } else {
            servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");
            AnnotationAwareOrderComparator.sort(initializers);
            var4 = initializers.iterator();
            while(var4.hasNext()) {
                WebApplicationInitializer initializer = (WebApplicationInitializer)var4.next();
                //关键代码
                initializer.onStartup(servletContext);
            }
        }
    }
}
image.png
1. AbstractContextLoaderInitializer：创建根容器，createRootApplicationContext()是一个抽象方法，供子类实现
2.AbstractDispatcherServletInitializer：
   ①创建一个web的ioc容器：createServletApplicationContext()，抽象方法，供子类实现
   ②创建DispatcherServlet：createDispatcherServlet()
   ③将创建的DispatcherServlet添加到ServletContext中
   ④getServletMappings();
3.AbstractAnnotationConfigDispatcherServletInitializer：
     子类通过实现其抽象方法返回注解方式的根容器和Servlet子容器，
     从而实现注解方式配置DispatcherServlet初始化器(SpringMVC的容器)和根容器(Spring的IOC容器)
     创建根容器：createRootApplicationContext()，子实现类通过实现getRootConfigClasses();方法返回一个配置类
     创建web的IOC容器： createServletApplicationContext();子实现类通过实现
getServletConfigClasses();返回一个web的IOC容器配置类

五、springMVC请求处理流程介绍

1.初始化过程

Web容器启动后进行初始化，根据Web.xml配置的监听器进行spring环境创建，如果是servlet3.0java配置方式，
会根据调用实现ServletContianerIniliazer接口的类的onStartUp方法创建spring环境。之后会进行调用
DispatchServlet初始化方法进行初始化：
初始化做了什么？
1.  实例化视图解析器、消息转换器、参数解析器、handlerMappings映射器、拦截器
2.  从spring容器中获取带有@Controller和@RequestMapping注解的对象，解析里面
带有@RequestMapping注解的方法，解析成一个一个的handler对象，并根据请求路径做映射放入到一个map中。

2.springMVC请求过程

1.  请求进来之后会进入到doDispatch()方法中。
2.  根据request从handlermappings循环获取handler，并构建成一个调用链对象
       HandlerExecutionChain,调用链中包含handler对象以及拦截器。
      注意：springMVC中生命一个controller有三种方式:@Controller注解\实现
      Controller接口\实现HttpRequestHandler接口分别对应三种映射器来获取
      handler对象。这三种方式@Contoller是把对象中的方法解析成一个个handler；
      其余两种其实就是从Spring容器中获取真实的对象。
3.  根据request从匹配出适合的适配器，适配器也有三种分别对应不同的Controller类型,
4.  Chain.applyPreHandle()按顺序调用拦截器
5.  Ha.hand(hand) –通过适配器调用handle对应的方法。其中@Controller类型是通过反射调用，
   期间会通过策略模式，根据不同类型的参数调用不同的参数解析器从request中解析参 
   数值，然后通过反射调用controller的方法;根据方法的返回值以及方法上有没有加@ResponseBody注解，
   来判断是走视图解析器还是走消息转换器。
6.  Chain.applyPostHandle()调用拦截器
7.  调用视图解析器渲染参数以及页面跳转。
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,386评论 6赞 479
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,939评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,851评论 0赞 341
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,953评论 1赞 278
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,971评论 5赞 369
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,784评论 1赞 283
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,126评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,765评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,148评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,479评论 4赞 322
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,080评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2赞 343