Spring DispatcherServlet MVC 源码分析(Webapplicationcontext的生成)

<servlet></servlet>

xml 代码

<servlet>
    <servlet-name>Dispatcher</servlet-name>
    <servlet-class>
        org.springframework.web.servlet.DispatcherServlet
    </servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/Config.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>

由此，我们可知，web container把所有的请求都交给DispatcherServlet也就是 org.springframework.web.servlet.dispatcherservlet来处理了。dispatcherservlet是研究springframework mvc的关键类，在你的spring 工程中打开该类的源代码吧。<o:p></o:p>

<o:p></o:p>在你spring工程中你可以看到,dispatcherservlet的父类是frameworkservlet,frameworkservlet的父类 httpservletbean,而httpservletbean的父类是httpservlet,因此dispatcherservlet本质上是个 httpservlet.在web.xml中的<load-on-startup>2</load-on-startup>表明,jsp container 在启动的时候就会生成dispatcherservlet,自然会执行其init()方法了。从 dispatcherservlet的源代码来看，他并没有直接覆盖父类的init(),我们再来看看frameworkservlet的init(), 呵呵，frameworkservlet也没有，一路追溯上去，终于在httpservletbean类中找到了init(),该方法中调用 initservletbean();再看frameworkservlet的initservletbean()<o:p></o:p>

<o:p> </o:p>

里面关键的有2句:<o:p></o:p>

java 代码

1.this.webapplicationcontext = initwebapplicationcontext();
2.initframeworkservlet();

<o:p></o:p>

<o:p></o:p>我们先来看第一句 initwebapplicationcontext();在开始研究这个方法之前，我们得了解一下spring的 <o:p></o:p>webapplicationcontext是个什么东西，从spring-reference.pdf的第九章的得知，每一个 dispatcherservlet都有它的webapplicationcontext，每一个webapplicationcontext都是一个applicationcontext,自然也是一个beanfactory，源码分析<o:p></o:p>

<o:p> </o:p>

java 代码

public interface WebApplicationContext extends ApplicationContext {};//WebApplicationContext 扩展ApplicationContext
public interface ApplicationContext extends ListableBeanFactory, HierarchicalBeanFactory,
        MessageSource, ApplicationEventPublisher, ResourcePatternResolver
//ApplicationContext扩展了BeanFactory

<o:p></o:p>

<o:p> </o:p>

而且，每一个webapplicationcontext有一个 parent webapplicationcontext,这个parent是整个web application的context，自然也是个 beanfactory，这个parent的内容默认是从/web-inf/applicationcontext.xml文件装载,而 dispatcherservlet自己的webapplicationcontext则是从一个叫xxxx-servlet.xml的文件装载的。 xxxx就是在web.xml为dispatcherservlet定义的servlet-name.<o:p></o:p>明白了这层关系，我们再来看 initwebapplicationcontext(),它所做的无非就是生成dispatcherservlet的 webapplicationcontext,同时设置好它的相关属性。我们先来看看它的parent属性是如何设置的。然后再看他自己的 webapplicationcontext内容是如何从xxxx-serlvet.xml里面装载的。<o:p></o:p>

<o:p></o:p>例如 <o:p></o:p>

<servlet><o:p></o:p></servlet>

<servlet-name>

xml 代码

<servlet>
<servlet-name>Dispatcher</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/Config.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>Dispatcher</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>

<o:p>

initwebapplicationcontext()中有这么一句:<o:p></o:p>

webapplicationcontext parent  = webapplicationcontextutils.getwebapplicationcontext(servletcontext);<o:p></o:p>

然后在createwebapplicationcontext()方法中有这么一句:wac.setparent(parent);由此可见， dispatcherservlet的webapplicationcontext的parent是在 initwebapplicationcontext()中得到，然后在createwebapplicationcontext()方法中设置的。好奇的你也许会问，这个parent 实例到底是谁生成的呢，和/web-inf/applicationcontext-hibernate.xml文件有什么关系呢.我们现在就来探讨一下这个问题。在spring工程中打开webapplicationcontextutils的 getwebapplicationcontext()方法中只有那么一句:return (webapplicationcontext) sc.getattribute (webapplicationcontext.root_web_application_context_attribute);也就是说,早就有人在web application的serlvet context里面设置好了这个属性,dispatcherservlet的 initwebapplicationcontext()只是利用webapplicationcontextutils从 servlet context把这个对象按名字检索出来而已。也许你已经按捺不住了，到底是谁设置了这个属性呢。不用急，我们打开web.xml看看，在petclinic servlet的定义之前，还有一个servlet的定义:<o:p></o:p>

<o:p>

java 代码

<servlet>
   <servlet-name>context</servlet-name>
   <servlet-class>org.springframework.web.context.contextloaderservlet</servlet-class>
   <load-on-startup>1</load-on-startup>
</servlet>

<o:p>

相信聪明的你已经从该servlet的名字和条目前面的注释猜出这个parent,也就是web application的root context是由 contextloaderservlet来设置的。没错，从contextloaderservlet的init方法中我们可以发现, contextloaderservlet生成一个contextloader,并且调用其initwebapplicationcontext()方法来设置root context。看看contextloader类，我们的答案都找到了。在其initwebapplicationcontext() 中，首先生成一个applicationcontext作为root context的parent,呵呵，在root context之上没有 context了，这个parent自然是null;而root context本身则在contextloader的 createwebapplicationcontext()方法里设置。该方法的步骤如下:<o:p></o:p>

