本文是专栏文章(<a href="http://www.iteye.com/blogs/subjects/springmvc-explore" target="_blank">SpringMVC深度探险</a>)系列的文章之一,博客地址为:<a href="http://downpour.iteye.com/blog/1330596" target="_blank">http://downpour.iteye.com/blog/1330596</a>
对于任何事物的研究,总是由表及里、由浅入深地进行。在本系列的第二篇文章中,我们将通过不同的观察视角,对SpringMVC做一些概要性的分析,帮助大家了解SpringMVC的基本构成要素、SpringMVC的发展历程以及SpringMVC的设计原则。
SpringMVC的构成要素
了解一个框架的首要任务就是搞清楚这个框架的基本构成要素。当然,这里所说的构成要素实际上还可以被挖掘为两个不同的层次:
- 基于框架所编写的应用程序的构成要素
- 框架自身的运行主线以及微观构成要素
在上一篇文章中,我们曾经列举了一段SpringMVC的代码示例,用于说明MVC框架的构成结构。我们在这里不妨将这个示例细化,总结归纳出构成SpringMVC应用程序的基本要素。
1. 指定SpringMVC的入口程序(在web.xml中)
- <!– Processes application requests –>
- <servlet>
- <servlet-name>dispatcher</servlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>dispatcher</servlet-name>
- <url-pattern>/**</url-pattern>
- </servlet-mapping>
<!-- Processes application requests --> <servlet> <servlet-name>dispatcher</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcher</servlet-name> <url-pattern>/**</url-pattern> </servlet-mapping>
以一个Servlet作为入口程序是绝大多数MVC框架都遵循的基本设计方案。这里的DispatcherServlet被我们称之为核心分发器,是SpringMVC最重要的类之一,之后我们会对其单独展开进行分析。
2. 编写SpringMVC的核心配置文件(在[servlet-name]-servlet.xml中)
- <beans xmlns=”http://www.springframework.org/schema/beans”
- xmlns:mvc=”http://www.springframework.org/schema/mvc”
- xmlns:context=”http://www.springframework.org/schema/context”
- xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
- xsi:schemaLocation=”
- http://www.springframework.org/schema/beans
- http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
- http://www.springframework.org/schema/context
- http://www.springframework.org/schema/context/spring-context-3.1.xsd
- http://www.springframework.org/schema/mvc
- http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd“
- default-autowire=“byName”>
- <!– Enables the Spring MVC @Controller programming model –>
- <mvc:annotation-driven />
- <context:component-scan base-package=“com.demo2do” />
- <bean class=“org.springframework.web.servlet.view.InternalResourceViewResolver”>
- <property name=“prefix” value=“/” />
- <property name=“suffix” value=“.jsp” />
- </bean>
- </beans>
<beans xmlns=”http://www.springframework.org/schema/beans”
xmlns:mvc=”http://www.springframework.org/schema/mvc”
xmlns:context=”http://www.springframework.org/schema/context”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
xsi:schemaLocation=”
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.1.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd”
default-autowire=”byName”>
<!-- Enables the Spring MVC @Controller programming model -->
<mvc:annotation-driven />
<context:component-scan base-package="com.demo2do" />
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
SpringMVC自身由众多不同的组件共同构成,而每一个组件又有众多不同的实现模式。这里的SpringMVC核心配置文件是定义SpringMVC行为方式的一个窗口,用于指定每一个组件的实现模式。有关SpringMVC组件的概念,在之后的讨论中也会涉及。
3. 编写控制(Controller)层的代码
- @Controller
- @RequestMapping
- public class UserController {
- @RequestMapping(“/login”)
- public ModelAndView login(String name, String password) {
- // write your logic here
- return new ModelAndView(“success”);
- }
- }
@Controller
@RequestMapping
public class UserController {
@RequestMapping("/login")
public ModelAndView login(String name, String password) {
// write your logic here
return new ModelAndView("success");
}
}
控制(Controller)层的代码编写在一个Java文件中。我们可以看到这个Java文件是一个普通的Java类并不依赖于任何接口。只是在响应类和响应方法上使用了Annotation的语法将它与Http请求对应起来。
从这个例子中,我们实际上已经归纳了构成基于SpringMVC应用程序的最基本要素。它们分别是:
- 入口程序 —— DispatcherServlet
- 核心配置 —— [servlet-name]-servlet.xml
- 控制逻辑 —— UserController
基于SpringMVC的应用程序能够表现为现在这个样子,经历了一个不断重构不断改造的过程。接下来的讨论,我们就来试图为大家揭秘这个过程。
SpringMVC的发展历程
在上一篇文章中,我们曾经讨论过MVC的发展轨迹。当时我们总结了一个MVC框架的发展轨迹图:
![](http://dl.iteye.com/upload/attachment/617515/93e16090-54df-3ef2-a318-3b710a59db40.png)
从图中我们可以发现,所有的MVC框架都是从基本的Servlet模型发展而来。因此,要了解SpringMVC的发展历程,我们还是从最基本的Servlet模型开始,探究SpringMVC对于Servlet模型的改造过程中究竟经历了哪些阶段、碰到了哪些问题、并看看SpringMVC是如何解决这些问题的。
【核心Servlet的提炼】
在Servlet模型中,请求-响应的实现依赖于两大元素的共同配合:
1. 配置Servlet及其映射关系(在web.xml中)
- <servlet>
- <servlet-name>registerServlet</servlet-name>
- <servlet-class>com.demo2do.springmvc.web.RegisterServlet</servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>registerServlet</servlet-name>
- <url-pattern>/register</url-pattern>
- </servlet-mapping>
<servlet>
<servlet-name>registerServlet</servlet-name>
<servlet-class>com.demo2do.springmvc.web.RegisterServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>registerServlet</servlet-name>
<url-pattern>/register</url-pattern>
</servlet-mapping>
在这里,<url-pattern>定义了整个请求-响应的映射载体:URL;而<servlet-name>则将<servlet>节点和<servlet-mapping>节点联系在一起形成请求-响应的映射关系;<servlet-class>则定义了具体进行响应的Servlet实现类。
2. 在Servlet实现类中完成响应逻辑
- public class RegisterServlet extends HttpServlet {
- @Override
- protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
- // 从request获取参数
- String name = req.getParameter(”name”);
- String birthdayString = req.getParameter(”birthday”);
- // 做必要的类型转化
- Date birthday = null;
- try {
- birthday = new SmpleDateFormat(“yyyy-MM-dd”).parse(birthdayString);
- } catch (ParseException e) {
- e.printStackTrace();
- }
- // 初始化User类,并设置字段到user对象中去
- User user = new User();
- user.setName(name);
- user.setBirthday(birthday);
- // 调用业务逻辑代码完成注册
- UserService userService = new UserService();
- userService.register(user);
- // 设置返回数据
- request.setAttribute(”user”, user);
- // 返回成功页面
- req.getRequestDispatcher(”/success.jsp”).forward(req, resp);
- }
- }
public class RegisterServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 从request获取参数
String name = req.getParameter("name");
String birthdayString = req.getParameter("birthday");
// 做必要的类型转化
Date birthday = null;
try {
birthday = new SmpleDateFormat("yyyy-MM-dd").parse(birthdayString);
} catch (ParseException e) {
e.printStackTrace();
}
// 初始化User类,并设置字段到user对象中去
User user = new User();
user.setName(name);
user.setBirthday(birthday);
// 调用业务逻辑代码完成注册
UserService userService = new UserService();
userService.register(user);
// 设置返回数据
request.setAttribute("user", user);
// 返回成功页面
req.getRequestDispatcher("/success.jsp").forward(req, resp);
}
}
Servlet实现类本质上是一个Java类。通过Servlet接口定义中的HttpServletRequest对象,我们可以处理整个请求生命周期中的数据;通过HttpServletResponse对象,我们可以处理Http响应行为。
整个过程并不复杂,因为作为一个底层规范,所规定的编程元素和实现方式应该尽可能直观和简单。在这一点上,Servlet规范似乎可以满足我们的要求。如果将上述过程中的主要过程加以抽象,我们可以发现有两个非常重要概念蕴含在了Servlet的规范之中:
![](http://dl.iteye.com/upload/attachment/0062/3728/a7de7025-2205-33bf-b55a-8158751f980e.png)
控制流和数据流的问题几乎贯穿了所有MVC框架的始末,因而我们不得不在这里率先提出来,希望对读者有一些警示作用。
注:对于控制流和数据流的相关概念,请参考另外一篇博客:《Struts2技术内幕》 新书部分篇章连载(五)—— 请求响应哲学。这一对概念,几乎是所有MVC框架背后最为重要的支撑,读者应该尤其重视!
所有MVC框架的核心问题也由控制流和数据流这两大体系延伸开来。比如,在Servlet编程模型之下,“请求-响应映射关系的定义”这一问题就会随着项目规模的扩大而显得力不从心:
针对这个问题,SpringMVC提出的方案就是: 提炼一个核心的Servlet覆盖对所有Http请求的处理。。
这一被提炼出来的Servlet,通常被我们称之为: 核心分发器。在SpringMVC中,核心分发器就是 org.springframework.web.servlet.DispatcherServlet。
注:核心分发器的概念并非SpringMVC独创。我们可以看到,核心分发器的提炼几乎是所有MVC框架设计中的必经之路。在Struts2中,也有核心分发器(Dispatcher)的概念,只是它并不以Servlet的形式出现。因此,读者应该把关注点放在核心分发器这个概念的提炼之上,而不是纠结于其形式。
有了DispatcherServlet,我们至少从表面上解决了上面的问题。至少在web.xml中,我们的配置代码就被固定了下来:
- <!– Processes application requests –>
- <servlet>
- <servlet-name>dispatcherServlet</servlet-name>
- <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>dispatcherServlet</servlet-name>
- <url-pattern>/**</url-pattern>
- </servlet-mapping>
<!– Processes application requests –>
<servlet>
<servlet-name>dispatcherServlet</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>dispatcherServlet</servlet-name>
<url-pattern>/**</url-pattern>
</servlet-mapping>
有了DispatcherServlet,我们只相当于迈出了坚实的第一步,因为对核心Servlet的提炼不仅仅是将所有的Servlet集中在一起那么简单,我们还将面临两大问题:
而这两大问题的解决,涉及到了DispatcherServlet的设计核心。我们也不得不引入另外一个重要的编程元素,那就是: 组件。
【组件的引入】
DispatcherServlet的引入是我们通过加入新的编程元素来对基本的Servlet规范进行抽象概括所迈出的第一步。不过接下来,有关DispatcherServlet的设计问题又一次摆到了我们的面前。
如果仔细分析一下上一节末尾所提出的两个问题,我们可以发现这两个问题实际上都涉及到了DispatcherServlet的处理过程,这一处理过程首先必须是一剂万能药,能够处理所有的Http请求;同时,DispatcherServlet还需要完成不同协议之间的转化工作(从Http协议到Java世界的转化)。
对此,SpringMVC所提出的方案是: 将整个处理流程规范化,并把每一个处理步骤分派到不同的组件中进行处理。
这个方案实际上涉及到两个方面:
- 处理流程规范化 —— 将处理流程划分为若干个步骤(任务),并使用一条明确的逻辑主线将所有的步骤串联起来
- 处理流程组件化 —— 将处理流程中的每一个步骤(任务)都定义为接口,并为每个接口赋予不同的实现模式
处理流程规范化是目的,对于处理过程的步骤划分和流程定义则是手段。因而处理流程规范化的首要内容就是考虑一个通用的Servlet响应程序大致应该包含的逻辑步骤:
- 步骤1 —— 对Http请求进行初步处理,查找与之对应的Controller处理类(方法)
- 步骤2 —— 调用相应的Controller处理类(方法)完成业务逻辑
- 步骤3 —— 对Controller处理类(方法)调用时可能发生的异常进行处理
- 步骤4 —— 根据Controller处理类(方法)的调用结果,进行Http响应处理
所谓的程序化,实际上也就是使用编程语言将这些逻辑语义表达出来。在Java语言中,最适合表达逻辑处理语义的语法结构是 接口,因此上述的四个流程也就被定义为了四个不同接口,它们分别是:
- 步骤1 —— HandlerMapping
- 步骤2 —— HandlerAdapter
- 步骤3 —— HandlerExceptionResolver
- 步骤4 —— ViewResolver
除了上述组件之外,SpringMVC所定义的组件几乎涵盖了每一个处理过程中的重要节点。我们在这里引用Spring官方reference中对于最基本的组件的一些说明:
![点击查看原始大小图片](http://dl.iteye.com/upload/attachment/0062/3735/bcd4f964-d766-3981-b703-f8b635e5d505.png)
我们在下一篇文章中将重点对这里所提到的所有组件做深入的分析。大家在这里需要理解的是SpringMVC定义这些组件的目的和初衷。
这些组件一旦被定义,自然而然也就引出了下一个问题:这些组件是如何串联在一起的?这个过程,是在DispatcherServlet中完成的。有关这一点,我们可以从两个不同的角度加以证明。
1. 从DispatcherServlet自身数据结构的角度
![](http://dl.iteye.com/upload/attachment/0062/3799/5066c9c3-3958-36f1-b1c2-1bcbb335491b.png)
如图中所示,DispatcherServlet中包含了众多SpringMVC的组件,这些组件是实现DispatcherServlet核心逻辑的基础。
2. 从DispatcherServlet的核心源码的角度
- try {
- // 这里省略了部分代码
- // 获取HandlerMapping组件返回的执行链
- mappedHandler = getHandler(processedRequest, false);
- if (mappedHandler == null || mappedHandler.getHandler() == null) {
- noHandlerFound(processedRequest, response);
- return;
- }
- // 获取HandlerAdapter组件
- HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
- // 这里省略了部分源码
- // 调用HandlerAdapter组件
- mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
- // 这里省略了部分源码
- }catch (ModelAndViewDefiningException ex) {
- logger.debug(”ModelAndViewDefiningException encountered”, ex);
- mv = ex.getModelAndView();
- }catch (Exception ex) {
- Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);
- // 调用HandlerExceptionResolver进行异常处理
- mv = processHandlerException(processedRequest, response, handler, ex);
- errorView = (mv != null);
- }
try {
// 这里省略了部分代码
// 获取HandlerMapping组件返回的执行链
mappedHandler = getHandler(processedRequest, false);
if (mappedHandler == null || mappedHandler.getHandler() == null) {
noHandlerFound(processedRequest, response);
return;
}
// 获取HandlerAdapter组件
HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
// 这里省略了部分源码
// 调用HandlerAdapter组件
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
// 这里省略了部分源码
}catch (ModelAndViewDefiningException ex) { logger.debug(“ModelAndViewDefiningException encountered”, ex); mv = ex.getModelAndView(); }catch (Exception ex) { Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null); // 调用HandlerExceptionResolver进行异常处理 mv = processHandlerException(processedRequest, response, handler, ex); errorView = (mv != null); }
从上面的代码片段中,我们可以看到DispatcherServlet的核心逻辑不过是对组件的获取和调用。
除此之外,SpringMVC对处理流程的规范化和组件化所引出的另外一个问题就是如何针对所有的组件进行 管理。
先说说管理。其实管理这些组件对于SpringMVC来说完全不是问题,因为SpringMVC作为Spring Framework的一部分,其自身的运行环境就是Spring所定义的容器之中。我们知道,Spring Framework的核心作用之一就是对整个应用程序的组件进行管理。所以SpringMVC对于这些已定义组件的管理,只不过是借用了Spring自身已经提供的容器功能而已。
注:SpringMVC在进行组件管理时,会单独为SpringMVC相关的组件构建一个容器环境,这一容器环境可以独立于应用程序自身所创建的Spring容器。有关这一点,我们在之后的讨论中将详细给出分析。
而SpringMVC对这些组件的管理载体,就是我们在上一节中所提到的 核心配置文件。我们可以看到,核心配置文件在整个SpringMVC的构成要素中占有一席之地的重要原因就是在于: 我们必须借助一个有效的手段对整个SpringMVC的组件进行定义,而这一点正是通过核心配置文件来完成的。
如果我们把上面的整个过程重新梳理一下,整个逻辑看起来就像这样:
![](http://dl.iteye.com/upload/attachment/0062/3805/38f796af-0541-3de5-93d2-32e02a638181.png)
这四个方面的内容,我们是顺着设计思路的不断推进而总结归纳出来的。这也恰好证明之前所提到的一个重要观点,我们在这里强调一下:
【行为模式的扩展】
有了组件,也有了DispatcherServlet对所有组件的串联,我们之前所提出的两个问题似乎已经可以迎刃而解。所以,我们可以说:
在引入组件这个概念的时候,我们所强调的是处理流程的抽象化,因而所有组件的外在表现形式是接口。接口最重要意义是定义操作规范,所以接口用来表达每一个处理单元的逻辑语义是最合适不过的。但光有接口,并不能完整地构成一个框架的行为模式。 从操作规范到行为模式的变化,是由接口所对应的实现类来完成的。
在Java语言中,一个接口可以有多个不同的实现类,从而构成一个树形的实现体系。而每一个不同的实现分支,实际上代表的是对于相同的逻辑语义的不同解读方式。结合上面我们的描述,也可以说: 一个接口的每一个不同的实现分支,代表了相同操作规范的不同行为模式。
我们可以通过之前曾经提到过的一个SpringMVC组件HandlerMapping为例进行说明。
![](http://dl.iteye.com/upload/attachment/0062/3905/b8333d33-aa53-3c70-9870-b1cfb4ebf854.png)
上图就是HandlerMapping接口的树形实现体系。在这个实现体系结构中,每一个树形结构的末端实现都是SpringMVC中比较具有典型意义的行为模式。我们可以截取其中的几个实现来加以说明:
- BeanNameUrlHandlerMapping —— 根据Spring容器中的bean的定义来指定请求映射关系
- SimpleUrlHandlerMapping —— 直接指定URL与Controller的映射关系,其中的URL支持Ant风格
- DefaultAnnotationHandlerMapping —— 支持通过直接扫描Controller类中的Annotation来确定请求映射关系
- RequestMappingHandlerMapping —— 通过扫描Controller类中的Annotation来确定请求映射关系的另外一个实现类
注:我们在这里之所以要强调不同版本的Spring官方文档的原因在于这些不同的实现类,正代表了不同版本SpringMVC在默认行为模式上选择的不同。在下图中,我们列出了不同重大版本的SpringMVC的实现体系结构,并用红色框圈出了每个版本默认的实现类。
![点击查看原始大小图片](http://dl.iteye.com/upload/attachment/0062/4035/7791ba91-af53-3d43-bdaf-a8d2d8ad16ee.png)
我们可以看到,上述这些不同的HandlerMapping的实现类,其运行机制和行为模式完全不同。这也就意味着对于HandlerMapping这个组件而言,可以进行选择的余地就很大。我们既可以选择其中的一种实现模式作为默认的行为模式,也可以将这些实现类依次串联起来成为一个执行链。不过这已经是实现层面和设计模式上的小技巧了。
单就HandlerMapping一个组件,我们就能看到各种不同的行为模式。如果我们将逻辑主线中所有的组件全部考虑进来,那么整个实现机制就会随着这些组件实现体系的不同而表现出截然不同的行为方式了。因此,我们的结论是:
有关SpringMVC的各种组件和实现体系,我们将在之后的讨论中详细展开。
SpringMVC的设计原则
最后我们来讨论一下SpringMVC的设计原则。任何框架在设计的时候都必须遵循一些基本的原则,而这些原则也成为整个框架的理论基础。对于那些有一定SpringMVC使用经验的程序员来说,这些基本的设计原则本身也一定是给大家留下深刻印象的那些闪光点,所以我们非常有必要在这里加以总结。
【Open for extension / closed for modification】
这条重要的设计原则被写在了Spring官方的reference中SpringMVC章节的起始段:
SpringMVC在整个官方reference的起始就强调这一原则,可见其对于整个框架的重要性。那么我们又如何来理解这段话的含义呢?笔者在这里从源码的角度归纳了四个方面:
1. 使用final关键字来限定核心组件中的核心方法
有关这一点,我们还可以在Spring官方的reference中找到非常明确的说明:
在SpringMVC的源码中,HandlerAdapter实现类RequestMappingHandlerAdapter中,核心方法handleInternal就被定义为final:
![](http://dl.iteye.com/upload/attachment/0062/4464/0ca0e53f-af29-373b-bab6-e93ef5c3bc9b.png)
2. 大量地在核心组件中使用private方法
我们依然以SpringMVC默认的HandlerAdapter实现RequestMappingHandlerAdapter为例进行说明:
![](http://dl.iteye.com/upload/attachment/0062/4466/27d44927-8d82-36b1-92c4-6a653c991e7a.png)
可以看到,几乎所有的核心处理方法全部被定义成了带有红色标记的private方法,这就充分表明了SpringMVC对于“子类扩展”这种方式的态度:
3. 限定某些类对外部程序不可见
有关这一点,有好几个类可以加以证明,我们不妨来看看它们的源码定义:
- class AnnotationDrivenBeanDefinitionParser implements BeanDefinitionParser {
- // 这里省略了所有的代码
- }
- class DefaultServletHandlerBeanDefinitionParser implements BeanDefinitionParser {
- // 这里省略了所有的代码
- }
- class InterceptorsBeanDefinitionParser implements BeanDefinitionParser {
- // 这里省略了所有的代码
- }
- class ResourcesBeanDefinitionParser implements BeanDefinitionParser {
- // 这里省略了所有的代码
- }
class AnnotationDrivenBeanDefinitionParser implements BeanDefinitionParser {
// 这里省略了所有的代码
}
class DefaultServletHandlerBeanDefinitionParser implements BeanDefinitionParser {
// 这里省略了所有的代码
}
class InterceptorsBeanDefinitionParser implements BeanDefinitionParser {
// 这里省略了所有的代码
}
class ResourcesBeanDefinitionParser implements BeanDefinitionParser {
// 这里省略了所有的代码
}
在这些类的定义中,我们并未看到public修饰符。也就是说,这些类只能在SpringMVC的内部被调用,对于框架以外的应用程序是不可见的。有关这些类的作用,我们将在之后的讨论中详细展开。
4. 提供自定义扩展接口,却不提供完整覆盖默认行为的方式
这一点,需要深入到SpringMVC的请求处理内部才能够体会得到,我们在这里截取了其中的一段源码加以说明:
- private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
- List<HandlerMethodArgumentResolver> resolvers = new ArrayList<HandlerMethodArgumentResolver>();
- // Annotation-based argument resolution
- resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
- resolvers.add(new RequestParamMapMethodArgumentResolver());
- resolvers.add(new PathVariableMethodArgumentResolver());
- resolvers.add(new ServletModelAttributeMethodProcessor(false));
- resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters()));
- resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters()));
- resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
- resolvers.add(new RequestHeaderMapMethodArgumentResolver());
- resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
- resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
- // Type-based argument resolution
- resolvers.add(new ServletRequestMethodArgumentResolver());
- resolvers.add(new ServletResponseMethodArgumentResolver());
- resolvers.add(new HttpEntityMethodProcessor(getMessageConverters()));
- resolvers.add(new RedirectAttributesMethodArgumentResolver());
- resolvers.add(new ModelMethodProcessor());
- resolvers.add(new MapMethodProcessor());
- resolvers.add(new ErrorsMethodArgumentResolver());
- resolvers.add(new SessionStatusMethodArgumentResolver());
- resolvers.add(new UriComponentsBuilderMethodArgumentResolver());
- // Custom arguments
- if (getCustomArgumentResolvers() != null) {
- resolvers.addAll(getCustomArgumentResolvers());
- }
- // Catch-all
- resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
- resolvers.add(new ServletModelAttributeMethodProcessor(true));
- return resolvers;
- }
private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
List<HandlerMethodArgumentResolver> resolvers = new ArrayList<HandlerMethodArgumentResolver>();
// Annotation-based argument resolution
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));
resolvers.add(new RequestParamMapMethodArgumentResolver());
resolvers.add(new PathVariableMethodArgumentResolver());
resolvers.add(new ServletModelAttributeMethodProcessor(false));
resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters()));
resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters()));
resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));
resolvers.add(new RequestHeaderMapMethodArgumentResolver());
resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));
resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));
// Type-based argument resolution
resolvers.add(new ServletRequestMethodArgumentResolver());
resolvers.add(new ServletResponseMethodArgumentResolver());
resolvers.add(new HttpEntityMethodProcessor(getMessageConverters()));
resolvers.add(new RedirectAttributesMethodArgumentResolver());
resolvers.add(new ModelMethodProcessor());
resolvers.add(new MapMethodProcessor());
resolvers.add(new ErrorsMethodArgumentResolver());
resolvers.add(new SessionStatusMethodArgumentResolver());
resolvers.add(new UriComponentsBuilderMethodArgumentResolver());
// Custom arguments
if (getCustomArgumentResolvers() != null) {
resolvers.addAll(getCustomArgumentResolvers());
}
// Catch-all
resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), true));
resolvers.add(new ServletModelAttributeMethodProcessor(true));
return resolvers;
}
这是RequestMappingHandlerAdapter内部的一个重要方法,用以获取所有的参数处理实现类(HandlerMethodArgumentResolver)。从源码中,我们可以看到虽然这个方法是一个private的方法,但是它在源码中却提供了getCustomArgumentResolvers()方法作为切入口,允许用户自行进行扩展。不过我们同样可以发现,用户自定义的扩展类,只是被插入到整个寻址过程中,并不能通过用户自定义的扩展类来实现对其他HandlerMethodArgumentResolver行为的覆盖;也不能改变HandlerMethodArgumentResolver的处理顺序。也就是说:
上述这四个方面,都是这一条设计原则在源码级别的佐证。或许有的读者会产生这样的疑虑:这个不能改,那个也不能改,我们对于SpringMVC的使用岂不是丧失了很多灵活性?这个疑虑的确存在,但是只说对了一半。因为SpringMVC的这一条设计原则说的是: 不能动其根本,只能在一定范围内进行扩展。
至于说到SpringMVC为什么会基于这样一条设计原则,这里面的原因很多。除了之前所提到的编程模型和组件模型的影响,其中更加牵涉到一个编程哲学的取向问题。有关这一点,我们在之后的文章中将陆续展开。
【形散神不散】
这一条编程原则实际上与上一条原则只是在表达方式上有所不同,其表达的核心意思是比较类似的。那么我们如何来定义这里的“形”和“神”呢?
- 神 —— SpringMVC总是沿着一条固定的逻辑主线运行
- 形 —— SpringMVC却拥有多种不同的行为模式
我们在之前有关组件的讨论中,已经见识到了组件的实现体系,也领略了在不同的SpringMVC版本中,组件的行为模式的不同。这些已经能够充分证明“形散”的事实。接下来,我们再通过源码来证明一下“神不散”:
![点击查看原始大小图片](http://dl.iteye.com/upload/attachment/0062/4635/61c47726-1b41-3d12-a050-f76dc396c24f.png)
图中的代码是DispatcherServlet中的核心方法doDispatch,我们这里使用了比较工具将Spring3.1中的实现代码和Spring2.0.8中的实现代码做了比较,其中的区别之处比较工具使用了不同的颜色标注了出来。
我们可以很明显地看到,虽然Spring2.0到Spring3.1之间,SpringMVC的行为方式已经有了翻天覆地的变化,然而整个DispatcherServlet的核心处理主线却并没有很大的变化。这种稳定性,恰巧证明了整个SpringMVC的体系结构设计的精妙之处。
【简化、简化、还是简化】
在Spring2.5之前的SpringMVC版本并没有很强的生命力,因为它只是通过组件将整个MVC的概念加以诠释,从开发流程的简易度来看并没有很明显的提升。有关SpringMVC发展的里程碑,我们将在下一篇文章中重点讲述。我们在这里想要谈到的SpringMVC的另外一大设计原则,实际上主要是从Spring2.5这个版本之后才不断显现出来的。这条设计原则可以用2个字来概括: 简化。
这里说的简化,其实包含的内容非常广泛。笔者在这里挑选了两个比较重要的方面来进行说明:
- Annotation —— 简化各类配置定义
- Schema Based XML —— 简化组件定义
从这个结论中,我们可以看到一层潜在的意思: 在Annotation出现之前,Java自身语法所定义的编程元素已经不足以表达足够多的信息或者逻辑语义。在这种情况下,过去经常使用的方法是引入新的编程元素(例如使用最多的就是XML形式的结构化配置文件)来对Java程序进行补充说明。而在Annotation出现之后,可以在一定程度上有效解决这一问题。因此Annotation在很长一段时间都被当作是XML配置文件的替代品。
这也就是Annotation经常被用来和XML进行比较的原因。孰优孰劣其实还是要视具体情况而定,并没有什么标准答案。不过我们在这里想强调的是Annotation在整个SpringMVC中所起到的作用,并非仅仅是代替XML那么简单。我们归纳了有三个不同的方面:
1. 简化请求映射的定义
在Spring2.5之前,所有的Http请求与Controller核心处理器之间的映射关系都是在XML文件中定义的。作为XML配置文件的有效替代品,Annotation接过了定义映射关系的重任。我们可以将@RequestMapping加在Controller的class-level和method-level进行Http请求的抽象。
2. 消除Controller对接口的依赖
在Spring2.5之前,SpringMVC规定所有的Controller都必须实现Controller接口:
- public interface Controller {
- /*
- Process the request and return a ModelAndView object which the DispatcherServlet
- will render. A <code>null</code> return value is not an error: It indicates that
- this object completed request processing itself, thus there is no ModelAndView
- to render.
- @param request current HTTP request
- @param response current HTTP response
- @return a ModelAndView to render, or <code>null</code> if handled directly
- @throws Exception in case of errors
- /
- ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
- }
public interface Controller {
/**
* Process the request and return a ModelAndView object which the DispatcherServlet
* will render. A <code>null</code> return value is not an error: It indicates that
* this object completed request processing itself, thus there is no ModelAndView
* to render.
* @param request current HTTP request
* @param response current HTTP response
* @return a ModelAndView to render, or <code>null</code> if handled directly
* @throws Exception in case of errors
*/
ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}
也就是说,应用程序不得不严重依赖于接口所规定的处理模式。而我们看到Controller接口除了对处理接口的返回值做了一次封装以外,我们依然需要面对原生的HttpServletRequest和HttpServletResponse对象进行操作。
而在Spring2.5之后,我们可以通过@Controller来指定SpringMVC可识别的Controller,彻底消除了对接口的依赖:
- @Controller
- public class UserController {
- // 这里省略了许多代码
- }
@Controller
public class UserController {
// 这里省略了许多代码
}
3. 成为框架进行逻辑处理的标识
之前已经谈到,Annotation主要被用于对编程元素进行补充说明。因而Spring就利用这一特性,使得那些被加入了特殊Annotation的编程元素可以得到特殊的处理。例如,SpringMVC引入的@SessionAttribute、@RequestBody、@ModelAttribute等等,可以说既是对Controller的一种逻辑声明,也成为了框架本身对相关元素进行处理的一个标识符。
再谈谈Schema Based XML。Schema Based XML并不是一个陌生的概念,早在Spring2.0时代就被用于进行XML配置的简化。SpringMVC在进入到3.0版本之后,正式将其引入并作为SpringMVC组件定义的一个重要手段。
在XML中引入Schema,只需要在XML文件的开头加入相关的定义。例如:
- <beans xmlns=“http://www.springframework.org/schema/beans”
- xmlns:mvc=“http://www.springframework.org/schema/mvc”
- xmlns:context=“http://www.springframework.org/schema/context”
- xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance”
- xsi:schemaLocation=”
- http://www.springframework.org/schema/beans
- http://www.springframework.org/schema/beans/spring-beans-3.1.xsd
- http://www.springframework.org/schema/context
- http://www.springframework.org/schema/context/spring-context-3.1.xsd
- http://www.springframework.org/schema/mvc
- http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd”>
- </beans>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd"> </beans>
而Schema的具体处理,则位于Spring的JAR中的/META-INF/spring.handlers文件中进行定义:
- http://www.springframework.org/schema/mvc=org.springframework.web.servlet.config.MvcNamespaceHandler
http://www.springframework.org/schema/mvc=org.springframework.web.servlet.config.MvcNamespaceHandler
我们会在之后的讨论中详细分析MvcNamespaceHandler的源码。不过我们可以明确的是,在我们使用Schema Based XML的同时,有许多SpringMVC的内置对象会被预先定义成为组件,我们的配置将是对这些预先定义好的组件的一个 二次配置的过程。可以想象,二次配置一定会比较省力,因为它至少省去了很多内置对象的定义过程。这也就是Schema Based XML带来的简化效果了。
小结
本文从逻辑上讲,可以分成三个部分:
- SpringMVC的构成要素 —— 是什么 —— 阐述框架的主体结构
- SpringMVC的发展历程 —— 为什么 —— 阐述框架各要素产生的内因
- SpringMVC的设计原则 —— 怎么样 —— 阐述框架的共性思想
“为什么”是框架的存在基础。我们可以看到,整个SpringMVC的发展历程是一个对于开发模式不断进行优化的过程,也是不断解决Web开发中所面临的一个又一个问题的过程。之前我们也曾经提到过一个重要观点: 任何框架无所谓好与坏、优与劣,它们只是在不同的领域解决问题的方式不同。所以,我们分析这些SpringMVC基本构成要素产生的原因实际上也是对整个Web开发进行重新思考的过程。
“怎么样”是一种深层次的需求。对于SpringMVC而言,了解其基本构成和用法并不是一件难事,但是要从中提炼并总结出一些共性的东西就需要我们能够站在一个更高的高度来进行分析。也只有了解了这些共性的东西,我们才能进一步总结出使用框架的最佳实践。
读到这里,希望读者能够回味一下本文的写作思路,并且能够举一反三将这种思考问题的方式运用到其他一些框架的学习中去。这样,本文的目的也就达到了。