Spring MVC深入源码之二FrameworkServlet上篇

上一篇讲了Spring MVC中HttpServletBean的源码,本篇会顺着类的继承结构来讲一下HttpServletBean的子类FrameworkServlet。所有源码都是基于spring-framework-4.3.5.RELEASE

前篇讲的HttpServletBean功能上还没有涉及到和Spring MVC框架有关的东西,而FrameworkServlet从名字上就可以推断出,它已经和框架紧密结合在一起了。简单来说,它有下面这些特性和作用:

  1. 它是Spring web framework的一个基础servlet,提供了和Spring ApplicationContext的集成(关于ApplicationContext会在以后的文章中详细解释),它管理着一个WebApplicationContext的实例,会发布一个事件消息在处理完一个请求之后

  2. 它的子类必须实现doService方法来处理接受到的请求

  3. 它会检测在web.xml中的servlet参数配置中是否存在contextClass,如果存在的话,就会实例化指定的context class,如果不存在就会使用默认的XmlWebApplicationContext

接下来,源码伺候

public abstract class FrameworkServlet 
    extends HttpServletBean implements ApplicationContextAware {

FrameworkServlet除了继承了HttpServletBean还实现了ApplicationContextAware接口,这个接口中定义了一个setApplicationContext的方法,这个方法留下了一个入口以便于框架在之后可以通过它setApplicationContext的实例。

接下来看看这个类中一些关键的静态及成员变量

public static final String DEFAULT_NAMESPACE_SUFFIX = "-servlet";
public String getNamespace() {   
    return (this.namespace != null ? 
        this.namespace : getServletName() + DEFAULT_NAMESPACE_SUFFIX);
}

这里定义了一个常量DEFAULT_NAMESPACE_SUFFIX, 以及一个getNameSpace的方法,getNameSpace会返回你在web.xml中配置的servlet-name加上"-servlet",这个namespace会在之后application context加载spring配置文件时候用到,比如你给servlet取名叫MySpringServlet,那么当Spring初始化的时候,会去寻找名为/WEB-INF/MySpringServlet-servlet.xml的配置文件。

public static final Class<?> DEFAULT_CONTEXT_CLASS = 
    XmlWebApplicationContext.class;
private Class<?> contextClass = DEFAULT_CONTEXT_CLASS;

默认的applicationContext类,即XmlWebApplicationContext

这个类中最重要的一个成员方法是initServletBean, 这个方法是在父类HttpServletBean中的一个钩子方法(hook method), 也就是定义是在父类中,但是实现是在子类。如果你看了上一篇文章就会知道在父类init的时候会调用这个钩子方法。

这个方法其实非常简单

  • 489行 调用initWebApplicationContext方法初始化一个WebApplicationContext,现在大家知道平时经常提到的application context是在哪里生成的了吧,没错,就是在这里。

  • 490行 调用initFrameworkServlet方法,这个方法又是一个钩子方法,在当前类里只有一个空的实现,真正的实现是在子类DispatcherServlet中。

接下来我们着重看一下initWebApplicationContext方法

  • 523-524行 尝试从ServletContext中寻找根上下文(root context),如果你在web.xml中定义过ContextLoaderListener,那么Spring framework就会先初始化一个根的application context并设置到ServletContext的一个attribute中,如果没有定义,那这一步就会得到到一个null,不过没有影响。

  • 527-538行 在代码段开始会去判断当前对方的一个webApplicationContext成员变量是不是有值,因为FrameworkServlet中有一个构造函数是允许传入一个现成的applicationContext,所以如果存在的话就不需要再new一个applicationContext了。

  • 539-541行 如果wac变量仍然为null,就会尝试在ServletContext中去查找是否存在一个已经初始化过的WebApplicationContext.

  • 542-544行 调用createWebApplicationContext方法(下文会继续深入这个方法),这里就是真正去创建一个新的WebApplicationContext的地方了,并且会把上面获取到的rootContext(可能为null)作为参数传入。

  • 546-548行 可以看到有一个变量this.refreshEventReceived去标志类中的onRefresh方法是不是已经被调用过,如果没有,那就调用onRefresh

  • 550-557行 通过变量this.publishContext来决定是不是要把初始化后的WebApplicationContext设置到ServletContext的attrbiute里去。

相信大家现在对FrameworkServlet这个class的职责有了更加深入的理解,Spring中最重要的applicationContext的初始化就是它来干的。

出于方便大家阅读和理解(源码这东西本来消化起来就不容易),我会把createWebApplicationContext方法的解释放到下一篇文章里详细说明。

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

推荐阅读更多精彩内容