SpringMVC源码分析一

入口分析

tomcat启动的时候会加载web.xml,对于spring项目来说一个简单的web.xml通常为如下格式:

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!-- Spring mvc分发servlet -->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:applicationContext.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <!-- 欢迎页,默认进入index.jsp -->
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

文件中有一个Servlet,所以Servlet 即为程序的入口。

DispatcherServlet 分析

通过下图可以看出DispatcherServlet 继承了 FrameworkServlet,HttpServletBean,HttpServlet,GenericServlet


DispatcherServlet继承实现关系.png
DispatcherServlet Diagrams.png
我们思考下一个Servlet是如何加载的?
Servlet Structure.png

调用顺序 init() ---> service() ---> destory() , 由于DispatcherServlet方法是Servlet的实现类,所以其必然有对应的init方法,但是经过分析发现DispatcherServlet方法中以及其父类FrameworkServlet方法中都没有init方法,直在HttpServletBean中才发现init方法。代码如下:

  /**
    * Map config parameters onto bean properties of this servlet, and
    * invoke subclass initialization.
    * @throws ServletException if bean properties are invalid (or required
    * properties are missing), or if subclass initialization fails.
    */
   @Override
   public final void init() throws ServletException {

       // Set bean properties from init parameters.
       // 第一步:根据bean属性设置,设置初始化参数。getServletConfig为Tomcat帮我们实现,主要是Servlet的信息,如Servlet名字等,requiredProperties为new HashSet表示必然要出现的属性
       // 这个步骤的主要目的是为了获取设置的init-param中的name 和 value, 并将其狗造成PropertyValue 放至MutablePropertyValues 的成员变量propertyValueList 中
       PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);

       if (!pvs.isEmpty()) {
           try {
               // 第二步:创建一个BeanWrapper对象,里面包装了一个DispatcherServlet对象
               BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
               //  第三步:获取资源加载对象
               ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
               // 第四步:给bw注册一个客户自定义的属性编辑器,主要是做类型转换
               bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
               // 第五步:initBeanWrapper,spring 默认没有实现
               initBeanWrapper(bw);
               // 第六步:为bean设置属性值,底层是利用的反射
               bw.setPropertyValues(pvs, true);
           }
           catch (BeansException ex) {
               if (logger.isErrorEnabled()) {
                   logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
               }
               throw ex;
           }
       }

       // Let subclasses do whatever initialization they like.
       // 第七步:调用子类去实现spring 容器初始化(关键步骤!)
       initServletBean();
   }

我们进行逐步分析:
第一步:根据bean属性设置,设置初始化参数。getServletConfig为Tomcat帮我们实现,主要是Servlet的信息,如Servlet名字等,requiredProperties为new HashSet

        PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
/**
         * Create new ServletConfigPropertyValues.
         * 创建一个新的ServletConfig属性值
         * @param config the ServletConfig we'll use to take PropertyValues from
         * @param requiredProperties set of property names we need, where
         * we can't accept default values
         * @throws ServletException if any required properties are missing
         */
        public ServletConfigPropertyValues(ServletConfig config, Set<String> requiredProperties)
                throws ServletException {

            Set<String> missingProps = (!CollectionUtils.isEmpty(requiredProperties) ?
                    new HashSet<>(requiredProperties) : null);

            // 获取到配置的初始化参数
            /*
                config 可以理解为,web.xml中的配置信息
                <servlet>
                    <servlet-name>dispatcherServlet</servlet-name>
                    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
                    <init-param>
                        <param-name>contextConfigLocation</param-name>
                        <param-value>classpath:applicationContext.xml</param-value>
                    </init-param>
                    <load-on-startup>1</load-on-startup>
                </servlet>

                此处就为获取到  <init-param> 下的信息 为tomcat实现,我们暂时不做分析。
             */
            Enumeration<String> paramNames = config.getInitParameterNames();

            while (paramNames.hasMoreElements()) {
                // 获取参数名字
                String property = paramNames.nextElement();
                // 获取参数value
                Object value = config.getInitParameter(property);
                // 将name和value构成PropertyValue,放至MutablePropertyValues 的成员变量propertyValueList 中,但是并未使用其返回值
                addPropertyValue(new PropertyValue(property, value));
                if (missingProps != null) {
                    missingProps.remove(property);
                }
            }

            // Fail if we are still missing properties.
            // 如果丢失了必然出现的属性则抛出异常。
            if (!CollectionUtils.isEmpty(missingProps)) {
                throw new ServletException(
                        "Initialization from ServletConfig for servlet '" + config.getServletName() +
                        "' failed; the following required properties were missing: " +
                        StringUtils.collectionToDelimitedString(missingProps, ", "));
            }
        }

第二步:创建一个BeanWrapper对象,里面包装了一个DispatcherServlet对象

第三步:获取资源加载对象

第四步:给bw注册一个客户自定义的属性编辑器,主要是做类型转换

第五步:initBeanWrapper,spring 默认没有实现

第六步:为bean设置属性值,底层是利用的反射

第七步:调用子类去实现spring 容器初始化(关键步骤!)

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