Spring MVC之组件初始化

1.Spring MVC整体结构介绍

Spring MVC主要类结构图

image

从上图中可以看到在Servlet的继承结构中一共有5个类，分别是Java提供的两个类GenericServlet，HttpServlet和Spring MVC提供的三个类HttpServletBean、FrameworkServlet和Dispat
cherServlet

Spring MVC请求流程图


image

从上图可以看出DispatcherServlet是Spring MVC框架的核心，通过DispatcherServlet获取处理请求的Handler
Adapter（处理请求的具体Controller），然后将返回的结果交给ViewResolver（处理视图的类），然后渲染出视图返回给客户端

2.HttpServletBean

通过前面的文章，我们知道搭建SpringMVC框架的时候在web.xml文件中配置了DispatcherServlet，它是Spring MVC控制器的核心，当系统开始运行时，DispatcherServlet就开始初始化（<load-on-startup>1</load-on-startup>），由于DispatcherServlet类本身没有init初始化方法，它的父类中只有HttpServletBean中有inti初始化方法,HttpServletBean的初始化方法如下：

    public final void init() throws ServletException {
        if(this.logger.isDebugEnabled()) {
            this.logger.debug("Initializing servlet \'" + this.getServletName() + "\'");
        }

        try {
            //将Servlet中配置的参数封装到ex变量中，requiredProperties为必须参数，如果没有配置则报异常
            HttpServletBean.ServletConfigPropertyValues ex = new HttpServletBean.ServletConfigPropertyValues(this.getServletConfig(), this.requiredProperties);
            BeanWrapper bw =PropertyAccessorFactory.forBeanPropertyAccess(this);
            ServletContextResourceLoader resourceLoader = new ServletContextResourceLoader(this.getServletContext());
            bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, this.getEnvironment()));
            //模板方法，调用的是FrameworkServlet中的初始化方法，做一些初始化工作。bw代表DispatcherServlet
            this.initBeanWrapper(bw);
            //将配置的初始化值(如ContextConfigLocation)设置到DispatcherServlet中
            bw.setPropertyValues(ex, true);
        } catch (BeansException var4) {
            this.logger.error("Failed to set bean properties on servlet \'" + this.getServletName() + "\'", var4);
            throw var4;
        }
        //模板方法，FrameworkServlet初始化的入口方法
        this.initServletBean();
        if(this.logger.isDebugEnabled()) {
            this.logger.debug("Servlet \'" + this.getServletName() + "\' configured successfully");
        }

    }

HttpServletBean.ServletConfigPropertyValues ex = new HttpServletBean.ServletConfigPropertyValues(this.getServletConfig(), this.requiredProperties);
//getServletConfig()方法是Servlet接口提供的方法用于获取ServletConfig，当Servlet的init方法被调用时，会接受到一个ServletConfig类型的参数，指的是Servlet的配置，在web.xml中定义Servlet时通过init-param标签配置的参数就是通过ServletConfig保存的。

BeanWrapper 是Spring提供的一个用来操作JavaBean属性的工具，使用它可以直接修改一个对象的属性

BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);  
//通过PropertyAccessorFactory对象的forBeanPropertyAccess方法将DispatcherServlet封装成BeanWrapper对象，这样通过bw变量就可以对DispatcherServlet的属性进行操作
3.FrameworkServlet

从上面HttpServletBean中的初始化代码得知，FrameworkServlet的初始化入口方法是initServletBean

    protected final void initServletBean() throws ServletException {
        this.getServletContext().log("Initializing Spring FrameworkServlet \'" + this.getServletName() + "\'");
        if(this.logger.isInfoEnabled()) {
            this.logger.info("FrameworkServlet \'" + this.getServletName() + "\': initialization started");
        }

        long startTime = System.currentTimeMillis();

        try {
            //初始化WebApplicationContext
            this.webApplicationContext = this.initWebApplicationContext();
            //初始化FrameworkServlet
            this.initFrameworkServlet();
        } catch (ServletException var5) {
            this.logger.error("Context initialization failed", var5);
            throw var5;
        } catch (RuntimeException var6) {
            this.logger.error("Context initialization failed", var6);
            throw var6;
        }

        if(this.logger.isInfoEnabled()) {
            long elapsedTime = System.currentTimeMillis() - startTime;
            this.logger.info("FrameworkServlet \'" + this.getServletName() + "\': initialization completed in " + elapsedTime + " ms");
        }

    }

