SpringMVC源码探究(一)----初始化源码

    随着软件开发技术的持续发展,框架技术层出不穷。还是那句话,任何框架技术都是对基础技术的封装。所以,真正要学好用好一个框架,研究其源码都是最直接最有效的途径。


    随着Spring技术体系的强势发展,SpringMVC框架在Java Web开发中越来越流行了。接下来我准备就SpringMVC框架源简单写几篇探究文章,一是做个总结,再一个也能够跟大家做一个交流。


    关于SpringMVC源码探究,我准备写三篇文章,分别针对SpringMVC三个最主要功能来进行探究:初始化源码探究、处理请求源码探究、响应源码探究时间原因,探究比较仓促,有不妥之处还望朋友们多多包涵。接下来是第一篇关于SpringMVC初始化源码探究


    所有Java的MVC框架都是基于servlet的,SpringMVC也不例外。它提供核心控制器DispatcherServlet,并且在此Servlet实例化后做出一系列的初始化处理,从而保证后期的高效率运行。在研究源码之前,我们首先看一下DispatcherServlet的继承结构:

    DispatcherServlet继承结构.png

这三个Servlet类是SpringMVC的核心控制器类,各负其职来完成SpringMVC的各项功能。

其中,HttpServletBean主要做一些初始化的工作,将web.xml中配置的参数设置到核心控制器Servlet中,比如servlet标签的初始化参数子标签init-param标签中配置的参数

FrameworkServlet将Servlet与Spring容器上下文关联。其实也就是初始化FrameworkServlet的属性webApplicationContext,这个属性代表SpringMVC上下文,其实也就是spring技术中web.xml配置的ContextLoaderListener监听器初始化的容器上下文,所以我们也说SpringMVC是基于Spring的

DispatcherServlet完成SpringMVC对web请求各个功能的实现。比如请求映射处理、视图处理、异常处理等


    任何web功能的实现都是从web.xml开始的,所以我们先来看看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:springmvc.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>

这里配置了SpringMVC核心处理器,并且传递了参数contextConfigLocation以指定SpringMVC核心配置文件的位置,在服务器启动时进行加载并实例化。


    HttpServletBean覆盖了init()方法,所有初始化处理都是此Servlet实例化之后于init方法中完成的,下面我们就来看看其中三个最主要信息的初始化:读取初始化参数contextConfigLocation、构造SpringMVC容器、创建所有的Bean对象。

public final void init() throws ServletException {
		//......
		PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);//从ServletConfig中获取初始化参数(如contextConfigLocation=classpath:springmvc.xml等)
		if (!pvs.isEmpty()) {
			try {
				BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);//构造BeanWrapper对象,接下来就是由BeanWrapper完成初始化处理
				ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
				bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
				initBeanWrapper(bw);
				bw.setPropertyValues(pvs, true);//把初始化参数contextConfigLocation设置到核心控制器DispatcherServlet的contextConfigLocation属性中.
			}
			catch (BeansException ex) {
				//...
			}
		}
		initServletBean();//这个方法在本类中是空实现,它用来是被子类(FrameworkServlet)覆盖的,在子类中进行构造SpringMVC容器上下文对象,这也是模板设计模式的具体应用。
		//......
	}

    下面先来看BeanWrapper是如何设置初始化参数的:从源码我们会看到,BeanWrapper是个接口,实现类是BeanWrapperImpl,BeanWrapperImpl是AbstractNestablePropertyAccessor的子类,AbstractNestablePropertyAccessor有个属性wrappedObject,保存了核心控制器的引用,那么BeanWrapperImpl类也具有对DispatcherServlet对象的引用。在BeanWrapperImpl中有一个方法setValue()用来保存初始化参数到DispatcherServlet的属性中:

setValue(final Object object, Object valueToApply)
	         //......
			if (System.getSecurityManager() != null) {
				//......
			}
			else {
				writeMethod.invoke(getWrappedInstance(), value);//这里使用反射把获取到的初始化参数contextConfigLocation核心控制器的属性contextConfigLocation。
			}
		//......
	}

    其实,SpringMVC本身能用到的初始化参数也就是contextConfigLocation了。

    

    接下来我们来看看FrameworkServlet类的initServletBean()方法如何构造SpringMVC容器上下文对象:FrameworkServlet是HttpServletBean的子类,它覆盖了initServletBean()方法,主要用来在服务器启动时构造SpringMVC容器上下文对象。

protected final void initServletBean() throws ServletException {
			//......
			try {
				this.webApplicationContext = initWebApplicationContext();//创建出SpringMVC容器对象
				initFrameworkServlet();
			}
			//......
		}

    很显然,调用initWebApplicationContext()方法创建出SpringMVC容器上下文对象之后,保存在了核心控制器的webApplicationContext属性(此属性在父类FrameworkServlet声明)中,以备处理请求时使用。


    进一步,我们不妨来看看具体构造SpringMVC容器上下文的代码:initWebApplicationContext()会调到方法createWebApplicationContext(ApplicationContext parent)来完成:

protected WebApplicationContext createWebApplicationContext(ApplicationContext parent) {
		Class<?> contextClass = getContextClass();//获取SpringMVC容器的类名XmlWebApplicationContext.class
		//......
		ConfigurableWebApplicationContext wac =
				(ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);//使用反射创建SpringMVC容器对象,其实就是这个类org.springframework.web.context.support.XmlWebApplicationContext的对象

		wac.setEnvironment(getEnvironment());
		wac.setParent(parent);
		wac.setConfigLocation(getContextConfigLocation());//把init()中设置的DispatcherServlet的contextConfigLocation属性(保存着SpringMVC核心配置文件的位置)交给SpringMVC容器,所以以后运行过程中SpringMVC能够使用springmvc.xml中所有的配置也就不足为奇了。

		configureAndRefreshWebApplicationContext(wac);//在这个方法中,扫描所有纳入spring管理的类,并且实例化保存到容器中(beanFactory属性中),以备后用。

		return wac;
         }

    

    最后,我们来看一下createWebApplicationContext(ApplicationContext parent)方法时如何扫描所有纳入spring管理的类,并且实例化保存到容器中(beanFactory属性中)的。其它方法的调用我不多说了,其中调到了ComponentScanBeanDefinitionParser类的parse(Element element, ParserContext parserContext)方法,如下:

public BeanDefinition parse(Element element, ParserContext parserContext) {
		String basePackage = element.getAttribute(BASE_PACKAGE_ATTRIBUTE);
		basePackage = parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage);
		String[] basePackages = StringUtils.tokenizeToStringArray(basePackage,
				ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);

		// Actually scan for bean definitions and register them.
		ClassPathBeanDefinitionScanner scanner = configureScanner(parserContext, element);
		Set<BeanDefinitionHolder> beanDefinitions = scanner.doScan(basePackages);//扫描核心配置文件中<context:component-scan base-package=""/>指定的包,得到所有需要创建的Bean信息
		registerComponents(parserContext.getReaderContext(), beanDefinitions, element);//实例化Bean并且在SpringMVC容器的beanFactory属性中进行注册

		return null;
	}


    至此,SpringMVC在服务器启动时所做的最主要的三个初始化处理已经完成,在后期在接收到HTTP请求时就可以及时高效的进行处理。当然,初始化要做的远不止这些,只要是配置文件和注解中涉及到的信息基本上都会在服务器启动时做初始化处理,比如视图解析器等等,限于篇幅原因,不再赘述。所有这些也都可以从SpringMVC源码中找到具体答案,有兴趣的朋友可以继续研究

猜你喜欢

转载自blog.51cto.com/yangfei520/2169389