<o:p></o:p>1.看在web.xml有没有定义定制的 context类(用contextclass参数指出)，如果没有的话，<o:p></o:p>

就用xmlwebapplicationcontext类来作为缺省的 context类。在我们的这个petclinic工程里面，没有使用定制的context类，<o:p></o:p>

自然也就是用 xmlwebapplicationcontext类来作为context类了。<o:p></o:p>

2.利用beanutils来生成一个context实例，在这里也就是一个xmlwebapplicationcontext实例。<o:p></o:p>

3.设置parent属性,也就是null;<o:p></o:p>

4.设置servletcontext属性，该属性还是从contextloaderservlet传过来的。<o:p></o:p>

5.从web.xml中找到参数contextconfiglocation,作为配置文件的路径。我们在web.xml中定义contextconfiglocation的值是<o:p></o:p>

"/web-inf/applicationcontext-hibernate.xml"<o:p></o:p>

6.利用contextconfiglocation属性指出的xml配置文件中的内容刷新生成xmlwebapplicationcontext实例。<o:p></o:p>

<o:p></o:p>呵呵，到此为止，关于web application的root context的出生问题已经搞清楚了，那么到底是谁把这个实例设置为 servlet context的一个attribute的呢@呵呵，聪明的你肯定已经发现了contextloader的 initwebapplicationcontext方法中有这么一句:webapplicationcontextutils.publishwebapplicationcontext (wac);没错，contextloader正是利用webapplicationcontextutils把root context绑定为 servlet context的一个属性的。至于这个属性叫什么名字，我想就不用我多说了。之所以让contextloaderservlet的 load-on-startup=1，就是让这个servlet初始化web application的root context属性，绑定到 servlet context.正如web.xml文中的注释指出的一样，如果你使用满足servlet 2.4规范的容器，你就只需在web.xml 中定义一个contextloaderlistener就行了，而不用使用contextloaderservlet。<o:p></o:p>

<o:p></o:p>饶了这么大一个圈子，我们才明白了dispatcherservlet的webapplicationcontext的parent是如何来的。现在该说说dispatcherservlet的webapplicationcontext本身是如何设置的了。<o:p></o:p>

<o:p></o:p>现在我们来看看frameworkservlet的createwebapplicationcontext()方法。同contextloader的 createwebapplicationcontext()类似的步骤。不同之处在于前者含有wac.setnamespace (getnamespace());语句。通过跟踪getnamespace()我们得到frameworkservlet的namespace属性其实就是字符串"[servletname]-serlvet"(servletname变量在web.xml中定义，对我们的工程而言就是Dispatcher)。<o:p></o:p>

<o:p></o:p>

java 代码

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

public static final String DEFAULT_NAMESPACE_SUFFIX = "-servlet";

<o:p></o:p>

<o:p></o:p>接下来有这么一句:<o:p></o:p>

java 代码

if (this.contextconfiglocation != null){
 wac.setconfiglocations(webapplicationcontextutils.parsecontextconfiglocation(this.contextconfiglocation));

<o:p></o:p>

<o:p> </o:p>

这个if语句会不会执行呢@也就是说frameworkservlet的私有属性contextconfiglocation是不是为空呢@也就是有没有人给frameworkservlet初始化这个属性呢@答案就在于frameworkservlet的父类httpservletbean的init() 方法中，里面有这么一句propertyvalues pvs = new servletconfigpropertyvalues (getservletconfig(), this.requiredproperties);仔细研究 servletconfigpropertyvalues()方法就知道，如果你在web.xml给dispatcherservlet定义 init-param参数contextconfiglocation的话(形式通常是诸如/web-inf/test-servlet.xml,  /web-inf/myservlet.xml),父类方法init()中就会给frameworkservlet初始化这个属性.<o:p></o:p>

在我们的工程并没有定义这个init-param参数,因此前面所说的if语句不会执行了。也就是frameworkservlet的 createwebapplicationcontext()方法中的wac只是初始化了属性namespace,而没有初始化 contextconfiglocation.接下来是wac.refresh();通过查看这个方法的源码(在 xmlwebapplicationcontext类中)我们就知道，在没有给xmlwebapplicationcontext初始化 contextconfiglocation属性的情况下，它会从namespace属性指出的xml配置文件中装载beandefinitions，我们的工程而言就是Dispatcher-servlet.xml文件。<o:p></o:p>

<o:p> </o:p>

至此为止,我们的 webapplicationcontext终于生成了。回到frameworkservlet的initwebapplicationcontext ()方法，我们可以发现，

这个生成的webapplicationcontext以 org.springframework.web.servlet.Frameworkservlet.CONTEXT.为key保存在servletcontext里面.<o:p></o:p>

<o:p></o:p>

评论

2 楼 liwanfeng 2011-10-13  

看楼上的评价不错，但是格式可能是je改版，现在看格式比较乱啊！实在没心情看了！

1 楼 charles_zuo 2008-05-23  

讲解的很详细，按照LZ的分析看了下源码，条理很清晰，谢谢