首先查看WebApplicationContext初始化代码；WebApplicationContext是web应用的上下文环境

  protected WebApplicationContext initWebApplicationContext() {
        //通过getServletContext获取的ServletContext来获取根上下文
        WebApplicationContext rootContext = WebApplicationContextUtils.getWebApplicationContext(this.getServletContext());
        WebApplicationContext wac = null;
        //如果已经通过构造方法设置了webApplicationContext
        if(this.webApplicationContext != null) {
            wac = this.webApplicationContext;
            if(wac instanceof ConfigurableWebApplicationContext) {
                ConfigurableWebApplicationContext attrName = (ConfigurableWebApplicationContext)wac;
                if(!attrName.isActive()) {
                    if(attrName.getParent() == null) {
                        attrName.setParent(rootContext);
                    }

                    this.configureAndRefreshWebApplicationContext(attrName);
                }
            }
        }

        if(wac == null) {
            //如果webApplicationContext已经存在ServletContext中时，通过配置在Servlet中的参数获取
            wac = this.findWebApplicationContext();
        }

        if(wac == null) {
            //创建一个新的webApplicationContext
            wac = this.createWebApplicationContext(rootContext);
        }

        if(!this.refreshEventReceived) {
            //模板方法，HttpServletBean中用来初始化Spring MVC的九大组件
            this.onRefresh(wac);
        }

        if(this.publishContext) {
            //将ApplicationContext保存到ServletContext中
            String attrName1 = this.getServletContextAttributeName();
            this.getServletContext().setAttribute(attrName1, wac);
            if(this.logger.isDebugEnabled()) {
                this.logger.debug("Published WebApplicationContext of servlet \'" + this.getServletName() + "\' as ServletContext attribute with name [" + attrName1 + "]");
            }
        }

        return wac;
    }

获取spinrg的根容器rootContext
WebApplicationContext rootContext=WebApplicationContextUtils.getWebApplicationContext(this.getServl
etContext());

设置webApplicationContext并根据情况调用onRefresh方法

设置webApplicationContext的三种方法

  • 在构造方法中已经传递了webApplicationContext参数，这时只需要对其进行一些设置即可
  • webApplicationContext已经在ServletContext中了，这时只需要在配置Servlet的时候将ServletContext中的webApplicationContext的name配置到contextAttribute属性就可以了
  • 前面两种方式都无效的情况下，通过createWebApplicationContext来创建一个

创建webApplicationContext的方法

protected WebApplicationContext createWebApplicationContext(
ApplicationContext parent) {
        //通过getContextClass获取要创建的类型
        Class contextClass = this.getContextClass();
        if(this.logger.isDebugEnabled()) {
            this.logger.debug("Servlet with name \'" + this.getServletName() + "\' will try to create custom WebApplicationContext context of class \'" + contextClass.getName() + "\'" + ", using parent context [" + parent + "]");
        }

        if(!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
            throw new ApplicationContextException("Fatal initialization error in servlet with name \'" + this.getServletName() + "\': custom WebApplicationContext class [" + contextClass.getName() + "] is not of type ConfigurableWebApplicationContext");
        } else {
            //具体创建
            ConfigurableWebApplicationContext wac = (ConfigurableWebApplicationContext)BeanUtils.instantiateClass(contextClass);
            wac.setEnvironment(this.getEnvironment());
            wac.setParent(parent);
            //将设置的contextConfigLocation参数传给wac，默认传入WEB-INF/[ServletName]-servlet.xml
            wac.setConfigLocation(this.getContextConfigLocation());
            this.configureAndRefreshWebApplicationContext(wac);
            return wac;
        }
    }

将webApplicationContext设置到ServletContext中

    if(this.publishContext) {
        //将ApplicationContext保存到ServletContext中
        String attrName1 = this.getServletContextAttributeName();
        this.getServletContext().setAttribute(attrName1, wac);
        if(this.logger.isDebugEnabled()) {
            this.logger.debug("Published WebApplicationContext of servlet \'" + this.getServletName() + "\' as ServletContext attribute with name [" + attrName1 + "]");
        }
    }

根据publishContext标志判断是否将webApplicationContext设置到ServletContext的属性中，publishContext标志可以在配置Servlet时通过init-param参数进行设置，HttpServletBean初始化时会将其设置到publishContext参数

3.DispatcherServlet

onRefresh方法是DispatcherServlet的入口方法

    protected void onRefresh(ApplicationContext context) {
        this.initStrategies(context);
    }

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

onRefresh方法调用了initStrategies方法，initStrategies方法中初始化了Spring MVC九大组件

4.小结

上面主要分析了Spring MVC自身的创建过程，Spring MVC中的Servlet一共分为三个层
次，分别是HttpServletBean、FrameworkServlet和DispatcherServlet。

  • HttpServletBean继承自Java的HttpServlet，其作用是将Servlet中配置的参数设置到相应的属性
  • FrameworkServlet初始化了WebApplicationContext
  • DispatcherServlet初始化了自身的9大组件
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 216,125评论 6赞 498
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 92,293评论 3赞 392
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 162,054评论 0赞 351
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,077评论 1赞 291
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,096评论 6赞 388
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,062评论 1赞 295
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,988评论 3赞 417
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 38,817评论 0赞 273
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,266评论 1赞 310
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2赞 331
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1赞 347
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,375评论 5赞 342
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,974评论 3赞 325
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1赞 268
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2赞 368
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2赞 352