Spring MVC深入源码之二FrameworkServlet上篇

2019年4月23日 148次阅读 来源: BlairWaldorf

上一篇讲了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的时候会调用这个钩子方法。

《Spring MVC深入源码之二FrameworkServlet上篇》

这个方法其实非常简单

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

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

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

《Spring MVC深入源码之二FrameworkServlet上篇》

  • 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方法的解释放到下一篇文章里详细说明。

    原文作者：BlairWaldorf
    原文地址: https://www.jianshu.com/p/60249591aa3b
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