Spring MVC深入源码之一HttpServletBean

最近想写一些系列文章来深入探讨理解下Spring MVC的运行方式及源码实现。好了,废话不多说了,直接进入正题。

大家都知道一个传统的Web Application都是从web.xml开始的,这个文件也是Application容器加载项目时第一个读取的。对于Spring MVC来说,我们需要在web.xml中配置一个DispatcherServlet作为前端控制器并为其指定一些初始参数。从类名就可以看出,DispatcherServlet本质上还是一个Servlet,只不过多了一些和Spring MVC框架有关的一些功能。

今天打算在这里讲的并不是DispatcherServlet,而是它父类的父类HttpServletBean,下图是一个描述了DispatcherServlet继承结构的图,图中只展示了Spring提供的三个类,其实在往上就是servlet-api中的HttpServlet, GenericServlet等。

好了,开始上源码,先从类声明开始。

public abstract class HttpServletBean extends HttpServlet      
implements EnvironmentCapable, EnvironmentAware {

可以看到HttpServletBean继承了HttpServlet,所以它只是在功能上对HttpServlet进行了一些扩展。并且它实现了EnvironmentCapable和EnvironmentAware接口。

  • EnviromentCapable接口里定义,所有实现它的类必须能返回一个Environment的实例。
  • EnvironmentAware接口里定义,所有实现它的类必须提供一个setEnvironment的方法以便于set一个现有的Environment实例。

那看到这里,相信大家不禁要问,这个Enviroment又是一个什么东西,它起到了什么样的作用?在这里我不准备展开说,简单来说Environmenti 里封装了3样东西,Spring MVC的profile配置信息,System Properties的一个Map以及System Environment的一个Map。

接下去看一下这个类中的成员变量声明,不多就3个。

protected final Log logger = LogFactory.getLog(getClass());
private final Set<String> requiredProperties = new HashSet<String>();
private ConfigurableEnvironment environment;
  • Log不需要多说了吧,用来记录日志的。
  • 一个名为requiredProperties的HashSet可以用来指定那些你认为必须存在的servlet参数,可以通过下面这个方法添加如果有的话。
protected final void addRequiredProperty(String property) {  
     this.requiredProperties.add(property);
}
  • 一个类型为ConfigurableEnvironment的变量去存放Environment的实例。
@Override
public void setEnvironment(Environment environment) {
     this.environment = (ConfigurableEnvironment) environment;
}

然后我们一起来看一下比较关键的一个方法init,这个方法覆盖了它祖先类GenericServlet中定义的空实现,并且这个方法会在容器初始化每个Servlet的时候被调用一次。


  • 123行实例化了一个ServletConfigPropertyValues的对象,PropertyValues类其实是一个容器类,它内部会维护一个PropertyValue (注意此处没有s) 的数组,而PropertyValue是一个专门存放属性/参数的结构,它可以存储一个String类型的属性名以及一个Object类型的属性对象。
public class PropertyValue extends BeanMetadataAttributeAccessor implements Serializable {   
private final String name;   
private final Object value;
....

那么ServletConfigPropertyValues其实就是一个存放和Servlet相关的参数的容器类,比如那些定义在web.xml中的initParam。

  • 124行使用了一个PropertyAccessorFactory类里的方法,并且返回了一个BeanWrapper, 简单来说BeanWrapper就是一个对象的包裹者,它里面会存放被包裹对象的引用并且提供一系列利用了反射机制的方法去设置被包裹者的属性,大家可以看到在这行代码里传入了一个this引用,这里的this指的就是当前这个类的实例,而实际中这个其实是一个DispatcherServlet的实例,因为我们在web.xml里使用的是DispatcherServlet而不是直接去使用HttpServletBean。

  • 125行new了一个ServletContextResourceLoader的实例,也说一下ResourceLoader吧,这个接口定义了一些获取Resource的方法,你可以用它来获取各种各样的资源,比如配置文件,class文件等。那ServletContextResourceLoader的实现其实是提供了获取那些和当前Servlet相关的一些Resource,它会通过ServletContext中的一些方法去获取资源,比如servletContext.getResourceAsStream(), servletContext.getResource()

  • 127行调用了一个initBeanWrapper的方法,这个方法是一个空实现,可以在子类中扩展如果有需要的话。

protected void initBeanWrapper(BeanWrapper bw) throws BeansException {
}
  • 128行调用了BeanWrapper上的setPropertyValues方法,并且把前面提到的ServletConfigPropertyValues作为参数传了进去。这句代码的作用就是把ServletConfigPropertyValues中的那些Servlet初始化参数设置到BeanWrapper所包裹的实例中的相应成员变量里。(有点拗口。。)。
    举个例子,前面已经提到BeanWrapper里被包裹对象其实是一个DispatcherServlet,我们平时在web.xml中定义这个Servlet的时候一般都会有一些initParam, 比如
<init-param>   
    <param-name>contextConfigLocation</param-name>    
    <param-value>classpath*: *-dispatcher-servlet.xml
</param-value></init-param>

那这个参数的名字和值就会作为一个PropertyVaule存放在ServletConfigPropertyValues中,在128行被调用的时候这个参数的值就会被set到被包裹者实例的相应的属性中, 在这里就是DispatcherServlet的contextConfigLocation中。

public void setContextConfigLocation(String contextConfigLocation) {   
    this.contextConfigLocation = contextConfigLocation;
}
  • 136行调用了一个initServletBean的方法,这个方法是一个抽象方法,真正的实现是在子类FrameworkServlet里。

结语:
从源码可以看出,HttpServletBean是在HttpServlet的基础上提供了把Servlet配置中相关的一些属性,参数设置到成员变量上这样的一个功能,这么做的好处就是你可以很方便的通过getter/setter方法去获取参数值,而不是通过一个通用的Map去获取。

在下一篇将会深入分析下HttpServletBean的一个子类FrameworkServlet。

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

推荐阅读更多精彩内容

  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,014评论 11 349
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,355评论 6 343
  • 文章作者:Tyan博客:noahsnail.com 3.5 Bean scopes When you create...
    SnailTyan阅读 1,818评论 0 1
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 引言 一直以来都在使用Spring mvc,能够熟练使用它的各种组件。但是,它一直像个黑盒一样,我并不知道它内部是...
    yoqu阅读 883评论 0 24