Spring MVC 详解

  1. 云栖社区>
  2. 博客>
  3. 正文

Spring MVC 详解

ghost丶桃子 2016-05-19 14:52:44 浏览5409
展开阅读全文

第一章 Web MVC简介
Web MVC简介

1.1、Web开发中的请求-响应模型:

 

在Web世界里,具体步骤如下:

1、  Web浏览器(如IE)发起请求,如访问http://sishuok.com

2、  Web服务器(如Tomcat)接收请求,处理请求(比如用户新增,则将把用户保存一下),最后产生响应(一般为html)。

3、web服务器处理完成后,返回内容给web客户端(一般就是我们的浏览器),客户端对接收的内容进行处理(如web浏览器将会对接收到的html内容进行渲染以展示给客户)。

 

因此,在Web世界里:

都是Web客户端发起请求,Web服务器接收、处理并产生响应。

 

一般Web服务器是不能主动通知Web客户端更新内容。虽然现在有些技术如服务器推(如Comet)、还有现在的HTML5 websocket可以实现Web服务器主动通知Web客户端。

 

到此我们了解了在web开发时的请求/响应模型,接下来我们看一下标准的MVC模型是什么。

 

1.2、标准MVC模型概述

MVC模型:是一种架构型的模式,本身不引入新功能,只是帮助我们将开发的结构组织的更加合理,使展示与模型分离、流程控制逻辑、业务逻辑调用与展示逻辑分离。如图1-2

 

图1-2

首先让我们了解下MVC(Model-View-Controller)三元组的概念:

Model(模型):数据模型,提供要展示的数据,因此包含数据和行为,可以认为是领域模型或JavaBean组件(包含数据和行为),不过现在一般都分离开来:Value Object(数据) 和 服务层(行为)。也就是模型提供了模型数据查询和模型数据的状态更新等功能,包括数据和业务。

 

View(视图):负责进行模型的展示,一般就是我们见到的用户界面,客户想看到的东西。

 

Controller(控制器):接收用户请求,委托给模型进行处理(状态改变),处理完毕后把返回的模型数据返回给视图,由视图负责展示。 也就是说控制器做了个调度员的工作,。

 

从图1-1我们还看到,在标准的MVC中模型能主动推数据给视图进行更新(观察者设计模式,在模型上注册视图,当模型更新时自动更新视图),但在Web开发中模型是无法主动推给视图(无法主动更新用户界面),因为在Web开发是请求-响应模型。

 

那接下来我们看一下在Web里MVC是什么样子,我们称其为 Web MVC 来区别标准的MVC。

1.3、Web MVC概述

模型-视图-控制器概念和标准MVC概念一样,请参考1.2,我们再看一下Web MVC标准架构,如图1-3:

 

如图1-3

 

在Web MVC模式下,模型无法主动推数据给视图,如果用户想要视图更新,需要再发送一次请求(即请求-响应模型)。

 

概念差不多了,我们接下来了解下Web端开发的发展历程,和使用代码来演示一下Web MVC是如何实现的,还有为什么要使用MVC这个模式呢?

 

1.4、Web端开发发展历程

此处我们只是简单的叙述比较核心的历程,如图1-4

 

图1-4

1.4.1、CGI:(Common Gateway Interface)公共网关接口,一种在web服务端使用的脚本技术,使用C或Perl语言编写,用于接收web用户请求并处理,最后动态产生响应给用户,但每次请求将产生一个进程,重量级。

 

1.4.2、Servlet:一种JavaEE web组件技术,是一种在服务器端执行的web组件,用于接收web用户请求并处理,最后动态产生响应给用户。但每次请求只产生一个线程(而且有线程池),轻量级。而且能利用许多JavaEE技术(如JDBC等)。本质就是在java代码里面 输出 html流。但表现逻辑、控制逻辑、业务逻辑调用混杂。如图1-5    

 

图1-5

如图1-5,这种做法是绝对不可取的,控制逻辑、表现代码、业务逻辑对象调用混杂在一起,最大的问题是直接在Java代码里面输出Html,这样前端开发人员无法进行页面风格等的设计与修改,即使修改也是很麻烦,因此实际项目这种做法不可取。

 

1.4.3、JSP:(Java Server Page):一种在服务器端执行的web组件,是一种运行在标准的HTML页面中嵌入脚本语言(现在只支持Java)的模板页面技术。本质就是在html代码中嵌入java代码。JSP最终还是会被编译为Servlet,只不过比纯Servlet开发页面更简单、方便。但表现逻辑、控制逻辑、业务逻辑调用还是混杂。如图1-6

 

 

图1-6

 

如图1-6,这种做法也是绝对不可取的,控制逻辑、表现代码、业务逻辑对象调用混杂在一起,但比直接在servlet里输出html要好一点,前端开发人员可以进行简单的页面风格等的设计与修改(但如果嵌入的java脚本太多也是很难修改的),因此实际项目这种做法不可取。

 

JSP本质还是Servlet,最终在运行时会生成一个Servlet(如tomcat,将在tomcat\work\Catalina\web应用名\org\apache\jsp下生成),但这种使得写html简单点,但仍是控制逻辑、表现代码、业务逻辑对象调用混杂在一起。

 

1.4.4、Model1:可以认为是JSP的增强版,可以认为是jsp+javabean如图1-7

特点:使用<jsp:useBean>标准动作,自动将请求参数封装为JavaBean组件;还必须使用java脚本执行控制逻辑。

 

 

图1-7

此处我们可以看出,使用<jsp:useBean>标准动作可以简化javabean的获取/创建,及将请求参数封装到javabean,再看一下Model1架构,如图1-8。

 

图1-8 Model1架构

Model1架构中,JSP负责控制逻辑、表现逻辑、业务对象(javabean)的调用,只是比纯JSP简化了获取请求参数和封装请求参数。同样是不好的,在项目中应该严禁使用(或最多再demo里使用)。

 

1.4.5、Model2:在JavaEE世界里,它可以认为就是Web MVC模型

Model2架构其实可以认为就是我们所说的Web MVC模型,只是控制器采用Servlet、模型采用JavaBean、视图采用JSP,如图1-9

 

图1-9 Model2架构

 

具体代码事例如下:

 

 

从Model2架构可以看出,视图和模型分离了,控制逻辑和展示逻辑分离了。

但我们也看到严重的缺点:

1.  1、控制器:

1.1.1、控制逻辑可能比较复杂,其实我们可以按照规约,如请求参数submitFlag=toAdd,我们其实可以直接调用toAdd方法,来简化控制逻辑;而且每个模块基本需要一个控制器,造成控制逻辑可能很复杂;

1.1.2、请求参数到模型的封装比较麻烦,如果能交给框架来做这件事情,我们可以从中得到解放;

1.1.3、选择下一个视图,严重依赖Servlet API,这样很难或基本不可能更换视图;

1.1.4、给视图传输要展示的模型数据,使用Servlet API,更换视图技术也要一起更换,很麻烦。

 

1.2、模型:

1.2.1、此处模型使用JavaBean,可能造成JavaBean组件类很庞大,一般现在项目都是采用三层架构,而不采用JavaBean。

 

 

1.3、视图

1.3.1、现在被绑定在JSP,很难更换视图,比如Velocity、FreeMarker;比如我要支持Excel、PDF视图等等。

 

1.4.5、服务到工作者:Front Controller + Application Controller + Page Controller + Context

即,前端控制器+应用控制器+页面控制器(也有称其为动作)+上下文,也是Web MVC,只是责任更加明确,详情请参考《核心J2EE设计模式》和《企业应用架构模式》如图1-10:

 

图1-10

运行流程如下:

 

职责:

Front Controller:前端控制器,负责为表现层提供统一访问点,从而避免Model2中出现的重复的控制逻辑(由前端控制器统一回调相应的功能方法,如前边的根据submitFlag=login转调login方法);并且可以为多个请求提供共用的逻辑(如准备上下文等等),将选择具体视图和具体的功能处理(如login里边封装请求参数到模型,并调用业务逻辑对象)分离。

 

Application Controller:应用控制器,前端控制器分离选择具体视图和具体的功能处理之后,需要有人来管理,应用控制器就是用来选择具体视图技术(视图的管理)和具体的功能处理(页面控制器/命令对象/动作管理),一种策略设计模式的应用,可以很容易的切换视图/页面控制器,相互不产生影响。

 

Page Controller(Command):页面控制器/动作/处理器:功能处理代码,收集参数、封装参数到模型,转调业务对象处理模型,返回逻辑视图名交给前端控制器(和具体的视图技术解耦),由前端控制器委托给应用控制器选择具体的视图来展示,可以是命令设计模式的实现。页面控制器也被称为处理器或动作。

 

Context:上下文,还记得Model2中为视图准备要展示的模型数据吗,我们直接放在request中(Servlet API相关),有了上下文之后,我们就可以将相关数据放置在上下文,从而与协议无关(如Servlet API)的访问/设置模型数据,一般通过ThreadLocal模式实现。

 

 

到此,我们回顾了整个web开发架构的发展历程,可能不同的web层框架在细节处理方面不同,但的目的是一样的:

干净的web表现层:

    模型和视图的分离;

控制器中的控制逻辑与功能处理分离(收集并封装参数到模型对象、业务对象调用);

控制器中的视图选择与具体视图技术分离。

轻薄的web表现层:

    做的事情越少越好,薄薄的,不应该包含无关代码;

       只负责收集并组织参数到模型对象,启动业务对象的调用;

       控制器只返回逻辑视图名并由相应的应用控制器来选择具体使用的视图策略;

       尽量少使用框架特定API,保证容易测试。

 

到此我们了解Web MVC的发展历程,接下来让我们了解下Spring MVC到底是什么、架构及来个HelloWorld了解下具体怎么使用吧。

 

本章具体代码请参考 springmvc-chapter1工程。、



第二章 Spring MVC入门
浏览(20983)|评论(9)   交流分类:Java|笔记分类: 跟开涛学Spring…… 

2.1、Spring Web MVC是什么

Spring Web MVC是一种基于Java的实现了Web MVC设计模式的请求驱动类型的轻量级Web框架,即使用了MVC架构模式的思想,将web层进行职责解耦,基于请求驱动指的就是使用请求-响应模型,框架的目的就是帮助我们简化开发,Spring Web MVC也是要简化我们日常Web开发的。

 

另外还有一种基于组件的、事件驱动的Web框架在此就不介绍了,如Tapestry、JSF等。

 

Spring Web MVC也是服务到工作者模式的实现,但进行可优化。前端控制器是DispatcherServlet;应用控制器其实拆为处理器映射器(Handler Mapping)进行处理器管理和视图解析器(View Resolver)进行视图管理;页面控制器/动作/处理器为Controller接口(仅包含ModelAndView handleRequest(request, response) 方法)的实现(也可以是任何的POJO类);支持本地化(Locale)解析、主题(Theme)解析及文件上传等;提供了非常灵活的数据验证、格式化和数据绑定机制;提供了强大的约定大于配置(惯例优先原则)的契约式编程支持。

2.2、Spring Web MVC能帮我们做什么

√让我们能非常简单的设计出干净的Web层和薄薄的Web层;

√进行更简洁的Web层的开发;

√天生与Spring框架集成(如IoC容器、AOP等);

√提供强大的约定大于配置的契约式编程支持;

√能简单的进行Web层的单元测试;

√支持灵活的URL到页面控制器的映射;

√非常容易与其他视图技术集成,如Velocity、FreeMarker等等,因为模型数据不放在特定的API里,而是放在一个Model里(Map数据结构实现,因此很容易被其他框架使用);

√非常灵活的数据验证、格式化和数据绑定机制,能使用任何对象进行数据绑定,不必实现特定框架的API;

√提供一套强大的JSP标签库,简化JSP开发;

√支持灵活的本地化、主题等解析;

√更加简单的异常处理;

√对静态资源的支持;

√支持Restful风格。

2.3、Spring Web MVC架构

Spring Web MVC框架也是一个基于请求驱动的Web框架,并且也使用了前端控制器模式来进行设计,再根据请求映射规则分发给相应的页面控制器(动作/处理器)进行处理。首先让我们整体看一下Spring Web MVC处理请求的流程:

 

2.3.1、Spring Web MVC处理请求的流程

如图2-1

 

图2-1

具体执行步骤如下:

1、  首先用户发送请求————>前端控制器,前端控制器根据请求信息(如URL)来决定选择哪一个页面控制器进行处理并把请求委托给它,即以前的控制器的控制逻辑部分;图2-1中的1、2步骤;

2、  页面控制器接收到请求后,进行功能处理,首先需要收集和绑定请求参数到一个对象,这个对象在Spring Web MVC中叫命令对象,并进行验证,然后将命令对象委托给业务对象进行处理;处理完毕后返回一个ModelAndView(模型数据和逻辑视图名);图2-1中的3、4、5步骤;

3、  前端控制器收回控制权,然后根据返回的逻辑视图名,选择相应的视图进行渲染,并把模型数据传入以便视图渲染;图2-1中的步骤6、7;

4、  前端控制器再次收回控制权,将响应返回给用户,图2-1中的步骤8;至此整个结束。

 

问题:

1、  请求如何给前端控制器?

2、  前端控制器如何根据请求信息选择页面控制器进行功能处理?

3、  如何支持多种页面控制器呢?

4、  如何页面控制器如何使用业务对象?

5、  页面控制器如何返回模型数据?

6、  前端控制器如何根据页面控制器返回的逻辑视图名选择具体的视图进行渲染?

7、  不同的视图技术如何使用相应的模型数据?

 

首先我们知道有如上问题,那这些问题如何解决呢?请让我们先继续,在后边依次回答。

 

2.3.2、Spring Web MVC架构

1、Spring Web MVC核心架构图,如图2-2

 

图2-2

 

 

架构图对应的DispatcherServlet核心代码如下:

 

java代码:

查看复制到剪贴板打印

  1. //前端控制器分派方法  

  2. protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {  

  3.         HttpServletRequest processedRequest = request;  

  4.         HandlerExecutionChain mappedHandler = null;  

  5.         int interceptorIndex = -1;  

  6.   

  7.         try {  

  8.             ModelAndView mv;  

  9.             boolean errorView = false;  

  10.   

  11.             try {  

  12.                    //检查是否是请求是否是multipart(如文件上传),如果是将通过MultipartResolver解析  

  13.                 processedRequest = checkMultipart(request);  

  14.                    //步骤2、请求到处理器(页面控制器)的映射,通过HandlerMapping进行映射  

  15.                 mappedHandler = getHandler(processedRequest, false);  

  16.                 if (mappedHandler == null || mappedHandler.getHandler() == null) {  

  17.                     noHandlerFound(processedRequest, response);  

  18.                     return;  

  19.                 }  

  20.                    //步骤3、处理器适配,即将我们的处理器包装成相应的适配器(从而支持多种类型的处理器)  

  21.                 HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());  

  22.   

  23.                   // 304 Not Modified缓存支持  

  24.                 //此处省略具体代码  

  25.   

  26.                 // 执行处理器相关的拦截器的预处理(HandlerInterceptor.preHandle)  

  27.                 //此处省略具体代码  

  28.   

  29.                 // 步骤4、由适配器执行处理器(调用处理器相应功能处理方法)  

  30.                 mv = ha.handle(processedRequest, response, mappedHandler.getHandler());  

  31.   

  32.                 // Do we need view name translation?  

  33.                 if (mv != null && !mv.hasView()) {  

  34.                     mv.setViewName(getDefaultViewName(request));  

  35.                 }  

  36.   

  37.                 // 执行处理器相关的拦截器的后处理(HandlerInterceptor.postHandle)  

  38.                 //此处省略具体代码  

  39.             }  

  40.             catch (ModelAndViewDefiningException ex) {  

  41.                 logger.debug("ModelAndViewDefiningException encountered", ex);  

  42.                 mv = ex.getModelAndView();  

  43.             }  

  44.             catch (Exception ex) {  

  45.                 Object handler = (mappedHandler != null ? mappedHandler.getHandler() : null);  

  46.                 mv = processHandlerException(processedRequest, response, handler, ex);  

  47.                 errorView = (mv != null);  

  48.             }  

  49.   

  50.             //步骤5 步骤6、解析视图并进行视图的渲染  

  51. //步骤5 由ViewResolver解析View(viewResolver.resolveViewName(viewName, locale))  

  52. //步骤6 视图在渲染时会把Model传入(view.render(mv.getModelInternal(), request, response);)  

  53.             if (mv != null && !mv.wasCleared()) {  

  54.                 render(mv, processedRequest, response);  

  55.                 if (errorView) {  

  56.                     WebUtils.clearErrorRequestAttributes(request);  

  57.                 }  

  58.             }  

  59.             else {  

  60.                 if (logger.isDebugEnabled()) {  

  61.                     logger.debug("Null ModelAndView returned to DispatcherServlet with name '" + getServletName() +  

  62.                             "': assuming HandlerAdapter completed request handling");  

  63.                 }  

  64.             }  

  65.   

  66.             // 执行处理器相关的拦截器的完成后处理(HandlerInterceptor.afterCompletion)  

  67.             //此处省略具体代码  

  68.   

  69.   

  70.         catch (Exception ex) {  

  71.             // Trigger after-completion for thrown exception.  

  72.             triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, ex);  

  73.             throw ex;  

  74.         }  

  75.         catch (Error err) {  

  76.             ServletException ex = new NestedServletException("Handler processing failed", err);  

  77.             // Trigger after-completion for thrown exception.  

  78.             triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, ex);  

  79.             throw ex;  

  80.         }  

  81.   

  82.         finally {  

  83.             // Clean up any resources used by a multipart request.  

  84.             if (processedRequest != request) {  

  85.                 cleanupMultipart(processedRequest);  

  86.             }  

  87.         }  

  88.     }  

 

核心架构的具体流程步骤如下:

1、  首先用户发送请求——>DispatcherServlet,前端控制器收到请求后自己不进行处理,而是委托给其他的解析器进行处理,作为统一访问点,进行全局的流程控制;

2、  DispatcherServlet——>HandlerMapping, HandlerMapping将会把请求映射为HandlerExecutionChain对象(包含一个Handler处理器(页面控制器)对象、多个HandlerInterceptor拦截器)对象,通过这种策略模式,很容易添加新的映射策略;

3、  DispatcherServlet——>HandlerAdapter,HandlerAdapter将会把处理器包装为适配器,从而支持多种类型的处理器,即适配器设计模式的应用,从而很容易支持很多类型的处理器;

4、  HandlerAdapter——>处理器功能处理方法的调用,HandlerAdapter将会根据适配的结果调用真正的处理器的功能处理方法,完成功能处理;并返回一个ModelAndView对象(包含模型数据、逻辑视图名);

5、  ModelAndView的逻辑视图名——> ViewResolver, ViewResolver将把逻辑视图名解析为具体的View,通过这种策略模式,很容易更换其他视图技术;

6、  View——>渲染,View会根据传进来的Model模型数据进行渲染,此处的Model实际是一个Map数据结构,因此很容易支持其他视图技术;

7、返回控制权给DispatcherServlet,由DispatcherServlet返回响应给用户,到此一个流程结束。

 

此处我们只是讲了核心流程,没有考虑拦截器、本地解析、文件上传解析等,后边再细述。

 

到此,再来看我们前边提出的问题:

 

 

1、  请求如何给前端控制器?这个应该在web.xml中进行部署描述,在HelloWorld中详细讲解。

2、  前端控制器如何根据请求信息选择页面控制器进行功能处理? 我们需要配置HandlerMapping进行映射

3、  如何支持多种页面控制器呢?配置HandlerAdapter从而支持多种类型的页面控制器

4、  如何页面控制器如何使用业务对象?可以预料到,肯定利用Spring IoC容器的依赖注入功能

5、  页面控制器如何返回模型数据?使用ModelAndView返回

6、  前端控制器如何根据页面控制器返回的逻辑视图名选择具体的视图进行渲染? 使用ViewResolver进行解析

7、  不同的视图技术如何使用相应的模型数据? 因为Model是一个Map数据结构,很容易支持其他视图技术

 

在此我们可以看出具体的核心开发步骤:

1、  DispatcherServlet在web.xml中的部署描述,从而拦截请求到Spring Web MVC

2、  HandlerMapping的配置,从而将请求映射到处理器

3、  HandlerAdapter的配置,从而支持多种类型的处理器

4、  ViewResolver的配置,从而将逻辑视图名解析为具体视图技术

5、处理器(页面控制器)的配置,从而进行功能处理

 

上边的开发步骤我们会在Hello World中详细验证。

 

2.4、Spring Web MVC优势

1、清晰的角色划分:前端控制器(DispatcherServlet)、请求到处理器映射(HandlerMapping)、处理器适配器(HandlerAdapter)、视图解析器(ViewResolver)、处理器或页面控制器(Controller)、验证器(   Validator)、命令对象(Command  请求参数绑定到的对象就叫命令对象)、表单对象(Form Object 提供给表单展示和提交到的对象就叫表单对象)。

2、分工明确,而且扩展点相当灵活,可以很容易扩展,虽然几乎不需要;

3、由于命令对象就是一个POJO,无需继承框架特定API,可以使用命令对象直接作为业务对象;

4、和Spring 其他框架无缝集成,是其它Web框架所不具备的;

5、可适配,通过HandlerAdapter可以支持任意的类作为处理器;

6、可定制性,HandlerMapping、ViewResolver等能够非常简单的定制;

7、功能强大的数据验证、格式化、绑定机制;

8、利用Spring提供的Mock对象能够非常简单的进行Web层单元测试;

9、本地化、主题的解析的支持,使我们更容易进行国际化和主题的切换。

10、强大的JSP标签库,使JSP编写更容易。

………………还有比如RESTful风格的支持、简单的文件上传、约定大于配置的契约式编程支持、基于注解的零配置支持等等。

 

到此我们已经简单的了解了Spring Web MVC,接下来让我们来个实例来具体使用下这个框架。

2.5、Hello World入门

2.5.1、准备开发环境和运行环境:

开发工具:eclipse

运行环境:tomcat6.0.20

工程:动态web工程(springmvc-chapter2)

spring框架下载:

spring-framework-3.1.1.RELEASE-with-docs.zip

依赖jar包:

1、  Spring框架jar包:

为了简单,将spring-framework-3.1.1.RELEASE-with-docs.zip/dist/下的所有jar包拷贝到项目的WEB-INF/lib目录下;

2、  Spring框架依赖的jar包:

需要添加Apache commons logging日志,此处使用的是commons.logging-1.1.1.jar;

需要添加jstl标签库支持,此处使用的是jstl-1.1.2.jar和standard-1.1.2.jar;

2.5.2、前端控制器的配置

在我们的web.xml中添加如下配置:

 

java代码:

查看复制到剪贴板打印

  1. <servlet>  

  2.     <servlet-name>chapter2</servlet-name>  

  3.     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  

  4.     <load-on-startup>1</load-on-startup>  

  5. </servlet>  

  6. <servlet-mapping>  

  7.     <servlet-name>chapter2</servlet-name>  

  8.     <url-pattern>/</url-pattern>  

  9. </servlet-mapping>  

load-on-startup:表示启动容器时初始化该Servlet;

url-pattern:表示哪些请求交给Spring Web MVC处理, “/” 是用来定义默认servlet映射的。也可以如“*.html”表示拦截所有以html为扩展名的请求。

 

自此请求已交给Spring Web MVC框架处理,因此我们需要配置Spring的配置文件,默认DispatcherServlet会加载WEB-INF/[DispatcherServlet的Servlet名字]-servlet.xml配置文件。本示例为WEB-INF/ chapter2-servlet.xml。

 

2.5.3、在Spring配置文件中配置HandlerMapping、HandlerAdapter

具体配置在WEB-INF/ chapter2-servlet.xml文件中:

 

java代码:

查看复制到剪贴板打印

  1. <!-- HandlerMapping -->  

  2. <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>  

  3.    

  4. <!-- HandlerAdapter -->  

  5. <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>  

 

BeanNameUrlHandlerMapping:表示将请求的URL和Bean名字映射,如URL为 “上下文/hello”,则Spring配置文件必须有一个名字为“/hello”的Bean,上下文默认忽略。

SimpleControllerHandlerAdapter:表示所有实现了org.springframework.web.servlet.mvc.Controller接口的Bean可以作为Spring Web MVC中的处理器。如果需要其他类型的处理器可以通过实现HadlerAdapter来解决。

2.5.4、在Spring配置文件中配置ViewResolver

具体配置在WEB-INF/ chapter2-servlet.xml文件中:

 

java代码:

查看复制到剪贴板打印

  1. <!-- ViewResolver -->  

  2. <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  

  3.     <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>  

  4.     <property name="prefix" value="/WEB-INF/jsp/"/>  

  5.     <property name="suffix" value=".jsp"/>  

  6. </bean>  

 

InternalResourceViewResolver:用于支持Servlet、JSP视图解析;

    viewClass:JstlView表示JSP模板页面需要使用JSTL标签库,classpath中必须包含jstl的相关jar包;

    prefix和suffix:查找视图页面的前缀和后缀(前缀[逻辑视图名]后缀),比如传进来的逻辑视图名为hello,则该该jsp视图页面应该存放在“WEB-INF/jsp/hello.jsp”;

 

2.5.5、开发处理器/页面控制器

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter2.web.controller;  

  2. import javax.servlet.http.HttpServletRequest;  

  3. import javax.servlet.http.HttpServletResponse;  

  4. import org.springframework.web.servlet.ModelAndView;  

  5. import org.springframework.web.servlet.mvc.Controller;  

  6. public class HelloWorldController implements Controller {  

  7.     @Override  

  8.     public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception {  

  9.        //1、收集参数、验证参数  

  10.        //2、绑定参数到命令对象  

  11.        //3、将命令对象传入业务对象进行业务处理  

  12.        //4、选择下一个页面  

  13.        ModelAndView mv = new ModelAndView();  

  14.        //添加模型数据 可以是任意的POJO对象  

  15.        mv.addObject("message""Hello World!");  

  16.        //设置逻辑视图名,视图解析器会根据该名字解析到具体的视图页面  

  17.        mv.setViewName("hello");  

  18.        return mv;  

  19.     }  

  20. }  

 

org.springframework.web.servlet.mvc.Controller:页面控制器/处理器必须实现Controller接口,注意别选错了;后边我们会学习其他的处理器实现方式;

public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) :功能处理方法,实现相应的功能处理,比如收集参数、验证参数、绑定参数到命令对象、将命令对象传入业务对象进行业务处理、最后返回ModelAndView对象;

ModelAndView:包含了视图要实现的模型数据和逻辑视图名;“mv.addObject("message", "Hello World!");

”表示添加模型数据,此处可以是任意POJO对象;“mv.setViewName("hello");”表示设置逻辑视图名为“hello”,视图解析器会将其解析为具体的视图,如前边的视图解析器InternalResourceVi。wResolver会将其解析为“WEB-INF/jsp/hello.jsp”。

 

 

我们需要将其添加到Spring配置文件(WEB-INF/chapter2-servlet.xml),让其接受Spring IoC容器管理:

 

java代码:

查看复制到剪贴板打印

  1. <!-- 处理器 -->  

  2. <bean name="/hello" class="cn.javass.chapter2.web.controller.HelloWorldController"/>  

 

name="/hello":前边配置的BeanNameUrlHandlerMapping,表示如过请求的URL为 “上下文/hello”,则将会交给该Bean进行处理。 

2.5.6、开发视图页面

创建 /WEB-INF/jsp/hello.jsp视图页面:

 

java代码:

查看复制到剪贴板打印

  1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  

  3. <html>  

  4. <head>  

  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  

  6. <title>Hello World</title>  

  7. </head>  

  8. <body>  

  9. ${message}  

  10. </body>  

  11. </html>  

 

${message}:表示显示由HelloWorldController处理器传过来的模型数据。

2.5.6、启动服务器运行测试

通过请求:http://localhost:9080/springmvc-chapter2/hello,如果页面输出“Hello World! ”就表明我们成功了!

 

 

2.5.7、运行流程分析

如图2-3

 

图2-3

运行步骤:

1、  首先用户发送请求http://localhost:9080/springmvc-chapter2/hello——>web容器,web容器根据“/hello”路径映射到DispatcherServlet(url-pattern为/)进行处理;

2、  DispatcherServlet——>BeanNameUrlHandlerMapping进行请求到处理的映射,BeanNameUrlHandlerMapping将“/hello”路径直接映射到名字为“/hello”的Bean进行处理,即HelloWorldController,BeanNameUrlHandlerMapping将其包装为HandlerExecutionChain(只包括HelloWorldController处理器,没有拦截器);

3、  DispatcherServlet——> SimpleControllerHandlerAdapter,SimpleControllerHandlerAdapter将HandlerExecutionChain中的处理器(HelloWorldController)适配为SimpleControllerHandlerAdapter;

4、  SimpleControllerHandlerAdapter——> HelloWorldController处理器功能处理方法的调用,SimpleControllerHandlerAdapter将会调用处理器的handleRequest方法进行功能处理,该处理方法返回一个ModelAndView给DispatcherServlet;

5、  hello(ModelAndView的逻辑视图名)——>InternalResourceViewResolver, InternalResourceViewResolver使用JstlView,具体视图页面在/WEB-INF/jsp/hello.jsp;

6、  JstlView(/WEB-INF/jsp/hello.jsp)——>渲染,将在处理器传入的模型数据(message=HelloWorld!)在视图中展示出来;

7、  返回控制权给DispatcherServlet,由DispatcherServlet返回响应给用户,到此一个流程结束。

 

到此HelloWorld就完成了,步骤是不是有点多?而且回忆下我们主要进行了如下配置:

 

1、  前端控制器DispatcherServlet;

2、  HandlerMapping

3、  HandlerAdapter

4、  ViewResolver

5、  处理器/页面控制器

6、  视图

 

因此,接下来几章让我们详细看看这些配置,先从DispatcherServlet开始吧。

 

2.6、POST中文乱码解决方案

spring Web MVC框架提供了org.springframework.web.filter.CharacterEncodingFilter用于解决POST方式造成的中文乱码问题,具体配置如下:

 

java代码:

查看复制到剪贴板打印

  1. <filter>  

  2.     <filter-name>CharacterEncodingFilter</filter-name>  

  3.     <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  

  4.     <init-param>  

  5.         <param-name>encoding</param-name>  

  6.         <param-value>utf-8</param-value>  

  7.     </init-param>  

  8. </filter>  

  9. <filter-mapping>  

  10.     <filter-name>CharacterEncodingFilter</filter-name>  

  11.     <url-pattern>/*</url-pattern>  

  12. </filter-mapping>  

 

以后我们项目及所有页面的编码均为UTF-8。

 

 

2.7、Spring3.1新特性

一、Spring2.5之前,我们都是通过实现Controller接口或其实现来定义我们的处理器类。

 

二、Spring2.5引入注解式处理器支持,通过@Controller 和 @RequestMapping注解定义我们的处理器类。并且提供了一组强大的注解:

 

需要通过处理器映射DefaultAnnotationHandlerMapping和处理器适配器AnnotationMethodHandlerAdapter来开启支持@Controller 和 @RequestMapping注解的处理器。

 

@Controller:用于标识是处理器类;

@RequestMapping:请求到处理器功能方法的映射规则;

@RequestParam:请求参数到处理器功能处理方法的方法参数上的绑定;

@ModelAttribute:请求参数到命令对象的绑定;

@SessionAttributes:用于声明session级别存储的属性,放置在处理器类上,通常列出模型属性(如@ModelAttribute)对应的名称,则这些属性会透明的保存到session中;

@InitBinder:自定义数据绑定注册支持,用于将请求参数转换到命令对象属性的对应类型;

 

三、Spring3.0引入RESTful架构风格支持(通过@PathVariable注解和一些其他特性支持),且又引入了更多的注解支持:

@CookieValue:cookie数据到处理器功能处理方法的方法参数上的绑定;

@RequestHeader:请求头(header)数据到处理器功能处理方法的方法参数上的绑定;

@RequestBody:请求的body体的绑定(通过HttpMessageConverter进行类型转换);

@ResponseBody:处理器功能处理方法的返回值作为响应体(通过HttpMessageConverter进行类型转换);

@ResponseStatus:定义处理器功能处理方法/异常处理器返回的状态码和原因;

@ExceptionHandler:注解式声明异常处理器;

@PathVariable:请求URI中的模板变量部分到处理器功能处理方法的方法参数上的绑定,从而支持RESTful架构风格的URI;

 

四、还有比如:

JSR-303验证框架的无缝支持(通过@Valid注解定义验证元数据);

使用Spring 3开始的ConversionService进行类型转换(PropertyEditor依然有效),支持使用@NumberFormat 和 @DateTimeFormat来进行数字和日期的格式化;

HttpMessageConverter(Http输入/输出转换器,比如JSON、XML等的数据输出转换器);

ContentNegotiatingViewResolver,内容协商视图解析器,它还是视图解析器,只是它支持根据请求信息将同一模型数据以不同的视图方式展示(如json、xml、html等),RESTful架构风格中很重要的概念(同一资源,多种表现形式);

Spring 3 引入 一个  mvc XML的命名空间用于支持mvc配置,包括如:

    <mvc:annotation-driven>:

      自动注册基于注解风格的处理器需要的DefaultAnnotationHandlerMapping、AnnotationMethodHandlerAdapter

      支持Spring3的ConversionService自动注册

      支持JSR-303验证框架的自动探测并注册(只需把JSR-303实现放置到classpath)

      自动注册相应的HttpMessageConverter(用于支持@RequestBody  和 @ResponseBody)(如XML输入输出转换器(只需将JAXP实现放置到classpath)、JSON输入输出转换器(只需将Jackson实现放置到classpath))等。

    <mvc:interceptors>:注册自定义的处理器拦截器;

    <mvc:view-controller>:和ParameterizableViewController类似,收到相应请求后直接选择相应的视图;

    <mvc:resources>:逻辑静态资源路径到物理静态资源路径的支持;

    <mvc:default-servlet-handler>:当在web.xml 中DispatcherServlet使用<url-pattern>/</url-pattern> 映射时,能映射静态资源(当Spring Web MVC框架没有处理请求对应的控制器时(如一些静态资源),转交给默认的Servlet来响应静态文件,否则报404找不到资源错误,)。

 

……等等。

 

五、Spring3.1新特性:

对Servlet 3.0的全面支持。

 

@EnableWebMvc:用于在基于Java类定义Bean配置中开启MVC支持,和XML中的<mvc:annotation-driven>功能一样;

 

新的@Contoller和@RequestMapping注解支持类:处理器映射RequestMappingHandlerMapping 和 处理器适配器RequestMappingHandlerAdapter组合来代替Spring2.5开始的处理器映射DefaultAnnotationHandlerMapping和处理器适配器AnnotationMethodHandlerAdapter,提供更多的扩展点,它们之间的区别我们在处理器映射一章介绍。

 

新的@ExceptionHandler 注解支持类:ExceptionHandlerExceptionResolver来代替Spring3.0的AnnotationMethodHandlerExceptionResolver,在异常处理器一章我们再详细讲解它们的区别。

 

@RequestMapping的"consumes" 和 "produces" 条件支持:用于支持@RequestBody 和 @ResponseBody,

1consumes指定请求的内容是什么类型的内容,即本处理方法消费什么类型的数据,如consumes="application/json"表示JSON类型的内容,Spring会根据相应的HttpMessageConverter进行请求内容区数据到@RequestBody注解的命令对象的转换;

2produces指定生产什么类型的内容,如produces="application/json"表示JSON类型的内容,Spring的根据相应的HttpMessageConverter进行请求内容区数据到@RequestBody注解的命令对象的转换,Spring会根据相应的HttpMessageConverter进行模型数据(返回值)到JSON响应内容的转换

3以上内容,本章第×××节详述。

 

URI模板变量增强:[email protected][email protected]��模型数据中(除JSON序列化、XML混搭场景下)。

 

@Validated:JSR-303的javax.validation.Valid一种变体(非JSR-303规范定义的,而是Spring自定义的),用于提供对Spring的验证器(org.springframework.validation.Validator)支持,需要Hibernate Validator 4.2及更高版本支持;

 

@RequestPart:提供对“multipart/form-data”请求的全面支持,支持Servlet 3.0文件上传(javax.servlet.http.Part)、支持内容的HttpMessageConverter(即根据请求头的Content-Type,来判断内容区数据是什么类型,如JSON、XML,能自动转换为命令对象),比@RequestParam更强大(只能对请求参数数据绑定,key-alue格式),而@RequestPart支持如JSON、XML内容区数据的绑定;详见本章的第×××节;

 

Flash 属性 和 RedirectAttribute:通过FlashMap存储一个请求的输出,当进入另一个请求时作为该请求的输入,典型场景如重定向(POST-REDIRECT-GET模式,1、POST时将下一次需要的数据放在FlashMap;2、重定向;3、通过GET访问重定向的地址,此时FlashMap会把1放到FlashMap的数据取出放到请求中,并从FlashMap中删除;从而支持在两次请求之间保存数据并防止了重复表单提交)。

Spring Web MVC提供FlashMapManager用于管理FlashMap,默认使用SessionFlashMapManager,即数据默认存储在session中

第三章 DispatcherServlet详解


3.1、DispatcherServlet作用

DispatcherServlet是前端控制器设计模式的实现,提供Spring Web MVC的集中访问点,而且负责职责的分派,而且与Spring IoC容器无缝集成,从而可以获得Spring的所有好处。 具体请参考第二章的图2-1。

 

DispatcherServlet主要用作职责调度工作,本身主要用于控制流程,主要职责如下:

1、文件上传解析,如果请求类型是multipart将通过MultipartResolver进行文件上传解析;

2、通过HandlerMapping,将请求映射到处理器(返回一个HandlerExecutionChain,它包括一个处理器、多个HandlerInterceptor拦截器);

3、通过HandlerAdapter支持多种类型的处理器(HandlerExecutionChain中的处理器);

4、通过ViewResolver解析逻辑视图名到具体视图实现;

5、本地化解析;

6、渲染具体的视图等;

7、如果执行过程中遇到异常将交给HandlerExceptionResolver来解析。

 

从以上我们可以看出DispatcherServlet主要负责流程的控制(而且在流程中的每个关键点都是很容易扩展的)。

 

3.2、DispatcherServlet在web.xml中的配置

[java] view plain copy

  1. <servlet>  

  2.     <servlet-name>chapter2</servlet-name>  

  3.     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  

  4.     <load-on-startup>1</load-on-startup>  

  5. </servlet>  

  6. <servlet-mapping>  

  7.     <servlet-name>chapter2</servlet-name>  

  8.     <url-pattern>/</url-pattern>  

  9. </servlet-mapping>  

 

load-on-startup:表示启动容器时初始化该Servlet;

url-pattern:表示哪些请求交给Spring Web MVC处理, “/” 是用来定义默认servlet映射的。也可以如“*.html”表示拦截所有以html为扩展名的请求。

 

该DispatcherServlet默认使用WebApplicationContext作为上下文,Spring默认配置文件为“/WEB-INF/[servlet名字]-servlet.xml”。

 

DispatcherServlet也可以配置自己的初始化参数,覆盖默认配置:

摘自Spring Reference

参数

描述

contextClass

实现WebApplicationContext接口的类,当前的servlet用它来创建上下文。如果这个参数没有指定, 默认使用XmlWebApplicationContext。

contextConfigLocation

传给上下文实例(由contextClass指定)的字符串,用来指定上下文的位置。这个字符串可以被分成多个字符串(使用逗号作为分隔符) 来支持多个上下文(在多上下文的情况下,如果同一个bean被定义两次,后面一个优先)。

namespace

WebApplicationContext命名空间。默认值是[server-name]-servlet。

 

因此我们可以通过添加初始化参数

 

[java] view plain copy

  1. <servlet>  

  2.     <servlet-name>chapter2</servlet-name>  

  3.     <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  

  4.     <load-on-startup>1</load-on-startup>  

  5.     <init-param>  

  6.         <param-name>contextConfigLocation</param-name>  

  7.         <param-value>classpath:spring-servlet-config.xml</param-value>  

  8.     </init-param>  

  9. </servlet>  

 

如果使用如上配置,Spring Web MVC框架将加载“classpath:spring-servlet-config.xml”来进行初始化上下文而不是“/WEB-INF/[servlet名字]-servlet.xml”。

3.3、上下文关系

集成Web环境的通用配置:

[java] view plain copy

  1. <context-param>  

  2.       <param-name>contextConfigLocation</param-name>  

  3.       <param-value>  

  4.           classpath:spring-common-config.xml,  

  5.           classpath:spring-budget-config.xml  

  6.       </param-value>  

  7. </context-param>  

  8. <listener>  <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  

  9. </listener>  

 

如上配置是Spring集成Web环境的通用配置;一般用于加载除Web层的Bean(如DAO、Service等),以便于与其他任何Web框架集成。

contextConfigLocation:表示用于加载Bean的配置文件;

contextClass:表示用于加载Bean的ApplicationContext实现类,默认WebApplicationContext。

 

 

创建完毕后会将该上下文放在ServletContext:

servletContext.setAttribute(

WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE,

this.context);

 

 

ContextLoaderListener初始化的上下文和DispatcherServlet初始化的上下文关系,如图3-1

图3-1

从图中可以看出:

ContextLoaderListener初始化的上下文加载的Bean是对于整个应用程序共享的,不管是使用什么表现层技术,一般如DAO层、Service层Bean;

DispatcherServlet初始化的上下文加载的Bean是只对Spring Web MVC有效的Bean,如Controller、HandlerMapping、HandlerAdapter等等,该初始化上下文应该只加载Web相关组件。

3.4、DispatcherServlet初始化顺序

继承体系结构如下所示:

 

1、HttpServletBean继承HttpServlet,因此在Web容器启动时将调用它的init方法,该初始化方法的主要作用

:::将Servlet初始化参数(init-param)设置到该组件上(如contextAttribute、contextClass、namespace、contextConfigLocation),通过BeanWrapper简化设值过程,方便后续使用;

:::提供给子类初始化扩展点,initServletBean(),该方法由FrameworkServlet覆盖。

 

[java] view plain copy

  1. public abstract class HttpServletBean extends HttpServlet implements EnvironmentAware{  

  2. @Override  

  3.     public final void init() throws ServletException {  

  4.        //省略部分代码  

  5.        //1、如下代码的作用是将Servlet初始化参数设置到该组件上  

  6. //如contextAttribute、contextClass、namespace、contextConfigLocation;  

  7.        try {  

  8.            PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);  

  9.            BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);  

  10.            ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());  

  11.            bw.registerCustomEditor(Resource.classnew ResourceEditor(resourceLoader, this.environment));  

  12.            initBeanWrapper(bw);  

  13.            bw.setPropertyValues(pvs, true);  

  14.        }  

  15.        catch (BeansException ex) {  

  16.            //…………省略其他代码  

  17.        }  

  18.        //2、提供给子类初始化的扩展点,该方法由FrameworkServlet覆盖  

  19.        initServletBean();  

  20.        if (logger.isDebugEnabled()) {  

  21.            logger.debug("Servlet '" + getServletName() + "' configured successfully");  

  22.        }  

  23.     }  

  24.     //…………省略其他代码  

  25. }  

 

 

2、FrameworkServlet继承HttpServletBean,通过initServletBean()进行Web上下文初始化,该方法主要覆盖一下两件事情:

    初始化web上下文;

    提供给子类初始化扩展点;

[java] view plain copy

  1. public abstract class FrameworkServlet extends HttpServletBean {  

  2. @Override  

  3.     protected final void initServletBean() throws ServletException {  

  4.         //省略部分代码  

  5.        try {  

  6.              //1、初始化Web上下文  

  7.            this.webApplicationContext = initWebApplicationContext();  

  8.              //2、提供给子类初始化的扩展点  

  9.            initFrameworkServlet();  

  10.        }  

  11.         //省略部分代码  

  12.     }  

  13. }  

 

[java] view plain copy

  1. protected WebApplicationContext initWebApplicationContext() {  

  2.         //ROOT上下文(ContextLoaderListener加载的)  

  3.        WebApplicationContext rootContext =  

  4.               WebApplicationContextUtils.getWebApplicationContext(getServletContext());  

  5.        WebApplicationContext wac = null;  

  6.        if (this.webApplicationContext != null) {  

  7.            // 1、在创建该Servlet注入的上下文  

  8.            wac = this.webApplicationContext;  

  9.            if (wac instanceof ConfigurableWebApplicationContext) {  

  10.               ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;  

  11.               if (!cwac.isActive()) {  

  12.                   if (cwac.getParent() == null) {  

  13.                       cwac.setParent(rootContext);  

  14.                   }  

  15.                   configureAndRefreshWebApplicationContext(cwac);  

  16.               }  

  17.            }  

  18.        }  

  19.        if (wac == null) {  

  20.              //2、查找已经绑定的上下文  

  21.            wac = findWebApplicationContext();  

  22.        }  

  23.        if (wac == null) {  

  24.             //3、如果没有找到相应的上下文,并指定父亲为ContextLoaderListener  

  25.            wac = createWebApplicationContext(rootContext);  

  26.        }  

  27.        if (!this.refreshEventReceived) {  

  28.              //4、刷新上下文(执行一些初始化)  

  29.            onRefresh(wac);  

  30.        }  

  31.        if (this.publishContext) {  

  32.            // Publish the context as a servlet context attribute.  

  33.            String attrName = getServletContextAttributeName();  

  34.            getServletContext().setAttribute(attrName, wac);  

  35.            //省略部分代码  

  36.        }  

  37.        return wac;  

  38.     }  

 

从initWebApplicationContext()方法可以看出,基本上如果ContextLoaderListener加载了上下文将作为根上下文(DispatcherServlet的父容器)。

 

最后调用了onRefresh()方法执行容器的一些初始化,这个方法由子类实现,来进行扩展。

 

 

3、DispatcherServlet继承FrameworkServlet,并实现了onRefresh()方法提供一些前端控制器相关的配置:

 

[java] view plain copy

  1. public class DispatcherServlet extends FrameworkServlet {  

  2.      //实现子类的onRefresh()方法,该方法委托为initStrategies()方法。  

  3.     @Override  

  4.     protected void onRefresh(ApplicationContext context) {  

  5.        initStrategies(context);  

  6.     }  

  7.    

  8.     //初始化默认的Spring Web MVC框架使用的策略(如HandlerMapping)  

  9.     protected void initStrategies(ApplicationContext context) {  

  10.        initMultipartResolver(context);  

  11.        initLocaleResolver(context);  

  12.        initThemeResolver(context);  

  13.        initHandlerMappings(context);  

  14.        initHandlerAdapters(context);  

  15.        initHandlerExceptionResolvers(context);  

  16.        initRequestToViewNameTranslator(context);  

  17.        initViewResolvers(context);  

  18.        initFlashMapManager(context);  

  19.     }  

  20. }  

 

从如上代码可以看出,DispatcherServlet启动时会进行我们需要的Web层Bean的配置,如HandlerMapping、HandlerAdapter等,而且如果我们没有配置,还会给我们提供默认的配置。

 

从如上代码我们可以看出,整个DispatcherServlet初始化的过程和做了些什么事情,具体主要做了如下两件事情:

1、初始化Spring Web MVC使用的Web上下文,并且可能指定父容器为(ContextLoaderListener加载了根上下文);

2、初始化DispatcherServlet使用的策略,如HandlerMapping、HandlerAdapter等。

 

 

服务器启动时的日志分析(此处加上了ContextLoaderListener从而启动ROOT上下文容器):

 

 信息: Initializing Spring root WebApplicationContext //由ContextLoaderListener启动ROOT上下文

 

2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.ContextLoader - Root WebApplicationContext: initialization started

2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.support.XmlWebApplicationContext - Refreshing Root WebApplicationContext: startup date [Mon Mar 12 13:33:55 CST 2012]; root of context hierarchy

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader - Loading bean definitions

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loaded 0 bean definitions from location pattern [/WEB-INF/ContextLoaderListener.xml]

2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.support.XmlWebApplicationContext - Bean factory for Root WebApplicationContext: org.springframework.beans.factory.support.DefaultListableBeanFactory@1c05ffd: defining beans []; root of factory hierarchy

2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.support.XmlWebApplicationContext - Bean factory for Root WebApplicationContext:

2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.ContextLoader - Published root WebApplicationContext as ServletContext attribute with name [org.springframework.web.context.WebApplicationContext.ROOT] //将ROOT上下文绑定到ServletContext

2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.ContextLoader - Root WebApplicationContext: initialization completed in 438 ms  //到此ROOT上下文启动完毕

 

 2012-03-12 13:33:55 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Initializing servlet 'chapter2'

信息: Initializing Spring FrameworkServlet 'chapter2'  //开始初始化FrameworkServlet对应的Web上下文

2012-03-12 13:33:55 [main] INFO  org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'chapter2': initialization started

2012-03-12 13:33:55 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Servlet with name 'chapter2' will try to create custom WebApplicationContext context of class 'org.springframework.web.context.support.XmlWebApplicationContext', using parent context [Root WebApplicationContext: startup date [Mon Mar 12 13:33:55 CST 2012]; root of context hierarchy]

//此处使用Root WebApplicationContext作为父容器。

2012-03-12 13:33:55 [main] INFO  org.springframework.web.context.support.XmlWebApplicationContext - Refreshing WebApplicationContext for namespace 'chapter2-servlet': startup date [Mon Mar 12 13:33:55 CST 2012]; parent: Root WebApplicationContext

2012-03-12 13:33:55 [main] INFO  org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loading XML bean definitions from ServletContext resource [/WEB-INF/chapter2-servlet.xml]

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader - Loading bean definitions

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - Neither XML 'id' nor 'name' specified - using generated bean name[org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping#0]  //我们配置的HandlerMapping

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - Neither XML 'id' nor 'name' specified - using generated bean name[org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter#0] //我们配置的HandlerAdapter

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - Neither XML 'id' nor 'name' specified - using generated bean name [org.springframework.web.servlet.view.InternalResourceViewResolver#0] //我们配置的ViewResolver

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.BeanDefinitionParserDelegate - No XML 'id' specified - using '/hello' as bean name and [] as aliases 

//我们的处理器(HelloWorldController)

2012-03-12 13:33:55 [main] DEBUG org.springframework.beans.factory.xml.XmlBeanDefinitionReader - Loaded 4 bean definitions from location pattern [/WEB-INF/chapter2-servlet.xml]

2012-03-12 13:33:55 [main] DEBUG org.springframework.web.context.support.XmlWebApplicationContext - Bean factory for WebApplicationContext for namespace 'chapter2-servlet': org.springframework.beans.factory.support.DefaultListableBeanFactory@1372656: defining beans [org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping#0,org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter#0,org.springframework.web.servlet.view.InternalResourceViewResolver#0,/hello]; parent: org.springframework.beans.factory.support.DefaultListableBeanFactory@1c05ffd

//到此容器注册的Bean初始化完毕

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Unable to locate MultipartResolver with name 'multipartResolver': no multipart request handling provided

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver'

//默认的LocaleResolver注册

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.theme.FixedThemeResolver'

//默认的ThemeResolver注册

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping#0'

//发现我们定义的HandlerMapping 不再使用默认的HandlerMapping。

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter#0'

//发现我们定义的HandlerAdapter 不再使用默认的HandlerAdapter。

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerExceptionResolver'

//异常处理解析器ExceptionResolver

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Creating instance of bean 'org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerExceptionResolver'

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.beans.factory.support.DefaultListableBeanFactory - Returning cached instance of singleton bean 'org.springframework.web.servlet.view.InternalResourceViewResolver#0'

 

2012-03-12 13:33:56 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Published WebApplicationContext of servlet 'chapter2' as ServletContext attribute with name [org.springframework.web.servlet.FrameworkServlet.CONTEXT.chapter2]

//绑定FrameworkServlet初始化的Web上下文到ServletContext

2012-03-12 13:33:56 [main] INFO  org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'chapter2': initialization completed in  297 ms

2012-03-12 13:33:56 [main] DEBUG org.springframework.web.servlet.DispatcherServlet - Servlet 'chapter2' configured successfully

//到此完整流程结束 

 

 

 

从如上日志我们也可以看出,DispatcherServlet会进行一些默认的配置。接下来我们看一下默认配置吧。

 

 

 

3.5、DispatcherServlet默认配置

DispatcherServlet的默认配置在DispatcherServlet.properties(和DispatcherServlet类在一个包下)中,而且是当Spring配置文件中没有指定配置时使用的默认策略:

 

org.springframework.web.servlet.LocaleResolver=org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver

 

org.springframework.web.servlet.ThemeResolver=org.springframework.web.servlet.theme.FixedThemeResolver

 

org.springframework.web.servlet.HandlerMapping=org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,\

    org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping

 

org.springframework.web.servlet.HandlerAdapter=org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter,\

    org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter,\

    org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter

 

org.springframework.web.servlet.HandlerExceptionResolver=org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerExceptionResolver,\

    org.springframework.web.servlet.mvc.annotation.ResponseStatusExceptionResolver,\

    org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver

 

org.springframework.web.servlet.RequestToViewNameTranslator=org.springframework.web.servlet.view.DefaultRequestToViewNameTranslator

 

org.springframework.web.servlet.ViewResolver=org.springframework.web.servlet.view.InternalResourceViewResolver

 

org.springframework.web.servlet.FlashMapManager=org.springframework.web.servlet.support.SessionFlashMapManager

 

 

 

从如上配置可以看出DispatcherServlet在启动时会自动注册这些特殊的Bean,无需我们注册,如果我们注册了,默认的将不会注册。

 

因此如第二章的BeanNameUrlHandlerMapping、SimpleControllerHandlerAdapter是不需要注册的,DispatcherServlet默认会注册这两个Bean。

 

从DispatcherServlet.properties可以看出有许多特殊的Bean,那接下来我们就看看Spring Web MVC主要有哪些特殊的Bean。

3.6、DispatcherServlet中使用的特殊的Bean

DispatcherServlet默认使用WebApplicationContext作为上下文,因此我们来看一下该上下文中有哪些特殊的Bean:

1、Controller:处理器/页面控制器,做的是MVC中的C的事情,但控制逻辑转移到前端控制器了,用于对请求进行处理;

2、HandlerMapping:请求到处理器的映射,如果映射成功返回一个HandlerExecutionChain对象(包含一个Handler处理器(页面控制器)对象、多个HandlerInterceptor拦截器)对象;如BeanNameUrlHandlerMapping将URL与Bean名字映射,映射成功的Bean就是此处的处理器;

3、HandlerAdapter:HandlerAdapter将会把处理器包装为适配器,从而支持多种类型的处理器,即适配器设计模式的应用,从而很容易支持很多类型的处理器;如SimpleControllerHandlerAdapter将对实现了Controller接口的Bean进行适配,并且掉处理器的handleRequest方法进行功能处理;

4、ViewResolver:ViewResolver将把逻辑视图名解析为具体的View,通过这种策略模式,很容易更换其他视图技术;如InternalResourceViewResolver将逻辑视图名映射为jsp视图;

5、LocalResover:本地化解析,因为Spring支持国际化,因此LocalResover解析客户端的Locale信息从而方便进行国际化;

6、ThemeResovler:主题解析,通过它来实现一个页面多套风格,即常见的类似于软件皮肤效果;

7、MultipartResolver:文件上传解析,用于支持文件上传;

8、HandlerExceptionResolver:处理器异常解析,可以将异常映射到相应的统一错误界面,从而显示用户友好的界面(而不是给用户看到具体的错误信息);

9、RequestToViewNameTranslator:当处理器没有返回逻辑视图名等相关信息时,自动将请求URL映射为逻辑视图名;

10、FlashMapManager:用于管理FlashMap的策略接口,FlashMap用于存储一个请求的输出,当进入另一个请求时作为该请求的输入,通常用于重定向场景,后边会细述。

 

 

到此DispatcherServlet我们已经了解了,接下来我们就需要把上边提到的特殊Bean挨个击破,那首先从控制器开始吧。


第四章 Controller接口控制器详解(1)

4.1、Controller简介

Controller控制器,是MVC中的部分C,为什么是部分呢?因为此处的控制器主要负责功能处理部分:

1、收集、验证请求参数并绑定到命令对象;

2、将命令对象交给业务对象,由业务对象处理并返回模型数据;

3、返回ModelAndView(Model部分是业务对象返回的模型数据,视图部分为逻辑视图名)。

 

还记得DispatcherServlet吗?主要负责整体的控制流程的调度部分:

1、负责将请求委托给控制器进行处理;

2、根据控制器返回的逻辑视图名选择具体的视图进行渲染(并把模型数据传入)。

 

因此MVC中完整的C(包含控制逻辑+功能处理)由(DispatcherServlet + Controller)组成。

 

因此此处的控制器是Web MVC中部分,也可以称为页面控制器、动作、处理器。

 

Spring Web MVC支持多种类型的控制器,比如实现Controller接口,从Spring2.5开始支持注解方式的控制器(如@Controller、@RequestMapping、@RequestParam、@ModelAttribute等),我们也可以自己实现相应的控制器(只需要定义相应的HandlerMapping和HandlerAdapter即可)。

 

因为考虑到还有部分公司使用继承Controller接口实现方式,因此我们也学习一下,虽然已经不推荐使用了。

 

对于注解方式的控制器,后边会详细讲,在此我们先学习Spring2.5以前的Controller接口实现方式。

 

首先我们将项目springmvc-chapter2复制一份改为项目springmvc-chapter4,本章示例将放置在springmvc-chapter4中。

大家需要将项目springmvc-chapter4/ .settings/ org.eclipse.wst.common.component下的chapter2改为chapter4,否则上下文还是“springmvc-chapter2”。以后的每一个章节都需要这么做。

4.2、Controller接口

[java] view plain copy

  1. package org.springframework.web.servlet.mvc;  

  2. public interface Controller {  

  3.        ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;  

  4. }  

 

这是控制器接口,此处只有一个方法handleRequest,用于进行请求的功能处理,处理完请求后返回ModelAndView(Model模型数据部分 和 View视图部分)。

 

还记得第二章的HelloWorld吗?我们的HelloWorldController实现Controller接口,Spring默认提供了一些Controller接口的实现以方便我们使用,具体继承体系如图4-1:

 

图4-1

4.3、WebContentGenerator

用于提供如浏览器缓存控制、是否必须有session开启、支持的请求方法类型(GET、POST等)等,该类主要有如下属性:

 

Set<String>   supportedMethods:设置支持的请求方法类型,默认支持“GET”、“POST”、“HEAD”,如果我们想支持“PUT”,则可以加入该集合“PUT”。

boolean requireSession = false:是否当前请求必须有session,如果此属性为true,但当前请求没有打开session将抛出HttpSessionRequiredException异常;

 

boolean useExpiresHeader = true:是否使用HTTP1.0协议过期响应头:如果true则会在响应头添加:“Expires:”;需要配合cacheSeconds使用;

 

boolean useCacheControlHeader = true:是否使用HTTP1.1协议的缓存控制响应头,如果true则会在响应头添加;需要配合cacheSeconds使用;

 

boolean useCacheControlNoStore = true:是否使用HTTP 1.1协议的缓存控制响应头,如果true则会在响应头添加;需要配合cacheSeconds使用;

 

private int cacheSeconds = -1:缓存过期时间,正数表示需要缓存,负数表示不做任何事情(也就是说保留上次的缓存设置),

      1、cacheSeconds =0时,则将设置如下响应头数据:

        Pragma:no-cache             // HTTP 1.0的不缓存响应头

        Expires:1L                  // useExpiresHeader=true时,HTTP 1.0

        Cache-Control :no-cache      // useCacheControlHeader=true时,HTTP 1.1

        Cache-Control :no-store       // useCacheControlNoStore=true时,该设置是防止Firefox缓存

 

      2、cacheSeconds>0时,则将设置如下响应头数据:

        Expires:System.currentTimeMillis() + cacheSeconds * 1000L    // useExpiresHeader=true时,HTTP 1.0

        Cache-Control :max-age=cacheSeconds                    // useCacheControlHeader=true时,HTTP 1.1

 

      3、cacheSeconds<0时,则什么都不设置,即保留上次的缓存设置。

 

 

此处简单说一下以上响应头的作用,缓存控制已超出本书内容:

HTTP1.0缓存控制响应头

  Pragma:no-cache:表示防止客户端缓存,需要强制从服务器获取最新的数据;

  Expires:HTTP1.0响应头,本地副本缓存过期时间,如果客户端发现缓存文件没有过期则不发送请求,HTTP的日期时间必须是格林威治时间(GMT), 如“Expires:Wed, 14 Mar 2012 09:38:32 GMT”;

 

HTTP1.1缓存控制响应头

  Cache-Control :no-cache       强制客户端每次请求获取服务器的最新版本,不经过本地缓存的副本验证;

  Cache-Control :no-store       强制客户端不保存请求的副本,该设置是防止Firefox缓存

  Cache-Control:max-age=[秒]    客户端副本缓存的最长时间,类似于HTTP1.0的Expires,只是此处是基于请求的相对时间间隔来计算,而非绝对时间。

 

 

还有相关缓存控制机制如Last-Modified(最后修改时间验证,客户端的上一次请求时间 在 服务器的最后修改时间 之后,说明服务器数据没有发生变化 返回304状态码)、ETag(没有变化时不重新下载数据,返回304)。

 

该抽象类默认被AbstractController和WebContentInterceptor继承。

4.4、AbstractController

该抽象类实现了Controller,并继承了WebContentGenerator(具有该类的特性,具体请看4.3),该类有如下属性:

 

boolean synchronizeOnSession = false:表示该控制器是否在执行时同步session,从而保证该会话的用户串行访问该控制器。

 

[java] view plain copy

  1. public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {  

  2.               //委托给WebContentGenerator进行缓存控制  

  3.               checkAndPrepare(request, response, this instanceof LastModified);  

  4.               //当前会话是否应串行化访问.  

  5.               if (this.synchronizeOnSession) {  

  6.                      HttpSession session = request.getSession(false);  

  7.                      if (session != null) {  

  8.                             Object mutex = WebUtils.getSessionMutex(session);  

  9.                             synchronized (mutex) {  

  10.                                    return handleRequestInternal(request, response);  

  11.                             }  

  12.                      }  

  13.               }  

  14.               return handleRequestInternal(request, response);  

  15. }  

 

可以看出AbstractController实现了一些特殊功能,如继承了WebContentGenerator缓存控制功能,并提供了可选的会话的串行化访问功能。而且提供了handleRequestInternal方法,因此我们应该在具体的控制器类中实现handleRequestInternal方法,而不再是handleRequest。

 

 

AbstractController使用方法:

首先让我们使用AbstractController来重写第二章的HelloWorldController:

 

[java] view plain copy

  1. public class HelloWorldController extends AbstractController {  

  2.     @Override  

  3.     protected ModelAndView handleRequestInternal(HttpServletRequest req, HttpServletResponse resp) throws Exception {  

  4.         //1、收集参数  

  5.         //2、绑定参数到命令对象  

  6.         //3、调用业务对象  

  7.         //4、选择下一个页面  

  8.         ModelAndView mv = new ModelAndView();  

  9.         //添加模型数据 可以是任意的POJO对象  

  10.         mv.addObject("message""Hello World!");  

  11.         //设置逻辑视图名,视图解析器会根据该名字解析到具体的视图页面  

  12.         mv.setViewName("hello");  

  13.         return mv;  

  14.     }  

  15. }  

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->  

  2. <bean name="/hello" class="cn.javass.chapter4.web.controller.HelloWorldController"/>  

 

从如上代码我们可以看出:

1、继承AbstractController

2、实现handleRequestInternal方法即可。

 

直接通过response写响应

如果我们想直接在控制器通过response写出响应呢,以下代码帮我们阐述:

 

[java] view plain copy

  1. public class HelloWorldWithoutReturnModelAndViewController extends AbstractController {  

  2.     @Override  

  3.     protected ModelAndView handleRequestInternal(HttpServletRequest req, HttpServletResponse resp) throws Exception {  

  4.   

  5.         resp.getWriter().write("Hello World!!");          

  6.         //如果想直接在该处理器/控制器写响应 可以通过返回null告诉DispatcherServlet自己已经写出响应了,不需要它进行视图解析  

  7.         return null;  

  8.     }  

  9. }  

 

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->  

  2. <bean name="/helloWithoutReturnModelAndView" class="cn.javass.chapter4.web.controller.HelloWorldWithoutReturnModelAndViewController"/>  

 

从如上代码可以看出如果想直接在控制器写出响应,只需要通过response写出,并返回null即可。

 

强制请求方法类型:

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->  

  2. <bean name="/helloWithPOST" class="cn.javass.chapter4.web.controller.HelloWorldController">  

  3.         <property name="supportedMethods" value="POST"></property>  

  4. </bean>  

 

 以上配置表示只支持POST请求,如果是GET请求客户端将收到“HTTP Status 405 - Request method 'GET' not supported”。

 

比如注册/登录可能只允许POST请求。

 

当前请求的session前置条件检查,如果当前请求无session将抛出HttpSessionRequiredException异常:

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->  

  2. <bean name="/helloRequireSession"  

  3. class="cn.javass.chapter4.web.controller.HelloWorldController">  

  4.         <property name="requireSession" value="true"/>  

  5. </bean>  

 

在进入该控制器时,一定要有session存在,否则抛出HttpSessionRequiredException异常。

 

Session同步:

即同一会话只能串行访问该控制器。

 

客户端端缓存控制:

1、缓存5秒,cacheSeconds=5

 

[java] view plain copy

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class HelloWorldCacheController extends AbstractController {  

  4.     @Override  

  5.     protected ModelAndView handleRequestInternal(HttpServletRequest req, HttpServletResponse resp) throws Exception {  

  6.           

  7.         //点击后再次请求当前页面  

  8.         resp.getWriter().write("<a href=''>this</a>");  

  9.         return null;  

  10.     }  

  11. }  

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->  

  2. <bean name="/helloCache"   

  3. class="cn.javass.chapter4.web.controller.HelloWorldCacheController">  

  4. <property name="cacheSeconds" value="5"/>  

  5. </bean>  

 

如上配置表示告诉浏览器缓存5秒钟:

 

开启chrome浏览器调试工具:

 

服务器返回的响应头如下所示:

 

添加了“Expires:Wed, 14 Mar 2012 09:38:32 GMT” 和“Cache-Control:max-age=5” 表示允许客户端缓存5秒,当你点“this”链接时,会发现如下:

 

而且服务器也没有收到请求,当过了5秒后,你再点“this”链接会发现又重新请求服务器下载新数据。

 

注:下面提到一些关于缓存控制的一些特殊情况:

    1、对于一般的页面跳转(如超链接点击跳转、通过js调用window.open打开新页面都是会使用浏览器缓存的,在未过期情况下会直接使用浏览器缓存的副本,在未过期情况下一次请求也不发送);

    2、对于刷新页面(如按F5键刷新),会再次发送一次请求到服务器的;

 

2、不缓存,cacheSeconds=0

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->  

  2. <bean name="/helloNoCache"  

  3. class="cn.javass.chapter4.web.controller.HelloWorldCacheController">  

  4. <property name="cacheSeconds" value="0"/>  

  5. </bean>  

 

以上配置会要求浏览器每次都去请求服务器下载最新的数据:

 

 

3、cacheSeconds<0,将不添加任何数据

响应头什么缓存控制信息也不加。

 

4、Last-Modified缓存机制

(1、在客户端第一次输入url时,服务器端会返回内容和状态码200表示请求成功并返回了内容;同时会添加一个“Last-Modified”的响应头表示此文件在服务器上的最后更新时间,如“Last-Modified:Wed, 14 Mar 2012 10:22:42 GMT”表示最后更新时间为(2012-03-14 10:22);

(2、客户端第二次请求此URL时,客户端会向服务器发送请求头 “If-Modified-Since”,询问服务器该时间之后当前请求内容是否有被修改过,如“If-Modified-Since: Wed, 14 Mar 2012 10:22:42 GMT”,如果服务器端的内容没有变化,则自动返回 HTTP 304状态码(只要响应头,内容为空,这样就节省了网络带宽)。

 

客户端强制缓存过期:

(1、可以按ctrl+F5强制刷新(会添加请求头 HTTP1.0 Pragma:no-cache和 HTTP1.1 Cache-Control:no-cache、If-Modified-Since请求头被删除)表示强制获取服务器内容,不缓存。

(2、在请求的url后边加上时间戳来重新获取内容,加上时间戳后浏览器就认为不是同一份内容:

http://sishuok.com/?2343243243 和 http://sishuok.com/?34334344 是两次不同的请求。

 

Spring也提供了Last-Modified机制的支持,只需要实现LastModified接口,如下所示:

 

[java] view plain copy

  1. package cn.javass.chapter4.web.controller;  

  2. public class HelloWorldLastModifiedCacheController extends AbstractController implements LastModified {  

  3.     private long lastModified;  

  4.     protected ModelAndView handleRequestInternal(HttpServletRequest req, HttpServletResponse resp) throws Exception {  

  5.         //点击后再次请求当前页面  

  6.         resp.getWriter().write("<a href=''>this</a>");  

  7.         return null;  

  8.     }  

  9.     public long getLastModified(HttpServletRequest request) {  

  10.         if(lastModified == 0L) {  

  11.             //TODO 此处更新的条件:如果内容有更新,应该重新返回内容最新修改的时间戳  

  12.             lastModified = System.currentTimeMillis();  

  13.         }  

  14.         return lastModified;  

  15.     }     

  16. }  

 

[java] view plain copy

  1. <!— 在chapter4-servlet.xml配置处理器 -->     

  2. <bean name="/helloLastModified"   

  3. class="cn.javass.chapter4.web.controller.HelloWorldLastModifiedCacheController"/>  

 

HelloWorldLastModifiedCacheController只需要实现LastModified接口的getLastModified方法,保证当内容发生改变时返回最新的修改时间即可。

 

分析:

(1、发送请求到服务器,如(http://localhost:9080/springmvc-chapter4/helloLastModified),则服务器返回的响应为:




(2、再次按F5刷新客户端,返回状态码304表示服务器没有更新过:

 

(3、重启服务器,再次刷新,会看到200状态码(因为服务器的lastModified时间变了)。

 

Spring判断是否过期,通过如下代码,即请求的“If-Modified-Since” 大于等于当前的getLastModified方法的时间戳,则认为没有修改:

this.notModified = (ifModifiedSince >= (lastModifiedTimestamp / 1000 * 1000));

 

5、ETag(实体标记)缓存机制

(1:浏览器第一次请求,服务器在响应时给请求URL标记,并在HTTP响应头中将其传送到客户端,类似服务器端返回的格式:“ETag:"0f8b0c86fe2c0c7a67791e53d660208e3"”

(2:浏览器第二次请求,客户端的查询更新格式是这样的:“If-None-Match:"0f8b0c86fe2c0c7a67791e53d660208e3"”,如果ETag没改变,表示内容没有发生改变,则返回状态304。

 

 

Spring也提供了对ETag的支持,具体需要在web.xml中配置如下代码:

 

[java] view plain copy

  1. <filter>  

  2.    <filter-name>etagFilter</filter-name>  

  3.    <filter-class>org.springframework.web.filter.ShallowEtagHeaderFilter</filter-class>  

  4. </filter>  

  5. <filter-mapping>  

  6.    <filter-name>etagFilter</filter-name>  

  7.    <servlet-name>chapter4</servlet-name>  

  8. </filter-mapping>  

 

此过滤器只过滤到我们DispatcherServlet的请求。

 

分析:

1):发送请求到服务器:“http://localhost:9080/springmvc-chapter4/hello”,服务器返回的响应头中添加了(ETag:"0f8b0c86fe2c0c7a67791e53d660208e3"):

 

2):浏览器再次发送请求到服务器(按F5刷新),请求头中添加了“If-None-Match:

"0f8b0c86fe2c0c7a67791e53d660208e3"”,响应返回304代码,表示服务器没有修改,并且响应头再次添加了“ETag:"0f8b0c86fe2c0c7a67791e53d660208e3"”(每次都需要计算):

 

那服务器端是如何计算ETag的呢?

 

[java] view plain copy

  1. protected String generateETagHeaderValue(byte[] bytes) {  

  2.               StringBuilder builder = new StringBuilder("\"0");  

  3.               DigestUtils.appendMd5DigestAsHex(bytes, builder);  

  4.               builder.append('"');  

  5.               return builder.toString();  

  6. }  

 

bytes是response要写回到客户端的响应体(即响应的内容数据),是通过MD5算法计算的内容的摘要信息。也就是说如果服务器内容不发生改变,则ETag每次都是一样的,即服务器端的内容没有发生改变。

 

此处只列举了部分缓存控制,详细介绍超出了本书的范围,强烈推荐: http://www.mnot.net/cache_docs/(中文版http://www.chedong.com/tech/cache_docs.html) 详细了解HTTP缓存控制及为什么要缓存。

 

缓存的目的是减少相应延迟 和 减少网络带宽消耗,比如css、js、图片这类静态资源应该进行缓存。

实际项目一般使用反向代理服务器(如nginx、apache等)进行缓存。



第四章 Controller接口控制器详解(2)


4.5、ServletForwardingController

将接收到的请求转发到一个命名的servlet,具体示例如下:

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.servlet;  

  2. public class ForwardingServlet extends HttpServlet {      

  3.     @Override  

  4.     protected void doGet(HttpServletRequest req, HttpServletResponse resp)  

  5.     throws ServletException, IOException {  

  6.   

  7.         resp.getWriter().write("Controller forward to Servlet");  

  8.           

  9.     }  

  10. }  

 

java代码:

查看复制到剪贴板打印

  1. <servlet>  

  2.     <servlet-name>forwarding</servlet-name>  

  3.     <servlet-class>cn.javass.chapter4.web.servlet.ForwardingServlet</servlet-class>  

  4. </servlet>  

 

java代码:

查看复制到剪贴板打印

  1. <!— 在chapter4-servlet.xml配置处理器 -->     

  2. <bean name="/forwardToServlet"   

  3. class="org.springframework.web.servlet.mvc.ServletForwardingController">  

  4.         <property name="servletName" value="forwarding"></property>  

  5. </bean>  

 

当我们请求/forwardToServlet时,会被转发到名字为“forwarding”的servlet处理,该sevlet的servlet-mapping标签配置是可选的。

 

4.6、BaseCommandController

命令控制器通用基类,提供了以下功能支持:

1、数据绑定:请求参数绑定到一个command object(命令对象,非GoF里的命令设计模式),这里的命令对象是指绑定请求参数的任何POJO对象;

   commandClass:表示命令对象实现类,如UserModel;

   commandName:表示放入请求的命令对象名字(默认command),request.setAttribute(commandName, commandObject);

 

2、验证功能:提供Validator注册功能,注册的验证器会验证命令对象属性数据是否合法;

   validators:通过该属性注入验证器,验证器用来验证命令对象属性是否合法;

 

该抽象类没有没有提供流程功能,只是提供了一些公共的功能,实际使用时需要使用它的子类。

4.7、AbstractCommandController

命令控制器之一,可以实现该控制器来创建命令控制器,该控制器能把自动封装请求参数到一个命令对象,而且提供了验证功能。

 

1、创建命令类(就是普通的JavaBean类/POJO)

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.model;  

  2. public class UserModel {  

  3.     private String username;  

  4.     private String password;  

  5.         //省略setter/getter  

  6. }  

 

2、实现控制器

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class MyAbstractCommandController extends AbstractCommandController {  

  4.     public MyAbstractCommandController() {  

  5.         //设置命令对象实现类  

  6.         setCommandClass(UserModel.class);  

  7.     }  

  8.     @Override  

  9.     protected ModelAndView handle(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {  

  10.         //将命令对象转换为实际类型  

  11.         UserModel user = (UserModel) command;  

  12.         ModelAndView mv = new ModelAndView();  

  13.         mv.setViewName("abstractCommand");  

  14.         mv.addObject("user", user);  

  15.         return mv;  

  16.     }  

  17. }   

 

java代码:

查看复制到剪贴板打印

  1. <!— 在chapter4-servlet.xml配置处理器 -->     

  2. <bean name="/abstractCommand"   

  3. class="cn.javass.chapter4.web.controller.MyAbstractCommandController">  

  4.         <!-- 也可以通过依赖注入 注入命令实现类 -->  

  5.         <!-- property name="commandClass" value="cn.javass.chapter4.model.UserModel"/-->  

  6. </bean>  

 

java代码:

查看复制到剪贴板打印

  1. <!— WEB-INF/jsp/abstractCommand.jsp视图下的主要内容 -->     

  2.   

  3. ${user.username }-${user.password }  

当我们在浏览器中输入“http://localhost:9080/springmvc-chapter4/abstractCommand?username=123&password=123”,会自动将请求参数username和password绑定到命令对象;绑定时按照JavaBean命名规范绑定;

4.8、AbstractFormController

用于支持带步骤的表单提交的命令控制器基类,使用该控制器可以完成:

1、定义表单处理(表单的渲染),并从控制器获取命令对象构建表单;

2、提交表单处理,当用户提交表单内容后,AbstractFormController可以将用户请求的数据绑定到命令对象,并可以验证表单内容、对命令对象进行处理。

 

java代码:

查看复制到剪贴板打印

  1.       @Override  

  2. rotected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)  

  3.     throws Exception {  

  4.      //1、是否是表单提交? 该方法实现为("POST".equals(request.getMethod())),即POST表示表单提交  

  5. if (isFormSubmission(request)) {  

  6.     try {  

  7.         Object command = getCommand(request);  

  8.         ServletRequestDataBinder binder = bindAndValidate(request, command);  

  9.         BindException errors = new BindException(binder.getBindingResult());  

  10.               //表单提交应该放到该方法实现  

  11.         return processFormSubmission(request, response, command, errors);  

  12.     }  

  13.     catch (HttpSessionRequiredException ex) {  

  14.               //省略部分代码  

  15.         return handleInvalidSubmit(request, response);  

  16.     }  

  17. }  

  18. else {  

  19.     //2、表示是表单展示,该方法又转调showForm方法,因此我们需要覆盖showForm来完成表单展示  

  20.     return showNewForm(request, response);  

  21. }  

 

    bindOnNewForm:是否在进行表单展示时绑定请求参数到表单对象,默认false,不绑定;

    sessionForm:session表单模式,如果开启(true)则会将表单对象放置到session中,从而可以跨越多次请求保证数据不丢失(多步骤表单常使用该方式,详解AbstractWizardFormController),默认false;

 

    Object formBackingObject(HttpServletRequest request) :提供给表单展示时使用的表单对象(form object表单要展示的默认数据),默认通过commandName暴露到请求给展示表单;

    Map referenceData(HttpServletRequest request, Object command, Errors errors):展示表单时需要的一些引用数据(比如用户注册,可能需要选择工作地点,这些数据可以通过该方法提供),如:

 

java代码:

查看复制到剪贴板打印

  1. protected Map referenceData(HttpServletRequest request) throws Exception {  

  2.              Map model = new HashMap();  

  3.              model.put("cityList", cityList);  

  4.              return model;  

  5. }  

    这样就可以在表单展示页面获取cityList数据。

 

SimpleFormController继承该类,而且提供了更简单的表单流程控制。

4.9、SimpleFormController

提供了更好的两步表单支持:

1、准备要展示的数据,并到表单展示页面;

2、提交数据数据进行处理。

 

第一步,展示:

 

第二步,提交表单:

接下来咱们写一个用户注册的例子学习一下:

(1、控制器

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class RegisterSimpleFormController extends SimpleFormController {      

  4.     public RegisterSimpleFormController() {  

  5.         setCommandClass(UserModel.class); //设置命令对象实现类  

  6.         setCommandName("user");//设置命令对象的名字  

  7.     }  

  8.     //form object 表单对象,提供展示表单时的表单数据(使用commandName放入请求)  

  9.     protected Object formBackingObject(HttpServletRequest request) throws Exception {  

  10.         UserModel user = new UserModel();  

  11.         user.setUsername("请输入用户名");  

  12.         return user;  

  13.     }  

  14.     //提供展示表单时需要的一些其他数据    

  15.     protected Map referenceData(HttpServletRequest request) throws Exception {  

  16.         Map map = new HashMap();  

  17.         map.put("cityList", Arrays.asList("山东""北京""上海"));  

  18.         return map;  

  19.     }  

  20.     protected void doSubmitAction(Object command) throws Exception {  

  21.         UserModel user = (UserModel) command;  

  22.         //TODO 调用业务对象处理  

  23.         System.out.println(user);  

  24.     }  

  25. }  

 

setCommandClass和setCommandName:分别设置了命令对象的实现类和名字;

formBackingObject和referenceData:提供了表单展示需要的视图;

doSubmitAction:用于执行表单提交动作,由onSubmit方法调用,如果不需要请求/响应对象或进行数据验证,可以直接使用doSubmitAction方法进行功能处理。

(2、spring配置(chapter4-servlet.xml)


java代码:

查看复制到剪贴板打印

  1. <bean name="/simpleForm"   

  2. class="cn.javass.chapter4.web.controller.RegisterSimpleFormController">  

  3.         <property name="formView" value="register"/>  

  4.         <property name="successView" value="redirect:/success"/>  

  5. </bean>  

  6. <bean name="/success" class="cn.javass.chapter4.web.controller.SuccessController"/>  

formView:表示展示表单时显示的页面;

successView:表示处理成功时显示的页面;“redirect:/success”表示成功处理后重定向到/success控制器;防止表单重复提交;

/success” bean的作用是显示成功页面,此处就不列举了。

 

(3、视图页面

 

java代码:

查看复制到剪贴板打印

  1. <!-- register.jsp 注册展示页面-->  

  2. <form method="post">  

  3. username:<input type="text" name="username" value="${user.username}"><br/>  

  4. password:<input type="password" name="username"><br/>  

  5. city:<select>  

  6.   <c:forEach items="${cityList }" var="city">  

  7.    <option>${city}</option>  

  8.   </c:forEach>  

  9. </select><br/>  

  10. <input type="submit" value="注册"/>  

  11. </form>  

此处可以使用${user.username}获取到formBackingObject设置的表单对象、使用${cityList}获取referenceData设置的表单支持数据;

 

到此一个简单的两步表单到此结束,但这个表单有重复提交表单的问题,而且表单对象到页面的绑定是通过手工绑定的,后边我们会学习spring标签库(提供自动绑定表单对象到页面)。

4.10、CancellableFormController

一个可取消的表单控制器,继承SimpleFormController,额外提供取消表单功能。

 

1、表单展示:和SimpleFormController一样;

2、表单取消:和SimpleFormController一样;

3、表单成功提交:取消功能处理方法为:onCancel(Object command),而且默认返回cancelView属性指定的逻辑视图名。

   那如何判断是取消呢?如果请求中有参数名为“_cancel”的参数,则表示表单取消。也可以通过cancelParamKey来修改参数名(如“_cancel.x”等)。

示例:

 

(1、控制器

复制RegisterSimpleFormController一份命名为CanCancelRegisterSimpleFormController,添加取消功能处理方法实现:

 

java代码:

查看复制到剪贴板打印

  1. @Override  

  2. protected ModelAndView onCancel(Object command) throws Exception {  

  3.     UserModel user = (UserModel) command;  

  4.     //TODO 调用业务对象处理  

  5.     System.out.println(user);  

  6.     return super.onCancel(command);  

  7. }  

onCancel:在该功能方法内实现取消逻辑,父类的onCancel方法默认返回cancelView属性指定的逻辑视图名。

 

(2、spring配置(chapter4-servlet.xml)

 

java代码:

查看复制到剪贴板打印

  1. <bean name="/canCancelForm"   

  2. class="cn.javass.chapter4.web.controller.CanCancelRegisterSimpleFormController">  

  3.         <property name="formView" value="register"/>  

  4.         <property name="successView" value="redirect:/success"/>  

  5.         <property name="cancelView" value="redirect:/cancel"/>  

  6. </bean>  

  7. <bean name="/cancel" class="cn.javass.chapter4.web.controller.CancelController"/>  

cancelParamKey:用于判断是否是取消的请求参数名,默认是_cancel,即如果请求参数数据中含有名字_cancel则表示是取消,将调用onCancel功能处理方法;

cancelView:表示取消时时显示的页面;“redirect:/cancel”表示成功处理后重定向到/cancel控制器;防止表单重复提交;

/cancel” bean的作用是显示取消页面,此处就不列举了(详见代码)。

(3、视图页面(修改register.jsp)


java代码:

查看复制到剪贴板打印

  1. <input type="submit" name="_cancel" value="取消"/>  


该提交按钮的作用是取消,因为name="_cancel",即请求后会有一个名字为_cancel的参数,因此会执行onCancel功能处理方法。

(4、测试:

在浏览器输入“http://localhost:9080/springmvc-chapter4/canCancelForm”,则首先到展示视图页面,点击“取消按钮”将重定向到“http://localhost:9080/springmvc-chapter4/cancel”,说明取消成功了。

 

 

实际项目可能会出现比如一些网站的完善个人资料都是多个页面(即多步),那应该怎么实现呢?接下来让我们看一下spring Web MVC提供的对多步表单的支持类AbstractWizardFormController。


第四章 Controller接口控制器详解(3)

4.11、AbstractWizardFormController

向导控制器类提供了多步骤(向导)表单的支持(如完善个人资料时分步骤填写基本信息、工作信息、学校信息等)

假设现在做一个完善个人信息的功能,分三个页面展示:

1、页面1完善基本信息;

2、页面2完善学校信息;

3、页面3完善工作信息。

这里我们要注意的是当用户跳转到页面2时页面1的信息是需要保存起来的,还记得AbstractFormController中的sessionForm吗? 如果为true则表单数据存放到session中,哈哈,AbstractWizardFormController就是使用了这个特性。


向导中的页码从0开始;

PARAM_TARGET = "_target":

用于选择向导中的要使用的页面参数名前缀,如“_target0”则选择第0个页面显示,即图中的“wizard/baseInfo”,以此类推,如“_target1”将选择第1页面,要得到的页码为去除前缀“_target”后的数字即是;

PARAM_FINISH = "_finish":

如果请求参数中有名为“_finish”的参数,表示向导成功结束,将会调用processFinish方法进行完成时的功能处理;

PARAM_CANCEL = "_cancel":

如果请求参数中有名为“_cancel”的参数,表示向导被取消,将会调用processCancel方法进行取消时的功能处理;

向导中的命令对象:

向导中的每一个步骤都会把相关的参数绑定到命令对象,该表单对象默认放置在session中,从而可以跨越多次请求得到该命令对象。

 

接下来具体看一下如何使用吧。

(1、修改我们的模型数据以支持多步骤提交: 

 

Java代码  

  1. public class UserModel {  

  2.     private String username;  

  3.     private String password;  

  4.     private String realname; //真实姓名  

  5.     private WorkInfoModel workInfo;  

  6.     private SchoolInfoModel schoolInfo;  

  7.     //省略getter/setter  

  8. }  

 

Java代码  

  1. public class SchoolInfoModel {  

  2.     private String schoolType; //学校类型:高中、中专、大学  

  3.     private String schoolName; //学校名称  

  4.     private String specialty; //专业  

  5. //省略getter/setter  

  6. }  

 

Java代码  

  1. public class WorkInfoModel {  

  2.     private String city; //所在城市  

  3.     private String job; //职位  

  4.     private String year; //工作年限  

  5. //省略getter/setter  

  6. }  

 

(2、控制器

  

Java代码  

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class InfoFillWizardFormController extends AbstractWizardFormController {      

  4.     public InfoFillWizardFormController() {  

  5.         setCommandClass(UserModel.class);  

  6.         setCommandName("user");  

  7.     }  

  8.     protected Map referenceData(HttpServletRequest request, int page) throws Exception {  

  9.         Map map = new HashMap();  

  10.         if(page==1) { //如果是填写学校信息页 需要学校类型信息  

  11.             map.put("schoolTypeList", Arrays.asList("高中", "中专", "大学"));  

  12.         }  

  13.         if(page==2) {//如果是填写工作信息页 需要工作城市信息  

  14.             map.put("cityList", Arrays.asList("济南", "北京", "上海"));  

  15.         }  

  16.         return map;  

  17.     }     

  18.     protected void validatePage(Object command, Errors errors, int page) {  

  19.         //提供每一页数据的验证处理方法  

  20.     }  

  21.     protected void postProcessPage(HttpServletRequest request, Object command, Errors errors, int page) throws Exception {  

  22.         //提供给每一页完成时的后处理方法  

  23.     }  

  24.     protected ModelAndView processFinish(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {  

  25.         //成功后的处理方法  

  26.         System.out.println(command);  

  27.         return new ModelAndView("redirect:/success");  

  28.     }  

  29.     protected ModelAndView processCancel(HttpServletRequest request, HttpServletResponse response, Object command, BindException errors) throws Exception {  

  30.         //取消后的处理方法  

  31.         System.out.println(command);  

  32.         return new ModelAndView("redirect:/cancel");  

  33.     }  

  34. }  

 

page页码:是根据请求中以“_target”开头的参数名来确定的,如“_target0”,则页码为0;

referenceData:提供每一页需要的表单支持对象,如完善学校信息需要学校类型,page页码从0开始(而且根据请求参数中以“_target”开头的参数来确定当前页码,如_target1,则page=1);

validatePage:验证当前页的命令对象数据,验证应根据page页码来分步骤验证;

postProcessPage:验证成功后的后处理;

processFinish:成功时执行的方法,此处直接重定向到/success控制器(详见CancelController);

processCancel:取消时执行的方法,此处直接重定向到/cancel控制器(详见SuccessController);

 

其他需要了解:

allowDirtyBack和allowDirtyForward:决定在当前页面验证失败时,是否允许向导前移和后退,默认false不允许;

onBindAndValidate(HttpServletRequest request, Object command, BindException errors, int page):允许覆盖默认的绑定参数到命令对象和验证流程。

(3、spring配置文件(chapter4-servlet.xml)

 

Java代码  

  1. <bean name="/infoFillWizard"   

  2. class="cn.javass.chapter4.web.controller.InfoFillWizardFormController">  

  3.     <property name="pages">  

  4.         <list>  

  5.             <value>wizard/baseInfo</value>  

  6.             <value>wizard/schoolInfo</value>  

  7.             <value>wizard/workInfo</value>  

  8.        </list>  

  9.     </property>  

  10. </bean>      

 

pages:表示向导中每一个步骤的逻辑视图名,当InfoFillWizardFormController的page=0,则将会选择“wizard/baseInfo”,以此类推,从而可以按步骤选择要展示的视图。

 

(4、向导中的每一步视图

(4.1、基本信息页面(第一步) baseInfo.jsp: 

 

Java代码  

  1. <form method="post">  

  2. 真实姓名:<input type="text" name="realname" value="${user.realname}"><br/>  

  3. <input type="submit" name="_target1" value="下一步"/>  

  4. </form>  

 

当前页码为0;

name="_target1":表示向导下一步要显示的页面的页码为1;

 

(4.2、学校信息页面(第二步) schoolInfo.jsp:

 

Java代码  

  1. <form method="post">  

  2. 学校类型:<select name="schoolInfo.schoolType">  

  3.   <c:forEach items="${schoolTypeList }" var="schoolType">  

  4.    <option value="${schoolType }"   

  5.        <c:if test="${user.schoolInfo.schoolType eq schoolType}">  

  6.            selected="selected"  

  7.        </c:if>  

  8.    >  

  9.        ${schoolType}  

  10.    </option>  

  11.   </c:forEach>  

  12. </select><br/>  

  13. 学校名称:<input type="text" name="schoolInfo.schoolName" value="${user.schoolInfo.schoolName}"/><br/>  

  14. 专业:<input type="text" name="schoolInfo.specialty" value="${user.schoolInfo.specialty}"/><br/>  

  15. <input type="submit" name="_target0" value="上一步"/>  

  16. <input type="submit" name="_target2" value="下一步"/>  

  17. </form>  

 

(4.3、工作信息页面(第三步) workInfo.jsp:

 

Java代码  

  1. <form method="post">  

  2. 所在城市:<select name="workInfo.city">  

  3.   <c:forEach items="${cityList }" var="city">  

  4.    <option value="${city }"   

  5.        <c:if test="${user.workInfo.city eq city}">selected="selected"</c:if>  

  6.    >  

  7.      ${city}  

  8.    </option>  

  9.   </c:forEach>  

  10. </select><br/>  

  11. 职位:<input type="text" name="workInfo.job" value="${user.workInfo.job}"/><br/>  

  12. 工作年限:<input type="text" name="workInfo.year" value="${user.workInfo.year}"/><br/>  

  13. <input type="submit" name="_target1" value="上一步"/>  

  14. <input type="submit" name="_finish" value="完成"/>  

  15. <input type="submit" name="_cancel" value="取消"/>  

  16. </form>  

 

当前页码为2;

name="_target1":上一步,表示向导上一步要显示的页面的页码为1;

name="_finish":向导完成,表示向导成功,将会调用向导控制器的processFinish方法

name="_cancel":向导取消,表示向导被取消,将会调用向导控制器的processCancel方法

 

到此向导控制器完成,此处的向导流程比较简单,如果需要更复杂的页面流程控制,可以选择使用Spring Web Flow框架。

 

4.12、ParameterizableViewController

参数化视图控制器,不进行功能处理(即静态视图),根据参数的逻辑视图名直接选择需要展示的视图。 

 

Java代码  

  1. <bean name="/parameterizableView"   

  2. class="org.springframework.web.servlet.mvc.ParameterizableViewController">  

  3. <property name="viewName" value="success"/>  

  4. </bean>  

 

该控制器接收到请求后直接选择参数化的视图,这样的好处是在配置文件中配置,从而避免程序的硬编码,比如像帮助页面等不需要进行功能处理,因此直接使用该控制器映射到视图。

4.13、AbstractUrlViewController

提供根据请求URL路径直接转化为逻辑视图名的支持基类,即不需要功能处理,直接根据URL计算出逻辑视图名,并选择具体视图进行展示:

urlDecode:是否进行url解码,不指定则默认使用服务器编码进行解码(如Tomcat默认ISO-8859-1);

urlPathHelper:用于解析请求路径的工具类,默认为org.springframework.web.util.UrlPathHelper。

 

UrlFilenameViewController是它的一个实现者,因此我们应该使用UrlFilenameViewController。

 

4.14、UrlFilenameViewController

将请求的URL路径转换为逻辑视图名并返回的转换控制器,即不需要功能处理,直接根据URL计算出逻辑视图名,并选择具体视图进行展示:

 

根据请求URL路径计算逻辑视图名; 

 

Java代码  

  1. <bean name="/index1/*"   

  2. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

  3. <bean name="/index2/**"   

  4. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

  5. <bean name="/*.html"   

  6. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

  7. <bean name="/index3/*.html"   

  8. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

 

/index1/*:可以匹配/index1/demo,但不匹配/index1/demo/demo,如/index1/demo逻辑视图名为demo;

/index2/**:可以匹配/index2路径下的所有子路径,如匹配/index2/demo,或/index2/demo/demo,“/index2/demo”的逻辑视图名为demo,而“/index2/demo/demo”逻辑视图名为demo/demo;

/*.html:可以匹配如/abc.html,逻辑视图名为abc,后缀会被删除(不仅仅可以是html);

/index3/*.html:可以匹配/index3/abc.html,逻辑视图名也是abc;

 

上述模式为Spring Web MVC使用的Ant-style 模式进行匹配的:

 

Java代码  

  1. ?    匹配一个字符,如/index? 可以匹配 /index1 , 但不能匹配 /index 或 /index12  

  2. *    匹配零个或多个字符,如/index1/*,可以匹配/index1/demo,但不匹配/index1/demo/demo 

  3. **   匹配零个或多个路径,如/index2/**:可以匹配/index2路径下的所有子路径,如匹配/index2/demo,或/index2/demo/demo 

  4.  

  5. 如果我有如下模式,那Spring该选择哪一个执行呢?当我的请求为“/long/long”时如下所示: 

  6. /long/long 

  7. /long/**/abc  

  8. /long/** 

  9. /** 

  10. Spring的AbstractUrlHandlerMapping使用:最长匹配优先; 

  11. 如请求为“/long/long” 将匹配第一个“/long/long”,但请求“/long/acd” 则将匹配 “/long/**”,如请求“/long/aa/abc”则匹配“/long/**/abc”,如请求“/abc”则将匹配“/**”  

 

UrlFilenameViewController还提供了如下属性:

prefix:生成逻辑视图名的前缀;

suffix:生成逻辑视图名的后缀;

 

Java代码  

  1. protected String postProcessViewName(String viewName) {  

  2.         return getPrefix() + viewName + getSuffix();  

  3. }  

 

Java代码  

  1. <bean name="/*.htm" class="org.springframework.web.servlet.mvc.UrlFilenameViewController">  

  2.         <property name="prefix" value="test"/>  

  3.         <property name="suffix" value="test"/>  

  4. </bean>  

 

prefix=“test”,suffix=“test”,如上所示的/*.htm:可以匹配如/abc.htm,但逻辑视图名将变为testabctest。

第四章 Controller接口控制器详解(4)

 

4.12、ParameterizableViewController

参数化视图控制器,不进行功能处理(即静态视图),根据参数的逻辑视图名直接选择需要展示的视图。

Java代码   

  1. <bean name="/parameterizableView"  

  2. class="org.springframework.web.servlet.mvc.ParameterizableViewController">  

  3. <property name="viewName" value="success"/>  

  4. </bean>  

该控制器接收到请求后直接选择参数化的视图,这样的好处是在配置文件中配置,从而避免程序的硬编码,比如像帮助页面等不需要进行功能处理,因此直接使用该控制器映射到视图。

4.13、AbstractUrlViewController

提供根据请求URL路径直接转化为逻辑视图名的支持基类,即不需要功能处理,直接根据URL计算出逻辑视图名,并选择具体视图进行展示:

urlDecode:是否进行url解码,不指定则默认使用服务器编码进行解码(如Tomcat默认ISO-8859-1);

urlPathHelper:用于解析请求路径的工具类,默认为org.springframework.web.util.UrlPathHelper。

 

UrlFilenameViewController是它的一个实现者,因此我们应该使用UrlFilenameViewController。

 

4.14、UrlFilenameViewController

将请求的URL路径转换为逻辑视图名并返回的转换控制器,即不需要功能处理,直接根据URL计算出逻辑视图名,并选择具体视图进行展示:

 

根据请求URL路径计算逻辑视图名;

 

Java代码   

  1. <bean name="/index1/*"   

  2. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

  3. <bean name="/index2/**"   

  4. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

  5. <bean name="/*.html"   

  6. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

  7. <bean name="/index3/*.html"   

  8. class="org.springframework.web.servlet.mvc.UrlFilenameViewController"/>  

/index1/*:可以匹配/index1/demo,但不匹配/index1/demo/demo,如/index1/demo逻辑视图名为demo;

/index2/**:可以匹配/index2路径下的所有子路径,如匹配/index2/demo,或/index2/demo/demo,“/index2/demo”的逻辑视图名为demo,而“/index2/demo/demo”逻辑视图名为demo/demo;

/*.html:可以匹配如/abc.html,逻辑视图名为abc,后缀会被删除(不仅仅可以是html);

/index3/*.html:可以匹配/index3/abc.html,逻辑视图名也是abc;

 

上述模式为Spring Web MVC使用的Ant-style 模式进行匹配的:

 

Java代码   

  1. ?    匹配一个字符,如/index? 可以匹配 /index1 , 但不能匹配 /index 或 /index12  

  2. *    匹配零个或多个字符,如/index1/*,可以匹配/index1/demo,但不匹配/index1/demo/demo 

  3. **   匹配零个或多个路径,如/index2/**:可以匹配/index2路径下的所有子路径,如匹配/index2/demo,或/index2/demo/demo 

  4.  

  5. 如果我有如下模式,那Spring该选择哪一个执行呢?当我的请求为“/long/long”时如下所示: 

  6. /long/long 

  7. /long/**/abc  

  8. /long/** 

  9. /** 

  10. Spring的AbstractUrlHandlerMapping使用:最长匹配优先; 

  11. 如请求为“/long/long” 将匹配第一个“/long/long”,但请求“/long/acd” 则将匹配 “/long/**”,如请求“/long/aa/abc”则匹配“/long/**/abc”,如请求“/abc”则将匹配“/**”  

UrlFilenameViewController还提供了如下属性:

prefix:生成逻辑视图名的前缀;

suffix:生成逻辑视图名的后缀;

Java代码   

  1. protected String postProcessViewName(String viewName) {  

  2.         return getPrefix() + viewName + getSuffix();  

  3. }  

Java代码   

  1. <bean name="/*.htm" class="org.springframework.web.servlet.mvc.UrlFilenameViewController">  

  2.         <property name="prefix" value="test"/>  

  3.         <property name="suffix" value="test"/>  

  4. </bean>  

prefix=“test”,suffix=“test”,如上所示的/*.htm:可以匹配如/abc.htm,但逻辑视图名将变为testabctest。

第四章 Controller接口控制器详解(5)

4.15、MultiActionController

之前学过的控制器如AbstractCommandController、SimpleFormController等一般对应一个功能处理方法(如新增),如果我要实现比如最简单的用户增删改查(CRUD Create-Read-Update-Delete),那该怎么办呢?

 

4.15.1 解决方案

1、每一个功能对应一个控制器,如果是CRUD则需要四个控制器,但这样我们的控制器会暴增,肯定不可取;

2、使用Spring Web MVC提供的MultiActionController,用于支持在一个控制器里添加多个功能处理方法,即将多个请求的处理方法放置到一个控制器里,这种方式不错。

 

4.15.2 问题

1、  MultiActionController如何将不同的请求映射不同的请求的功能处理方法呢?

Spring Web MVC提供了MethodNameResolver(方法名解析器)用于解析当前请求到需要执行的功能处理方法的方法名。默认使用InternalPathMethodNameResolver实现类,另外还提供了ParameterMethodNameResolver和PropertiesMethodNameResolver,当然我们也可以自己来实现,稍候我们仔细研究下它们是如何工作的。

 

2、那我们的功能处理方法应该怎么写呢?

public (ModelAndView | Map | String | void) actionName(HttpServletRequest request, HttpServletResponse response, [,HttpSession session] [,AnyObject]);

 

哦,原来如此,我们只需要按照如上格式写我们的功能处理方法即可;此处需要注意一下几点:

1、返回值:即模型和视图部分;

ModelAndView:模型和视图部分,之前已经见过了;

Map:只返回模型数据,逻辑视图名会根据RequestToViewNameTranslator实现类来计算,稍候讨论;

String:只返回逻辑视图名;

void:表示该功能方法直接写出response响应(如果其他返回值类型(如Map)返回null则和void进行相同的处理);

2、actionName:功能方法名字;由methodNameResolver根据请求信息解析功能方法名,通过反射调用;

3、形参列表:顺序固定,“[]”表示可选,我们来看看几个示例吧:

//表示到新增页面

public ModelAndView toAdd(HttpServletRequest request, HttpServletResponse response);

//表示新增表单提交,在最后可以带着命令对象

public ModelAndView add(HttpServletRequest request, HttpServletResponse response, UserModel user);

//列表,但只返回模型数据,视图名会通过RequestToViewNameTranslator实现来计算

public Map list(HttpServletRequest request, HttpServletResponse response);

//文件下载,返回值类型为void,表示该功能方法直接写响应

public void fileDownload(HttpServletRequest request, HttpServletResponse response)

//第三个参数可以是session

public ModelAndView sessionWith(HttpServletRequest request, HttpServletResponse response, HttpSession session);

//如果第三个参数是session,那么第四个可以是命令对象,顺序必须是如下顺序

public void sessionAndCommandWith(HttpServletRequest request, HttpServletResponse response, HttpSession session, UserModel user)

4、异常处理方法,MultiActionController提供了简单的异常处理,即在请求的功能处理过程中遇到异常会交给异常处理方法进行处理,式如下所示:

public ModelAndView anyMeaningfulName(HttpServletRequest request, HttpServletResponse response, ExceptionClass exception)

MultiActionController会使用最接近的异常类型来匹配对应的异常处理方法,示例如下所示:

 

//处理PayException

public ModelAndView processPayException(HttpServletRequest request, HttpServletResponse response, PayException ex)

//处理Exception

public ModelAndView processException(HttpServletRequest request, HttpServletResponse response,  Exception ex)

4.15.3 MultiActionController类实现

类定义:public class MultiActionController extends AbstractController implements LastModified ,继承了AbstractController,并实现了LastModified接口,默认返回-1;

 

核心属性:

delegate:功能处理的委托对象,即我们要调用请求处理方法所在的对象,默认是this;

methodNameResolver:功能处理方法名解析器,即根据请求信息来解析需要执行的delegate的功能处理方法的方法名。

核心方法:

 

Java代码  

  1. //判断方法是否是功能处理方法  

  2. private boolean isHandlerMethod(Method method) {  

  3.     //得到方法返回值类型  

  4.     Class returnType = method.getReturnType();  

  5.     //返回值类型必须是ModelAndView、Map、String、void中的一种,否则不是功能处理方法  

  6.     if (ModelAndView.class.equals(returnType) || Map.class.equals(returnType) || String.class.equals(returnType) ||  

  7.             void.class.equals(returnType)) {  

  8.         Class[] parameterTypes = method.getParameterTypes();  

  9.         //功能处理方法参数个数必须>=2,且第一个是HttpServletRequest类型、第二个是HttpServletResponse  

  10.         //且不能Controller接口的handleRequest(HttpServletRequest request, HttpServletResponse response),这个方法是由系统调用  

  11.         return (parameterTypes.length >= 2 &&  

  12.                 HttpServletRequest.class.equals(parameterTypes[0]) &&  

  13.                 HttpServletResponse.class.equals(parameterTypes[1]) &&  

  14.                 !("handleRequest".equals(method.getName()) && parameterTypes.length == 2));  

  15.     }  

  16.     return false;  

  17. }  

 

Java代码  

  1. //是否是异常处理方法  

  2. private boolean isExceptionHandlerMethod(Method method) {  

  3.     //异常处理方法必须是功能处理方法 且 参数长度为3、第三个参数类型是Throwable子类  

  4.     return (isHandlerMethod(method) &&  

  5.             method.getParameterTypes().length == 3 &&  

  6.             Throwable.class.isAssignableFrom(method.getParameterTypes()[2]));  

  7. }  

Java代码  

  1. private void registerHandlerMethods(Object delegate) {  

  2.     //缓存Map清空  

  3.     this.handlerMethodMap.clear();  

  4.     this.lastModifiedMethodMap.clear();  

  5.     this.exceptionHandlerMap.clear();  

  6.   

  7.     //得到委托对象的所有public方法  

  8.     Method[] methods = delegate.getClass().getMethods();  

  9.     for (Method method : methods) {  

  10.         //验证是否是异常处理方法,如果是放入exceptionHandlerMap缓存map  

  11.         if (isExceptionHandlerMethod(method)) {  

  12.             registerExceptionHandlerMethod(method);  

  13.         }  

  14.         //验证是否是功能处理方法,如果是放入handlerMethodMap缓存map  

  15.         else if (isHandlerMethod(method)) {  

  16.             registerHandlerMethod(method);  

  17.             registerLastModifiedMethodIfExists(delegate, method);  

  18.         }  

  19.     }  

  20. }  

Java代码  

  1. protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)  

  2.         throws Exception {  

  3.     try {  

  4.         //1、使用methodNameResolver 方法名解析器根据请求解析到要执行的功能方法的方法名  

  5.         String methodName = this.methodNameResolver.getHandlerMethodName(request);  

  6.         //2、调用功能方法(通过反射调用,此处就粘贴代码了)  

  7.         return invokeNamedMethod(methodName, request, response);  

  8.     }  

  9.     catch (NoSuchRequestHandlingMethodException ex) {  

  10.         return handleNoSuchRequestHandlingMethod(ex, request, response);  

  11.     }  

  12. }  

 

接下来,我们看一下MultiActionController如何使用MethodNameResolver来解析请求到功能处理方法的方法名。

4.15.4 MethodNameResolver

1、InternalPathMethodNameResolver:MultiActionController的默认实现,提供从请求URL路径解析功能方法的方法名,从请求的最后一个路径(/)开始,并忽略扩展名;如请求URL是“/user/list.html”,则解析的功能处理方法名为“list”,即调用list方法。该解析器还可以指定前缀和后缀,通过prefix和suffix属性,如指定prefix=”test_”,则功能方法名将变为test_list;

 

2、ParameterMethodNameResolver:提供从请求参数解析功能处理方法的方法名,并按照如下顺序进行解析:

<!--[if !supportLists]-->(1、    <!--[endif]-->methodParamNames:根据请求的参数名解析功能方法名(功能方法名和参数名同名);

Java代码  

  1. <property name="methodParamNames" value="list,create,update"/>         

  如上配置时,如果请求中含有参数名list、create、update时,则功能处理方法名为list、create、update,这种方式的可以在当一个表单有多个提交按钮时使用,不同的提交按钮名字不一样即可。

  ParameterMethodNameResolver也考虑到图片提交按钮提交问题:

    <input type="image" name="list"> 和submit类似可以提交表单,单击该图片后会发送两个参数“list.x=x轴坐标”和“list.y=y轴坐标”(如提交后会变为list.x=7&list.y=5);因此我们配置的参数名(如list)在会加上“.x” 和 “.y”进行匹配。

 

Java代码  

  1. for (String suffix : SUBMIT_IMAGE_SUFFIXES)  {//SUBMIT_IMAGE_SUFFIXES {“.x”, “.y”}  

  2.     if (request.getParameter(name + suffix) != null) {// name是我们配置的methodParamNames  

  3.         return true;  

  4.     }  

  5. }  

 

(2、paramName:根据请求参数名的值解析功能方法名,默认的参数名是action,即请求的参数中含有“action=query”,则功能处理方法名为query;

(3、logicalMappings:逻辑功能方法名到真实功能方法名映射,如下所示:

Java代码  

  1. <property name="logicalMappings">  

  2.     <props>  

  3.         <prop key="doList">list</prop>  

  4.     </props>  

  5. </property>  

  即如果步骤1或2解析出逻辑功能方法名为doList(逻辑的),将会被重新映射为list功能方法名(真正执行的)。

(4、defaultMethodName:默认的方法名,当以上策略失败时默认调用的方法名。

 

3、PropertiesMethodNameResolver:提供自定义的从请求URL解析功能方法的方法名,使用一组用户自定义的模式到功能方法名的映射,映射使用Properties对象存放,具体配置示例如下:

Java代码  

  1. <bean id="propertiesMethodNameResolver"   

  2. class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">  

  3.     <property name="mappings">  

  4.         <props>  

  5.               <prop key="/create">create</prop>  

  6.               <prop key="/update">update</prop>  

  7.               <prop key="/delete">delete</prop>  

  8.               <prop key="/list">list</prop>  

  9.               <!-- 默认的行为 -->  

  10.               <prop key="/**">list</prop>  

  11.         </props>  

  12.     </property>  

  13. </bean>   

对于/create请求将调用create方法,Spring内部使用PathMatcher进行匹配(默认实现是AntPathMatcher)。

4.15.5 RequestToViewNameTranslator

用于直接将请求转换为逻辑视图名。默认实现为DefaultRequestToViewNameTranslator。

 

1、DefaultRequestToViewNameTranslator:将请求URL转换为逻辑视图名,默认规则如下:

  http://localhost:9080/web上下文/list -------> 逻辑视图名为list

  http://localhost:9080/web上下文/list.html -------> 逻辑视图名为list(默认删除扩展名)

  http://localhost:9080/web上下文/user/list.html -------> 逻辑视图名为user/list

4.15.6 示例

(1、控制器UserController

Java代码  

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class UserController extends MultiActionController {  

  4.     //用户服务类  

  5.     private UserService userService;  

  6.     //逻辑视图名 通过依赖注入方式注入,可配置  

  7.     private String createView;  

  8.     private String updateView;  

  9.     private String deleteView;  

  10.     private String listView;  

  11.     private String redirectToListView;  

  12.     //省略setter/getter  

  13.   

  14.     public String create(HttpServletRequest request, HttpServletResponse response, UserModel user) {  

  15.         if("GET".equals(request.getMethod())) {  

  16.             //如果是get请求 我们转向 新增页面  

  17.             return getCreateView();  

  18.         }  

  19.         userService.create(user);  

  20.         //直接重定向到列表页面  

  21.         return getRedirectToListView();  

  22.     }  

  23.     public ModelAndView update(HttpServletRequest request, HttpServletResponse response, UserModel user) {  

  24.         if("GET".equals(request.getMethod())) {  

  25.             //如果是get请求 我们转向更新页面  

  26.             ModelAndView mv = new ModelAndView();  

  27.             //查询要更新的数据  

  28.             mv.addObject("command", userService.get(user.getUsername()));  

  29.             mv.setViewName(getUpdateView());  

  30.             return mv;  

  31.         }  

  32.         userService.update(user);  

  33.         //直接重定向到列表页面  

  34.         return new ModelAndView(getRedirectToListView());  

  35.     }  

  36.   

  37.       

  38.     public ModelAndView delete(HttpServletRequest request, HttpServletResponse response, UserModel user) {  

  39.         if("GET".equals(request.getMethod())) {  

  40.             //如果是get请求 我们转向删除页面  

  41.             ModelAndView mv = new ModelAndView();  

  42.             //查询要删除的数据  

  43.             mv.addObject("command", userService.get(user.getUsername()));  

  44.             mv.setViewName(getDeleteView());  

  45.             return mv;  

  46.         }  

  47.         userService.delete(user);  

  48.         //直接重定向到列表页面  

  49.         return new ModelAndView(getRedirectToListView());  

  50.     }     

  51.       

  52.     public ModelAndView list(HttpServletRequest request, HttpServletResponse response) {  

  53.         ModelAndView mv = new ModelAndView();  

  54.         mv.addObject("userList", userService.list());  

  55.         mv.setViewName(getListView());  

  56.         return mv;  

  57.     }  

  58.       

  59.     //如果使用委托方式,命令对象名称只能是command  

  60.     protected String getCommandName(Object command) {  

  61.         //命令对象的名字 默认command  

  62.         return "command";  

  63.     }  

  64. }  

  增删改:如果是GET请求方法,则表示到展示页面,POST请求方法表示真正的功能操作;

  getCommandName:表示是命令对象名字,默认command,对于委托对象实现方式无法改变,因此我们就使用默认的吧。

 

(2、spring配置文件chapter4-servlet.xml

 

Java代码  

  1. <bean id="userService" class="cn.javass.chapter4.service.UserService"/>  

  2. <bean name="/user/**" class="cn.javass.chapter4.web.controller.UserController">  

  3.     <property name="userService" ref="userService"/>  

  4.     <property name="createView" value="user/create"/>  

  5.     <property name="updateView" value="user/update"/>  

  6.     <property name="deleteView" value="user/delete"/>  

  7.     <property name="listView" value="user/list"/>  

  8.     <property name="redirectToListView" value="redirect:/user/list"/>  

  9.     <!-- 使用PropertiesMethodNameResolver来解析功能处理方法名 -->         

  10.     <!--property name="methodNameResolver" ref="propertiesMethodNameResolver"/-->  

  11. </bean>  

 

  userService:用户服务类,实现业务逻辑;

  依赖注入:对于逻辑视图页面通过依赖注入方式注入,redirectToListView表示增删改成功后重定向的页面,防止重复表单提交;

  默认使用InternalPathMethodNameResolver解析请求URL到功能方法名。

 

(3、视图页面

(3.1、list页面(WEB-INF/jsp/user/list.jsp)

 

Java代码  

  1. <a href="${pageContext.request.contextPath}/user/create">用户新增</a><br/>  

  2. <table border="1" width="50%">  

  3.    <tr>  

  4.       <th>用户名</th>  

  5.       <th>真实姓名</th>  

  6.       <th>操作</th>  

  7.    </tr>   

  8.    <c:forEach items="${userList}" var="user">  

  9.    <tr>  

  10.       <td>${user.username }</td>  

  11.       <td>${user.realname }</td>  

  12.       <td>  

  13.           <a href="${pageContext.request.contextPath}/user/update?username=${user.username}">更新</a>  

  14.           |  

  15.           <a href="${pageContext.request.contextPath}/user/delete?username=${user.username}">删除</a>  

  16.       </td>  

  17.    </tr>  

  18.    </c:forEach>     

  19. </table>  

 

(3.2、update页面(WEB-INF/jsp/user/update.jsp)

Java代码  

  1. <form action="${pageContext.request.contextPath}/user/update" method="post">  

  2. 用户名: <input type="text" name="username" value="${command.username}"/><br/>  

  3. 真实姓名:<input type="text" name="realname" value="${command.realname}"/><br/>  

  4. <input type="submit" value="更新"/>  

  5. </form>  

(4、测试:

默认的InternalPathMethodNameResolver将进行如下解析:

http://localhost:9080/springmvc-chapter4/user/list————>list方法名;

http://localhost:9080/springmvc-chapter4/user/create————>create方法名;

http://localhost:9080/springmvc-chapter4/user/update————>update功能处理方法名;

http://localhost:9080/springmvc-chapter4/user/delete————>delete功能处理方法名。

 

我们可以将默认的InternalPathMethodNameResolver改为PropertiesMethodNameResolver:

Java代码  

  1. <bean id="propertiesMethodNameResolver"   

  2. class="org.springframework.web.servlet.mvc.multiaction.PropertiesMethodNameResolver">  

  3.     <property name="mappings">  

  4.         <props>  

  5.               <prop key="/create">create</prop>  

  6.               <prop key="/update">update</prop>  

  7.               <prop key="/delete">delete</prop>  

  8.               <prop key="/list">list</prop>  

  9.               <prop key="/**">list</prop><!-- 默认的行为 -->  

  10.           </props>  

  11.     </property>  

  12. </bean>     

  13. <bean name="/user/**" class="cn.javass.chapter4.web.controller.UserController">  

  14.        <!—省略其他配置,详见配置文件-->  

  15.        <!-- 使用PropertiesMethodNameResolver来解析功能处理方法名 -->         

  16.        <property name="methodNameResolver" ref="propertiesMethodNameResolver"/>  

  17. </bean>   

 /**表示默认解析到list功能处理方法。

如上配置方式可以很好的工作,但必须继承MultiActionController,Spring Web MVC提供给我们无需继承MultiActionController实现方式,即使有委托对象方式,继续往下看吧。

4.15.7、委托方式实现

(1、控制器UserDelegate

   将UserController复制一份,改名为UserDelegate,并把继承MultiActionController去掉即可,其他无需改变。

(2、spring配置文件chapter4-servlet.xml 

Java代码  

  1. <!—委托对象-->  

  2. <bean id="userDelegate" class="cn.javass.chapter4.web.controller.UserDelegate">  

  3.    <property name="userService" ref="userService"/>  

  4.    <property name="createView" value="user2/create"/>  

  5.    <property name="updateView" value="user2/update"/>  

  6.    <property name="deleteView" value="user2/delete"/>  

  7.    <property name="listView" value="user2/list"/>  

  8.    <property name="redirectToListView" value="redirect:/user2/list"/>  

  9. </bean>  

  10. <!—控制器对象-->  

  11. <bean name="/user2/**"   

  12. class="org.springframework.web.servlet.mvc.multiaction.MultiActionController">  

  13. <property name="delegate" ref="userDelegate"/>  

  14.     <property name="methodNameResolver" ref="parameterMethodNameResolver"/>  

  15. </bean>  

 delegate:控制器对象通过delegate属性指定委托对象,即实际调用delegate委托对象的功能方法。

 methodNameResolver:此处我们使用ParameterMethodNameResolver解析器;

Java代码  

  1. <!—ParameterMethodNameResolver -->  

  2. <bean id="parameterMethodNameResolver"   

  3. class="org.springframework.web.servlet.mvc.multiaction.ParameterMethodNameResolver">  

  4. <!-- 1、根据请求参数名解析功能方法名 -->  

  5.     <property name="methodParamNames" value="create,update,delete"/>  

  6.     <!-- 2、根据请求参数名的值解析功能方法名 -->  

  7.     <property name="paramName" value="action"/>  

  8. <!-- 3、逻辑方法名到真实方法名的映射 -->  

  9.     <property name="logicalMappings">  

  10.        <props>  

  11.            <prop key="doList">list</prop>  

  12.        </props>  

  13.     </property>  

  14.     <!—4、默认执行的功能处理方法 -->  

  15.     <property name="defaultMethodName" value="list"/>  

  16. </bean>     

1、methodParamNames:create,update,delete,当请求中有参数名为这三个的将被映射为功能方法名,如“<input type="submit"name="create" value="新增"/>”提交后解析得到的功能方法名为create;

2、paramName:当请求中有参数名为action,则将值映射为功能方法名,如“<input type="hidden" name="action" value="delete"/>”,提交后解析得到的功能方法名为delete;

3、logicalMappings:逻辑功能方法名到真实功能方法名的映射,如:

    http://localhost:9080/springmvc-chapter4/user2?action=doList;

    首先请求参数“action=doList”,则第二步解析得到逻辑功能方法名为doList;

    本步骤会把doList再转换为真实的功能方法名list。

4、defaultMethodName:以上步骤如果没有解析到功能处理方法名,默认执行的方法名。

 

(3、视图页面

(3.1、list页面(WEB-INF/jsp/user2/list.jsp)

Java代码  

  1. <a href="${pageContext.request.contextPath}/user2?action=create">用户新增</a><br/>  

  2. <table border="1" width="50%">  

  3.    <tr>  

  4.       <th>用户名</th>  

  5.       <th>真实姓名</th>  

  6.       <th>操作</th>  

  7.    </tr>   

  8.    <c:forEach items="${userList}" var="user">  

  9.    <tr>  

  10.       <td>${user.username }</td>  

  11.       <td>${user.realname }</td>  

  12.       <td>  

  13.           <a href="${pageContext.request.contextPath}/user2?action=update&username=${user.username}">更新</a>  

  14.           |  

  15.           <a href="${pageContext.request.contextPath}/user2?action=delete&username=${user.username}">删除</a>  

  16.       </td>  

  17.    </tr>  

  18.    </c:forEach>     

  19. </table>   

(3.2、update页面(WEB-INF/jsp/user2/update.jsp)

Java代码  

  1. <form action="${pageContext.request.contextPath}/user2" method="post">  

  2. <input type="hidden" name="action" value="update"/>  

  3. 用户名: <input type="text" name="username" value="${command.username}"/><br/>  

  4. 真实姓名:<input type="text" name="realname" value="${command.realname}"/><br/>  

  5. <input type="submit" value="更新"/>  

  6. </form>   

  通过参数name="action" value="update"来指定要执行的功能方法名update。

 

(3.3、create页面(WEB-INF/jsp/user2/create.jsp)

Java代码  

  1. <form action="${pageContext.request.contextPath}/user2" method="post">  

  2. 用户名: <input type="text" name="username" value="${command.username}"/><br/>  

  3. 真实姓名:<input type="text" name="realname" value="${command.realname}"/><br/>  

  4. <input type="submit" name="create" value="新增"/>  

  5. </form>   

  通过参数name="create"来指定要执行的功能方法名create。

(4、测试:

使用ParameterMethodNameResolver将进行如下解析:

http://localhost:9080/springmvc-chapter4/user2?create      ————>create功能处理方法名(参数名映射);

http://localhost:9080/springmvc-chapter4/user2?action=create————>create功能处理方法名(参数值映射);

 

http://localhost:9080/springmvc-chapter4/user2?update      ————>update功能处理方法名;

http://localhost:9080/springmvc-chapter4/user2?action=update————>update功能处理方法名;

 

http://localhost:9080/springmvc-chapter4/user2?delete      ————>delete功能处理方法名;

http://localhost:9080/springmvc-chapter4/user2?action=delete————>delete功能处理方法名;

 

http://localhost:9080/springmvc-chapter4/user2?doList      ————>通过logicalMappings解析为list功能处理方法。

http://localhost:9080/springmvc-chapter4/user2?action=doList————>通过logicalMappings解析为list功能处理方法。

http://localhost:9080/springmvc-chapter4/user2————>默认的功能处理方法名list(默认)。

第四章 Controller接口控制器详解(6)

4.16、数据类型转换和数据验证

流程:

1、首先创建数据绑定器,在此此会创建ServletRequestDataBinder类的对象,并设置messageCodesResolver(错误码解析器);

2、提供第一个扩展点,初始化数据绑定器,在此处我们可以覆盖该方法注册自定义的PropertyEditor(请求参数——>命令对象属性的转换);

3、进行数据绑定,即请求参数——>命令对象的绑定;

4、提供第二个扩展点,数据绑定完成后的扩展点,此处可以实现一些自定义的绑定动作;

5、验证器对象的验证,验证器通过validators注入,如果验证失败,需要把错误信息放入Errors(此处使用BindException实现);

6、提供第三个扩展点,此处可以实现自定义的绑定/验证逻辑;

7、将errors传入功能处理方法进行处理,功能方法应该判断该错误对象是否有错误进行相应的处理。

 

4.16.1、数据类型转换

请求参数(String)——>命令对象属性(可能是任意类型)的类型转换,即数据绑定时的类型转换,使用PropertyEditor实现绑定时的类型转换。

 

一、Spring内建的PropertyEditor如下所示:

类名

说明

默认是否注册

ByteArrayPropertyEditor

String<——>byte[]

ClassEditor

String<——>Class

当类没有发现抛出IllegalArgumentException

CustomBooleanEditor

String<——>Boolean

true/yes/on/1转换为true,false/no/off/0转换为false

CustomCollectionEditor

数组/Collection——>Collection

普通值——>Collection(只包含一个对象)

如String——>Collection

不允许Collection——>String(单方向转换)

CustomNumberEditor

String<——>Number(Integer、Long、Double)

FileEditor

String<——>File

InputStreamEditor

String——>InputStream

单向的,不能InputStream——>String

LocaleEditor

String<——>Locale,

(String的形式为[语言]_[国家]_[变量],这与Local对象的toString()方法得到的结果相同)

PatternEditor

String<——>Pattern

PropertiesEditor

String<——>java.lang.Properties

URLEditor

String<——>URL

StringTrimmerEditor

一个用于trim 的 String类型的属性编辑器

如默认删除两边的空格,charsToDelete属性:可以设置为其他字符

emptyAsNull属性:将一个空字符串转化为null值的选项。

×

CustomDateEditor

String<——>java.util.Date

×

 

二、Spring内建的PropertyEditor支持的属性(符合JavaBean规范)操作:

表达式

设值/取值说明

username

属性username

设值方法setUsername()/取值方法getUsername() 或 isUsername()

schooInfo.schoolType

属性schooInfo的嵌套属性schoolType

设值方法getSchooInfo().setSchoolType()/取值方法getSchooInfo().getSchoolType()

hobbyList[0]

属性hobbyList的第一个元素

索引属性可能是一个数组、列表、其它天然有序的容器。

map[key]

属性map(java.util.Map类型)

map中key对应的值

 

三、示例:

接下来我们写自定义的属性编辑器进行数据绑定:

(1、模型对象:


java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.model;  

  2. //省略import  

  3. public class DataBinderTestModel {  

  4.     private String username;  

  5.     private boolean bool;//Boolean值测试  

  6.     private SchoolInfoModel schooInfo;  

  7.     private List hobbyList;//集合测试,此处可以改为数组/Set进行测试  

  8.     private Map map;//Map测试  

  9.     private PhoneNumberModel phoneNumber;//String->自定义对象的转换测试  

  10.     private Date date;//日期类型测试  

  11.     private UserState state;//String——>Enum类型转换测试  

  12.     //省略getter/setter  

  13. }  

  14.   

  15. package cn.javass.chapter4.model;  

  16. //如格式010-12345678  

  17. public class PhoneNumberModel {  

  18.     private String areaCode;//区号  

  19.     private String phoneNumber;//电话号码  

  20.     //省略getter/setter  

  21. }  

(2、PhoneNumber属性编辑器

前台输入如010-12345678自动转换为PhoneNumberModel。

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller.support.editor;  

  2. //省略import  

  3. public class PhoneNumberEditor extends PropertyEditorSupport {  

  4.     Pattern pattern = Pattern.compile("^(\\d{3,4})-(\\d{7,8})$");  

  5.     @Override  

  6.     public void setAsText(String text) throws IllegalArgumentException {  

  7.         if(text == null || !StringUtils.hasLength(text)) {  

  8.             setValue(null); //如果没值,设值为null  

  9.         }  

  10.         Matcher matcher = pattern.matcher(text);  

  11.         if(matcher.matches()) {  

  12.             PhoneNumberModel phoneNumber = new PhoneNumberModel();  

  13.             phoneNumber.setAreaCode(matcher.group(1));  

  14.             phoneNumber.setPhoneNumber(matcher.group(2));  

  15.             setValue(phoneNumber);  

  16.         } else {  

  17.             throw new IllegalArgumentException(String.format("类型转换失败,需要格式[010-12345678],但格式是[%s]", text));  

  18.         }  

  19.     }  

  20.     @Override  

  21.     public String getAsText() {  

  22.         PhoneNumberModel phoneNumber = ((PhoneNumberModel)getValue());  

  23.         return phoneNumber == null ? "" : phoneNumber.getAreaCode() + "-" + phoneNumber.getPhoneNumber();  

  24.     }  

  25. }  

PropertyEditorSupport:一个PropertyEditor的支持类;

setAsText:表示将String——>PhoneNumberModel,根据正则表达式进行转换,如果转换失败抛出异常,则接下来的验证器会进行验证处理;

getAsText:表示将PhoneNumberModel——>String。

 

(3、控制器

需要在控制器注册我们自定义的属性编辑器。

此处我们使用AbstractCommandController,因为它继承了BaseCommandController,拥有绑定流程。

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class DataBinderTestController extends AbstractCommandController {  

  4.     public DataBinderTestController() {  

  5.         setCommandClass(DataBinderTestModel.class); //设置命令对象  

  6.         setCommandName("dataBinderTest");//设置命令对象的名字  

  7.     }  

  8.     @Override  

  9.     protected ModelAndView handle(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {  

  10.         //输出command对象看看是否绑定正确  

  11.         System.out.println(command);  

  12.         return new ModelAndView("bindAndValidate/success").addObject("dataBinderTest", command);  

  13.     }  

  14.     @Override  

  15.     protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception {  

  16.         super.initBinder(request, binder);  

  17.         //注册自定义的属性编辑器  

  18.         //1、日期  

  19.         DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  

  20.         CustomDateEditor dateEditor = new CustomDateEditor(df, true);  

  21.         //表示如果命令对象有Date类型的属性,将使用该属性编辑器进行类型转换  

  22.         binder.registerCustomEditor(Date.class, dateEditor);  

  23.         //自定义的电话号码编辑器  

  24.         binder.registerCustomEditor(PhoneNumberModel.classnew PhoneNumberEditor());  

  25.     }  

  26. }  

initBinder:第一个扩展点,初始化数据绑定器,在此处我们注册了两个属性编辑器;

CustomDateEditor:自定义的日期编辑器,用于在String<——>日期之间转换;

    binder.registerCustomEditor(Date.class, dateEditor):表示如果命令对象是Date类型,则使用dateEditor进行类型转换;

PhoneNumberEditor:自定义的电话号码属性编辑器用于在String<——> PhoneNumberModel之间转换;

    binder.registerCustomEditor(PhoneNumberModel.classnew PhoneNumberEditor()):表示如果命令对象是PhoneNumberModel类型,则使用PhoneNumberEditor进行类型转换;

(4、spring配置文件chapter4-servlet.xml


java代码:

查看复制到剪贴板打印

  1. <bean name="/dataBind"   

  2. class="cn.javass.chapter4.web.controller.DataBinderTestController"/>  

(5、视图页面(WEB-INF/jsp/bindAndValidate/success.jsp)


java代码:

查看复制到剪贴板打印

  1. EL phoneNumber:${dataBinderTest.phoneNumber}<br/>  

  2. EL state:${dataBinderTest.state}<br/>  

  3. EL date:${dataBinderTest.date}<br/>  

视图页面的数据没有预期被格式化,如何进行格式化显示呢?请参考【第七章  注解式控制器的数据验证、类型转换及格式化】。

 

(6、测试:

1、在浏览器地址栏输入请求的URL,如

http://localhost:9080/springmvc-chapter4/dataBind?username=zhang&bool=yes&schooInfo.specialty=computer&hobbyList[0]=program&hobbyList[1]=music&map[key1]=value1&map[key2]=value2&phoneNumber=010-12345678&date=2012-3-18 16:48:48&state=blocked

 

2、控制器输出的内容:

DataBinderTestModel [username=zhang, bool=true, schooInfo=SchoolInfoModel [schoolType=null, schoolName=null, specialty=computer], hobbyList=[program, music], map={key1=value1, key2=value2}, phoneNumber=PhoneNumberModel [areaCode=010, phoneNumber=12345678], date=Sun Mar 18 16:48:48 CST 2012, state=锁定]

 

类型转换如图所示:

 

四、注册PropertyEditor

1、使用WebDataBinder进行控制器级别注册PropertyEditor(控制器独享)

如“【三、示例】”中所使用的方式,使用WebDataBinder注册控制器级别的PropertyEditor,这种方式注册的PropertyEditor只对当前控制器独享,即其他的控制器不会自动注册这个PropertyEditor,如果需要还需要再注册一下。

 

2、使用WebBindingInitializer批量注册PropertyEditor

如果想在多个控制器同时注册多个相同的PropertyEditor时,可以考虑使用WebBindingInitializer。

 

示例:

(1、实现WebBindingInitializer


java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller.support.initializer;  

  2. //省略import  

  3. public class MyWebBindingInitializer implements WebBindingInitializer {  

  4.     @Override  

  5.     public void initBinder(WebDataBinder binder, WebRequest request) {  

  6.         //注册自定义的属性编辑器  

  7.         //1、日期  

  8.         DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  

  9.         CustomDateEditor dateEditor = new CustomDateEditor(df, true);  

  10.         //表示如果命令对象有Date类型的属性,将使用该属性编辑器进行类型转换  

  11.         binder.registerCustomEditor(Date.class, dateEditor);  

  12.         //自定义的电话号码编辑器  

  13.         binder.registerCustomEditor(PhoneNumberModel.classnew PhoneNumberEditor());  

  14.     }  

  15. }  

通过实现WebBindingInitializer并通过binder注册多个PropertyEditor。

 

(2、修改【三、示例】中的DataBinderTestController,注释掉initBinder方法;

 

(3、修改chapter4-servlet.xml配置文件:

 

java代码:

查看复制到剪贴板打印

  1. <!-- 注册WebBindingInitializer实现 -->  

  2. <bean id="myWebBindingInitializer" class="cn.javass.chapter4.web.controller.support.initializer.MyWebBindingInitializer"/>  

  3. <bean name="/dataBind" class="cn.javass.chapter4.web.controller.DataBinderTestController">  

  4.     <!-- 注入WebBindingInitializer实现 -->  

  5.     <property name="webBindingInitializer" ref="myWebBindingInitializer"/>  

  6. </bean>  

(4、尝试访问“【三、示例】”中的测试URL即可成功。

 

使用WebBindingInitializer的好处是当你需要在多个控制器中需要同时使用多个相同的PropertyEditor可以在WebBindingInitializer实现中注册,这样只需要在控制器中注入WebBindingInitializer即可注入多个PropertyEditor。

 

3、全局级别注册PropertyEditor(全局共享)

只需要将我们自定义的PropertyEditor放在和你的模型类同包下即可,且你的Editor命名规则必须是“模型类名Editor”,这样Spring会自动使用标准JavaBean架构进行自动识别,如图所示:

此时我们把“DataBinderTestController”的“binder.registerCustomEditor(PhoneNumberModel.class, new PhoneNumberEditor());”注释掉,再尝试访问“【三、示例】”中的测试URL即可成功。

 

这种方式不仅仅在使用Spring时可用,在标准的JavaBean等环境都是可用的,可以认为是全局共享的(不仅仅是Spring环境)。

 

PropertyEditor被限制为只能String<——>Object之间转换,不能Object<——>Object,Spring3提供了更强大的类型转换(Type Conversion)支持,它可以在任意对象之间进行类型转换,不仅仅是String<——>Object。

 

如果我在地址栏输入错误的数据,即数据绑定失败,Spring Web MVC该如何处理呢?如果我输入的数据不合法呢?如用户名输入100个字符(超长了)那又该怎么处理呢?出错了需要错误消息,那错误消息应该是硬编码?还是可配置呢?

 

接下来我们来学习一下数据验证器进行数据验证吧。

第四章 Controller接口控制器详解(7)

4.16.2、数据验证

1、数据绑定失败:比如需要数字却输入了字母;

2、数据不合法:可以认为是业务错误,通过自定义验证器验证,如用户名长度必须在5-20之间,我们却输入了100个字符等;

3、错误对象:当我们数据绑定失败或验证失败后,错误信息存放的对象,我们叫错误对象,在Spring Web MVC中Errors是具体的代表者;线程不安全对象;

4、错误消息:是硬编码,还是可配置?实际工作应该使用配置方式,我们只是把错误码(errorCode)放入错误对象,在展示时读取相应的错误消息配置文件来获取要显示的错误消息(errorMessage);

 

4.16.2.1、验证流程

 

1、首先进行数据绑定验证,如果验证失败会通过MessageCodesResolver生成错误码放入Errors错误对象;

2、数据不合法验证,通过自定义的验证器验证,如果失败需要手动将错误码放入Errors错误对象;

4.16.2.2、错误对象和错误消息

错误对象的代表者是Errors接口,并且提供了几个实现者,在Spring Web MVC中我们使用的是如下实现:

 

相关的错误方法如下:

Errors:存储和暴露关于数据绑定错误和验证错误相关信息的接口,提供了相关存储和获取错误消息的方法:

 

java代码:

查看复制到剪贴板打印

  1. package org.springframework.validation;  

  2. public interface Errors {  

  3.   //=========================全局错误消息(验证/绑定对象全局的)=============================  

  4.   //注册一个全局的错误码()  

  5.   void reject(String errorCode);  

  6.   //注册一个全局的错误码,当根据errorCode没有找到相应错误消息时,使用defaultMessage作为错误消息  

  7.   void reject(String errorCode, String defaultMessage);  

  8.   //注册一个全局的错误码,当根据errorCode没有找到相应错误消息时(带错误参数的),使用defaultMessage作为错误消息  

  9.   void reject(String errorCode, Object[] errorArgs, String defaultMessage);  

  10.   //=========================全局错误消息(验证/绑定整个对象的)=============================  

  11.   //=========================局部错误消息(验证/绑定对象字段的)=============================  

  12.   //注册一个对象字段的错误码,field指定验证失败的字段名  

  13.   void rejectValue(String field, String errorCode);  

  14.   void rejectValue(String field, String errorCode, String defaultMessage);  

  15.   void rejectValue(String field, String errorCode, Object[] errorArgs, String defaultMessage);  

  16.   //=========================局部错误消息(验证/绑定对象字段的)=============================  

  17.   boolean hasErrors();      ////是否有错误  

  18.   boolean hasGlobalErrors(); //是否有全局错误  

  19.   boolean hasFieldErrors();  //是否有字段错误  

  20.   Object getFieldValue(String field); //返回当前验证通过的值,或验证失败时失败的值;  

  21. }  

 

getFieldValue:可以得到验证失败的失败值,这是其他Web层框架很少支持的,这样就可以给用户展示出错时的值(而不是空或其他的默认值等)。

 

BindingResult:代表数据绑定的结果,继承了Errors接口。

BindException:代表数据绑定的异常,它继承Exception,并实现了BindingResult,这是内部使用的错误对象。

 

示例:

(1、控制器

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class ErrorController extends AbstractCommandController {  

  4.        public ErrorController() {  

  5.               setCommandClass(DataBinderTestModel.class);  

  6.               setCommandName("command");  

  7.        }  

  8.        @Override  

  9.        protected ModelAndView handle(HttpServletRequest req, HttpServletResponse resp, Object command, BindException errors) throws Exception {     

  10.               //表示用户名不为空  

  11.               errors.reject("username.not.empty");  

  12.               //带有默认错误消息  

  13.               errors.reject("username.not.empty1""用户名不能为空1");  

  14.               //带有参数和默认错误消息          

  15.               errors.reject("username.length.error"new Object[]{510});  

  16.                

  17.               //得到错误相关的模型数据  

  18.               Map model = errors.getModel();  

  19.               return new ModelAndView("bindAndValidate/error", model);  

  20.        }  

  21. }  

 

errors.reject("username.not.empty"):注册全局错误码“username.not.empty”,我们必须提供messageSource来提供错误码“username.not.empty”对应的错误信息(如果没有会抛出NoSuchMessageException异常);

 

errors.reject("username.not.empty1", "用户名不能为空1"):注册全局错误码“username.not.empty1”,如果从messageSource没没有找到错误码“username.not.empty1”对应的错误信息,则将显示默认消息“用户名不能为空1”;

 

errors.reject("username.length.error", new Object[]{5, 10}):错误码为“username.length.error”,而且错误信息需要两个参数,如我们在我们的配置文件中定义“用户名长度不合法,长度必须在{0}到{1}之间”,则实际的错误消息为“用户名长度不合法,长度必须在5到10之间”

errors.getModel():当有错误信息时,一定将errors.getModel()放入我们要返回的ModelAndView中,以便使用里边的错误对象来显示错误信息。

 

(2、spring配置文件chapter4-servlet.xml

 

java代码:

查看复制到剪贴板打印

  1. <bean id="messageSource"  

  2.        class="org.springframework.context.support.ReloadableResourceBundleMessageSource">  

  3.     <property name="basename" value="classpath:messages"/>  

  4.     <property name="fileEncodings" value="utf-8"/>  

  5.     <property name="cacheSeconds" value="120"/>  

  6. </bean>  

  7.    

  8. <bean name="/error" class="cn.javass.chapter4.web.controller.ErrorController"/>  

 

messageSource:用于获取错误码对应的错误消息的,而且bean名字默认必须是messageSource。

 

messages.properties(需要执行NativeToAscii)

 

java代码:

查看复制到剪贴板打印

  1. username.not.empty=用户名不能为空  

  2. username.length.error=用户名长度不合法,长度必须在{0}到{1}之间  

 

(3、视图页面(WEB-INF/jsp/bindAndValidate/error.jsp)

 

java代码:

查看复制到剪贴板打印

  1. <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %>  

  2. <!-- 表单的默认命令对象名为command -->  

  3. <form:form commandName="command">  

  4.     <form:errors path="*"></form:errors>  

  5. </form:form>  

 

form标签库:此处我们使用了spring的form标签库;

<form:form commandName="command">:表示我们的表单标签,commandName表示绑定的命令对象名字,默认为command;

<form:errors path="*"></form:errors>:表示显示错误信息的标签,如果path为“*”表示显示所有错误信息。

 

接下来我们来看一下 数据绑定失败和数据不合法时,如何处理。

4.16.2.3、数据绑定失败

如我们的DataBinderTestModel类:

bool:boolean类型,此时如果我们前台传入非兼容的数据,则会数据绑定失败;

date:Date类型,此时如果我们前台传入非兼容的数据,同样会数据绑定失败;

phoneNumber:自定义的PhoneNumberModel类型,如果如果我们前台传入非兼容的数据,同样会数据绑定失败。

 

示例:

(1、控制器,DataBinderErrorTestController。

 

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller;  

  2. //省略import  

  3. public class DataBinderErrorTestController extends SimpleFormController {  

  4.        public DataBinderErrorTestController() {  

  5.               setCommandClass(DataBinderTestModel.class);  

  6.               setCommandName("dataBinderTest");  

  7.        }  

  8.        @Override  

  9.        protected ModelAndView showForm(HttpServletRequest request, HttpServletResponse response, BindException errors) throws Exception {  

  10.               //如果表单提交有任何错误都会再回到表单展示页面  

  11.               System.out.println(errors);  

  12.               return super.showForm(request, response, errors);  

  13.        }  

  14.        @Override  

  15.        protected void doSubmitAction(Object command) throws Exception {  

  16.               System.out.println(command); //表单提交成功(数据绑定成功)进行功能处理  

  17.     }  

  18.        @Override  

  19.        protected void initBinder(HttpServletRequest request, ServletRequestDataBinder binder) throws Exception {  

  20.               super.initBinder(request, binder);  

  21.               //注册自定义的属性编辑器  

  22.               //1、日期  

  23.               DateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  

  24.               CustomDateEditor dateEditor = new CustomDateEditor(df, true);  

  25.               //表示如果命令对象有Date类型的属性,将使用该属性编辑器进行类型转换  

  26.               binder.registerCustomEditor(Date.class, dateEditor);  

  27.                

  28.               //自定义的电话号码编辑器  

  29.               binder.registerCustomEditor(PhoneNumberModel.classnew PhoneNumberEditor());  

  30.        }  

  31. }  

此处我们使用SimpleFormController;

showForm:展示表单,当提交表单有任何数据绑定错误会再回到该方法进行表单输入(在此处我们打印错误对象);

doSubmitAction:表单提交成功,只要当表单的数据到命令对象绑定成功时,才会执行;

 

(2、spring配置文件chapter4-servlet.xml

 

java代码:

查看复制到剪贴板打印

  1. <bean name="/dataBindError"  

  2. class="cn.javass.chapter4.web.controller.DataBinderErrorTestController">  

  3.    <property name="formView" value="bindAndValidate/input"/>  

  4.    <property name="successView" value="bindAndValidate/success"/>  

  5. </bean>  

 

(3、视图页面(WEB-INF/jsp/bindAndValidate/ input.jsp)

 

java代码:

查看复制到剪贴板打印

  1. <%@ page language="java" contentType="text/html; charset=UTF-8"   pageEncoding="UTF-8"%>  

  2. <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %>  

  3. <!-- 表单的命令对象名为dataBinderTest -->  

  4. <form:form commandName="dataBinderTest">  

  5.     <form:errors path="*" cssStyle="color:red"></form:errors><br/><br/>  

  6.     bool:<form:input path="bool"/><br/>  

  7.     phoneNumber:<form:input path="phoneNumber"/><br/>  

  8.     date:<form:input path="date"/><br/>  

  9.     <input type="submit" value="提交"/>  

  10. </form:form>  

 

此处一定要使用form标签库,借此我们可以看到它的强大支持(别的大部分Web框架所不具备的,展示用户验证失败的数据)。

 

<form:form commandName="dataBinderTest">:指定命令对象为dataBinderTest,默认command;

<form:errors path="*" cssStyle="color:red"></form:errors>:显示错误消息,当提交表单有错误时展示错误消息(数据绑定错误/数据不合法);

<form:input path="bool"/>:等价于(<input type=’text’>),但会从命令对象中取出bool属性进行填充value属性,或如果表单提交有错误会从错误对象取出之前的错误数据(而非空或默认值);

<input type="submit" value="提交"/>:spring没有提供相应的提交按钮,因此需要使用html的。

 

(4、测试

在地址栏输入如下地址:http://localhost:9080/springmvc-chapter4/dataBindError

 

全部是错误数据,即不能绑定到我们的命令对象;

 

当提交表单后,我们又回到表单输入页面,而且输出了一堆错误信息

 

1、错误消息不可读;

2、表单元素可以显示之前的错误的数据,而不是默认值/空;

 

(5、问题

这里最大的问题是不可读的错误消息,如何让这些错误消息可读呢?

 

首先我们看我们的showForm方法里输出的“errors”错误对象信息:

 

java代码:

查看复制到剪贴板打印

  1. org.springframework.validation.BindException: org.springframework.validation.BeanPropertyBindingResult: 3 errors  

  2.    

  3. Field error in object 'dataBinderTest' on field 'bool': rejected value [www]; codes [typeMismatch.dataBinderTest.bool,typeMismatch.bool,typeMismatch.boolean,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [dataBinderTest.bool,bool]; arguments []; default message [bool]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'boolean' for property 'bool'; nested exception is java.lang.IllegalArgumentException: Invalid boolean value [www]]  

  4.    

  5. Field error in object 'dataBinderTest' on field 'date': rejected value [123]; codes [typeMismatch.dataBinderTest.date,typeMismatch.date,typeMismatch.java.util.Date,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [dataBinderTest.date,date]; arguments []; default message [date]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'java.util.Date' for property 'date'; nested exception is java.lang.IllegalArgumentException: Could not parse date: Unparseable date: "123"]  

  6.    

  7. Field error in object 'dataBinderTest' on field 'phoneNumber': rejected value [123]; codes [typeMismatch.dataBinderTest.phoneNumber,typeMismatch.phoneNumber,typeMismatch.cn.javass.chapter4.model.PhoneNumberModel,typeMismatch]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [dataBinderTest.phoneNumber,phoneNumber]; arguments []; default message [phoneNumber]]; default message [Failed to convert property value of type 'java.lang.String' to required type 'cn.javass.chapter4.model.PhoneNumberModel' for property 'phoneNumber'; nested exception is java.lang.IllegalArgumentException: 类型转换失败,需要格式[010-12345678],但格式是[123]]  

  8.    

数据绑定失败(类型不匹配)会自动生成如下错误码(错误码对应的错误消息按照如下顺序依次查找):

1、typeMismatch.命令对象名.属性名

2、typeMismatch.属性名

3、typeMismatch.属性全限定类名(包名.类名)

4、typeMismatch

 

⊙内部使用MessageCodesResolver解析数据绑定错误到错误码,默认DefaultMessageCodesResolver,因此想要详细了解如何解析请看其javadoc;

 

⊙建议使用第1个进行错误码的配置。

 

因此修改我们的messages.properties添加如下错误消息(需要执行NativeToAscii):

 

java代码:

查看复制到剪贴板打印

  1. typeMismatch.dataBinderTest.date=您输入的数据格式错误,请重新输入(格式:2012-03-19 22:17:17)  

  2. #typeMismatch.date=2  

  3. #typeMismatch.java.util.Date=3  

  4. #typeMismatch=4  

 

再次提交表单我们会看到我们设置的错误消息:

 

到此,数据绑定错误我们介绍完了,接下来我们再看一下数据不合法错误。

4.16.2.4、数据不合法

1、比如用户名长度必须在5-20之间,而且必须以字母开头,可包含字母、数字、下划线;

2、比如注册用户时 用户名已经存在或邮箱已经存在等;

3、比如去一些论坛经常会发现,您发的帖子中包含×××屏蔽关键字等。

 

还有很多数据不合法的场景,在此就不罗列了,对于数据不合法,Spring Web MVC提供了两种验证方式:

◆编程式验证器验证

◆声明式验证

 

先从编程式验证器开始吧。

4.16.2.4.1、编程式验证器

一、验证器接口

 

java代码:

查看复制到剪贴板打印

  1. package org.springframework.validation;  

  2. public interface Validator {  

  3. boolean supports(Class<?> clazz);  

  4. void validate(Object target, Errors errors);  

  5. }  

 

Validator接口:验证器,编程实现数据验证的接口;

supports方法:当前验证器是否支持指定的clazz验证,如果支持返回true即可;

validate方法:验证的具体方法,target参数表示要验证的目标对象(如命令对象),errors表示验证出错后存放错误信息的错误对象。

 

示例:

(1、验证器实现

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter4.web.controller.support.validator;  

  2. //省略import  

  3. public class UserModelValidator implements Validator {  

  4.     private static final Pattern USERNAME_PATTERN = Pattern.compile("[a-zA-Z]\\w{4,19}");  

  5.     private static final Pattern PASSWORD_PATTERN = Pattern.compile("[a-zA-Z0-9]{5,20}");  

  6.     private static final Set<String> FORBINDDDEN_WORD_SET = new HashSet<String>();  

  7.     static {  

  8.        FORBINDDDEN_WORD_SET.add("fuc k"); //删掉空格  

  9.        FORBINDDDEN_WORD_SET.add("admin");  

  10.     }    

  11.     @Override  

  12.     public boolean supports(Class<?> clazz) {  

  13.        return UserModel.class == clazz;//表示只对UserModel类型的目标对象实施验证  

  14.     }  

  15.     @Override  

  16.     public void validate(Object target, Errors errors) {  

  17.        //这个表示如果目标对象的username属性为空,则表示错误(简化我们手工判断是否为空)  

  18.        ValidationUtils.rejectIfEmpty(errors, "username""username.not.empty");  

  19.         

  20.        UserModel user = (UserModel) target;  

  21.         

  22.        if(!USERNAME_PATTERN.matcher(user.getUsername()).matches()) {  

  23.            errors.rejectValue("username""username.not.illegal");//如果用户名不合法  

  24.        }  

  25.         

  26.        for(String forbiddenWord : FORBINDDDEN_WORD_SET) {  

  27.            if(user.getUsername().contains(forbiddenWord)) {  

  28.               errors.rejectValue("username""username.forbidden"new Object[]{forbiddenWord}, "您的用户名包含非法关键词");//用户名包含屏蔽关键字  

  29.               break;  

  30.            }  

  31.        }  

  32.        if(!PASSWORD_PATTERN.matcher(user.getPassword()).matches()) {  

  33.            errors.rejectValue("password","password.not.illegal""密码不合法");//密码不合法  

  34.        }    

  35.     }  

  36. }  

  37.    

supports方法:表示只对UserModel类型的对象验证;

validate方法:数据验证的具体方法,有如下几个验证:

    1、用户名不合法(长度5-20,以字母开头,随后可以是字母、数字、下划线)

    USERNAME_PATTERN.matcher(user.getUsername()).matches() //使用正则表达式验证

    errors.rejectValue("username", "username.not.illegal");//验证失败为username字段添加错误码

 

 

    2、屏蔽关键词:即用户名中含有不合法的数据(如admin)

    user.getUsername().contains(forbiddenWord) //用contains来判断我们的用户名中是否含有非法关键词

    errors.rejectValue("username", "username.forbidden", new Object[]{forbiddenWord}, "您的用户名包含非法关键词");//验证失败为username字段添加错误码(参数为当前屏蔽关键词)(默认消息为"您的用户名包含非法关键词")

 

    3、密码不合法

    在此就不罗列代码了;

    4、ValidationUtils

    ValidationUtils.rejectIfEmpty(errors, "username", "username.not.empty");

    表示如果目标对象的username属性数据为空,则添加它的错误码;

    内部通过(value == null || !StringUtils.hasLength(value.toString()))实现判断value是否为空,从而简化代码。

 

(2、spring配置文件chapter4-servlet.xml

 

java代码:

查看复制到剪贴板打印

  1. <bean id="userModelValidator"  

  2. class="cn.javass.chapter4.web.controller.support.validator.UserModelValidator"/>  

  3. <bean name="/validator"  

  4. class="cn.javass.chapter4.web.controller.RegisterSimpleFormController">  

  5.     <property name="formView" value="registerAndValidator"/>  

  6.     <property name="successView" value="redirect:/success"/>  

  7.     <property name="validator" ref="userModelValidator"/>  

  8. </bean>  

 

此处使用了我们第4.9节创建的RegisterSimpleFormController。

 

(3、错误码配置(messages.properties),需要执行NativeToAscii

 

java代码:

查看复制到剪贴板打印

  1. username.not.empty=用户名不能为空  

  2. username.not.illegal=用户名错误,必须以字母开头,只能出现字母、数字、下划线,并且长度在5-20之间  

  3. username.forbidden=用户名中包含非法关键词【{0}】  

  4. password.not.illegal=密码长度必须在5-20之间  

 

(4、视图页面(/WEB-INF/jsp/registerAndValidator.jsp)

 

java代码:

查看复制到剪贴板打印

  1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  

  2. <%@taglib prefix="form" uri="http://www.springframework.org/tags/form" %>  

  3. <form:form commandName="user">  

  4.    

  5. <form:errors path="*" cssStyle="color:red"></form:errors><br/>  

  6.    

  7. username:<form:input path="username"/>  

  8. <form:errors path="username" cssStyle="color:red"></form:errors>  

  9. <br/>  

  10.    

  11. password:<form:password path="password"/>  

  12. <form:errors path="password" cssStyle="color:red"></form:errors>  

  13. <br/>  

  14. <input type="submit" value="注册"/>  

  15. </form:form>  

  16.    

 

form:errors path="username":表示只显示username字段的错误信息;

 

(5、测试

地址:http://localhost:9080/springmvc-chapter4/validator

 

当我们输入错误的数据后,会报错(form:errors path="*"显示所有错误信息,而form:errors path="username"只显示该字段相关的)。

 

 

问题:

如MultiActionController控制器相关方法没有提供给我们errors对象(Errors),我们应该怎么进行错误处理呢?

 

此处给大家一个思路,errors本质就是一个Errors接口实现,而且在页面要读取相关的错误对象,该错误对象应该存放在模型对象里边,因此我们可以自己创建个errors对象并将其添加到模型对象中即可。

 

此处我们复制4.15节的UserController类为UserAndValidatorController,并修改它的create(新增)方法添加如下代码片段:

 

java代码:

查看复制到剪贴板打印

  1. BindException errors = new BindException(user, getCommandName(user));  

  2. //如果用户名为空  

  3. if(!StringUtils.hasLength(user.getUsername())) {  

  4.     errors.rejectValue("username""username.not.empty");  

  5. }  

  6. if(errors.hasErrors()) {  

  7.     return new ModelAndView(getCreateView()).addAllObjects(errors.getModel());  

  8. }  

  9.         

 

√ new BindException(user, getCommandName(user)):使用当前的命令对象,和命令对象的名字创建了一个BindException作为errors;

√StringUtils.hasLength(user.getUsername()):如果用户名为空就是用errors.rejectValue("username", "username.not.empty");注入错误码;

√errors.hasErrors():表示如果有错误就返回到新增页面并显示错误消息;

√ModelAndView(getCreateView()).addAllObjects(errors.getModel()):此处一定把errors对象的模型数据放在当前的ModelAndView中,作为当前请求的模型数据返回。

 

在浏览器地址栏输入:http://localhost:9080/springmvc-chapter4/userAndValidator/create 到新增页面

 

用户名什么都不输入,提交后又返回到新增页面 而且显示了错误消息说明我们的想法是正确的。

 

4.16.2.4.2、声明式验证器

从Spring3开始支持JSR-303验证框架,支持XML风格和注解风格的验证,目前在@RequestMapping时才能使用,也就是说基于Controller接口的实现不能使用该方式(但可以使用编程式验证,有需要的可以参考hibernate validator实现),我们将在第七章详细介绍。

 

 

到此Spring2风格的控制器我们就介绍完了,以上控制器从spring3.0开始已经不推荐使用了(但考虑到还有部分公司使用这些@Deprecated类,在此也介绍了一下),而是使用注解控制器实现(@Controller和@RequestMapping)。

第五章 处理器拦截器详解

5.1、处理器拦截器简介

Spring Web MVC的处理器拦截器(如无特殊说明,下文所说的拦截器即处理器拦截器)类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。

 

5.1.1、常见应用场景

1、日志记录:记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等。

2、权限检查:如登录检测,进入处理器检测检测是否登录,如果没有直接返回到登录页面;

3、性能监控:有时候系统在某段时间莫名其妙的慢,可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间(如果有反向代理,如apache可以自动记录);

4、通用行为:读取cookie得到用户信息并将用户对象放入请求,从而方便后续流程使用,还有如提取Locale、Theme信息等,只要是多个处理器都需要的即可使用拦截器实现。

5、OpenSessionInView:如Hibernate,在进入处理器打开Session,在完成后关闭Session。

…………本质也是AOP(面向切面编程),也就是说符合横切关注点的所有功能都可以放入拦截器实现。

5.1.2、拦截器接口

 

java代码:

查看复制到剪贴板打印

  1. package org.springframework.web.servlet;  

  2. public interface HandlerInterceptor {  

  3.     boolean preHandle(  

  4.             HttpServletRequest request, HttpServletResponse response,   

  5.             Object handler)   

  6.             throws Exception;  

  7.   

  8.     void postHandle(  

  9.             HttpServletRequest request, HttpServletResponse response,   

  10.             Object handler, ModelAndView modelAndView)   

  11.             throws Exception;  

  12.   

  13.     void afterCompletion(  

  14.             HttpServletRequest request, HttpServletResponse response,   

  15.             Object handler, Exception ex)  

  16.             throws Exception;  

  17. }   

我们可能注意到拦截器一个有3个回调方法,而一般的过滤器Filter才两个,这是怎么回事呢?马上分析。

 

preHandle:预处理回调方法,实现处理器的预处理(如登录检查),第三个参数为响应的处理器(如我们上一章的Controller实现);

     返回值:true表示继续流程(如调用下一个拦截器或处理器);

             false表示流程中断(如登录检查失败),不会继续调用其他的拦截器或处理器,此时我们需要通过response来产生响应;

postHandle:后处理回调方法,实现处理器的后处理(但在渲染视图之前),此时我们可以通过modelAndView(模型和视图对象)对模型数据进行处理或对视图进行处理,modelAndView也可能为null。

afterCompletion:整个请求处理完毕回调方法,即在视图渲染完毕时回调,如性能监控中我们可以在此记录结束时间并输出消耗时间,还可以进行一些资源清理,类似于try-catch-finally中的finally,但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion

 

5.1.3、拦截器适配器

有时候我们可能只需要实现三个回调方法中的某一个,如果实现HandlerInterceptor接口的话,三个方法必须实现,不管你需不需要,此时spring提供了一个HandlerInterceptorAdapter适配器(一种适配器设计模式的实现),允许我们只实现需要的回调方法。

 

java代码:

查看复制到剪贴板打印

  1. public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {  

  2.      //省略代码 此处所以三个回调方法都是空实现,preHandle返回true。  

  3. }  

5.1.4、运行流程图

 

图5-1 正常流程

 

 

图5-2 中断流程

中断流程中,比如是HandlerInterceptor2中断的流程(preHandle返回false),此处仅调用它之前拦截器的preHandle返回true的afterCompletion方法。

 

接下来看一下DispatcherServlet内部到底是如何工作的吧:


java代码:

查看复制到剪贴板打印

  1. //doDispatch方法  

  2. //1、处理器拦截器的预处理(正序执行)  

  3. HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  

  4. if (interceptors != null) {  

  5.     for (int i = 0; i < interceptors.length; i++) {  

  6.     HandlerInterceptor interceptor = interceptors[i];  

  7.         if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {  

  8.             //1.1、失败时触发afterCompletion的调用  

  9.             triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);  

  10.             return;  

  11.         }  

  12.         interceptorIndex = i;//1.2、记录当前预处理成功的索引  

  13. }  

  14. }  

  15. //2、处理器适配器调用我们的处理器  

  16. mv = ha.handle(processedRequest, response, mappedHandler.getHandler());  

  17. //当我们返回null或没有返回逻辑视图名时的默认视图名翻译(详解4.15.5 RequestToViewNameTranslator)  

  18. if (mv != null && !mv.hasView()) {  

  19.     mv.setViewName(getDefaultViewName(request));  

  20. }  

  21. //3、处理器拦截器的后处理(逆序)  

  22. if (interceptors != null) {  

  23. for (int i = interceptors.length - 1; i >= 0; i--) {  

  24.       HandlerInterceptor interceptor = interceptors[i];  

  25.       interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);  

  26. }  

  27. }  

  28. //4、视图的渲染  

  29. if (mv != null && !mv.wasCleared()) {  

  30. render(mv, processedRequest, response);  

  31.     if (errorView) {  

  32.         WebUtils.clearErrorRequestAttributes(request);  

  33. }  

  34. //5、触发整个请求处理完毕回调方法afterCompletion  

  35. triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);  

注:以上是流程的简化代码,中间省略了部分代码,不完整。

 

java代码:

查看复制到剪贴板打印

  1. // triggerAfterCompletion方法  

  2. private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,  

  3.             HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {  

  4.         // 5、触发整个请求处理完毕回调方法afterCompletion (逆序从1.2中的预处理成功的索引处的拦截器执行)  

  5.         if (mappedHandler != null) {  

  6.             HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  

  7.             if (interceptors != null) {  

  8.                 for (int i = interceptorIndex; i >= 0; i--) {  

  9.                     HandlerInterceptor interceptor = interceptors[i];  

  10.                     try {  

  11.                         interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex);  

  12.                     }  

  13.                     catch (Throwable ex2) {  

  14.                         logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);  

  15.                     }  

  16.                 }  

  17.             }  

  18.         }  

  19.     }  

 

5.2、入门

具体内容详见工程springmvc-chapter5。

5.2.1、正常流程

(1、拦截器实现

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter5.web.interceptor;  

  2. //省略import  

  3. public class HandlerInterceptor1 extends HandlerInterceptorAdapter {//此处一般继承HandlerInterceptorAdapter适配器即可  

  4.     @Override  

  5.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  

  6.         System.out.println("===========HandlerInterceptor1 preHandle");  

  7.         return true;  

  8.     }  

  9.     @Override  

  10.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  

  11.         System.out.println("===========HandlerInterceptor1 postHandle");  

  12.     }  

  13.     @Override  

  14.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  

  15.         System.out.println("===========HandlerInterceptor1 afterCompletion");  

  16.     }  

  17. }  

 

以上是HandlerInterceptor1实现,HandlerInterceptor2同理 只是输出内容为“HandlerInterceptor2”。

(2、控制器

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter5.web.controller;  

  2. //省略import  

  3. public class TestController implements Controller {  

  4.     @Override  

  5.     public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception {  

  6.         System.out.println("===========TestController");  

  7.         return new ModelAndView("test");  

  8.     }  

  9. }  

 

(3、Spring配置文件chapter5-servlet.xml

 

java代码:

查看复制到剪贴板打印

  1. <bean name="/test" class="cn.javass.chapter5.web.controller.TestController"/>  

  2. <bean id="handlerInterceptor1"   

  3. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor1"/>  

  4. <bean id="handlerInterceptor2"   

  5. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor2"/>  

  6.    

 

java代码:

查看复制到剪贴板打印

  1. <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">  

  2.     <property name="interceptors">  

  3.         <list>  

  4.            <ref bean="handlerInterceptor1"/>  

  5.           <ref bean="handlerInterceptor2"/>  

  6.         </list>  

  7.     </property>  

  8. </bean>  

 

 

interceptors:指定拦截器链,拦截器的执行顺序就是此处添加拦截器的顺序;

 

(4、视图页面WEB-INF/jsp/test.jsp

 

java代码:

查看复制到剪贴板打印

  1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  

  2. <%System.out.println("==========test.jsp");%>  

  3. test page  

 

在控制台输出 test.jsp

 

(5、启动服务器测试

输入网址:http://localhost:9080/springmvc-chapter5/test

控制台输出:

 

java代码:

查看复制到剪贴板打印

  1. ===========HandlerInterceptor1 preHandle  

  2. ===========HandlerInterceptor2 preHandle  

  3. ===========TestController  

  4. ===========HandlerInterceptor2 postHandle  

  5. ===========HandlerInterceptor1 postHandle  

  6. ==========test.jsp  

  7. ===========HandlerInterceptor2 afterCompletion  

  8. ===========HandlerInterceptor1 afterCompletion  

 

到此一个正常流程的演示完毕。和图5-1一样,接下来看一下中断的流程。

5.2.2、中断流程

(1、拦截器

HandlerInterceptor3和HandlerInterceptor4 与 之前的 HandlerInteceptor1和HandlerInterceptor2一样,只是在HandlerInterceptor4的preHandle方法返回false:

 

java代码:

查看复制到剪贴板打印

  1. @Override  

  2. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  

  3.     System.out.println("===========HandlerInterceptor1 preHandle");  

  4. onse.getWriter().print("break");//流程中断的话需要我们进行响应的处理  

  5.     return false;//返回false表示流程中断      

 

(2、控制器

流程中断不会执行到控制器,使用之前的TestController控制器。

(3、Spring配置文件chapter5-servlet.xml

 

java代码:

查看复制到剪贴板打印

  1. <bean id="handlerInterceptor3"   

  2. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>  

  3. <bean id="handlerInterceptor4"   

  4. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>  

  5.    

 

java代码:

查看复制到剪贴板打印

  1. <bean id="handlerInterceptor3"   

  2. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>  

  3. <bean id="handlerInterceptor4"   

  4. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>  

  5.    

 

java代码:

查看复制到剪贴板打印

  1. <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">  

  2.     <property name="interceptors">  

  3.         <list>  

  4.            <ref bean="handlerInterceptor3"/>  

  5.           <ref bean="handlerInterceptor4"/>  

  6.         </list>  

  7.     </property>  

  8. </bean>  

 

interceptors:指定拦截器链,拦截器的执行顺序就是此处添加拦截器的顺序;

 

(4、视图页面

流程中断,不会执行到视图渲染。

(5、启动服务器测试

输入网址:http://localhost:9080/springmvc-chapter5/test

控制台输出:

 

java代码:

查看复制到剪贴板打印

  1. ===========HandlerInterceptor3 preHandle  

  2. ===========HandlerInterceptor4 preHandle  

  3. ===========HandlerInterceptor3 afterCompletion  

 

此处我们可以看到只有HandlerInterceptor3的afterCompletion执行,否和图5-2的中断流程。

而且页面上会显示我们在HandlerInterceptor4 preHandle 直接写出的响应“break”。

 

5.3、应用

5.3.1、性能监控

如记录一下请求的处理时间,得到一些慢请求(如处理时间超过500毫秒),从而进行性能改进,一般的反向代理服务器如apache都具有这个功能,但此处我们演示一下使用拦截器怎么实现。

 

实现分析:

1、在进入处理器之前记录开始时间,即在拦截器的preHandle记录开始时间;

2、在结束请求处理之后记录结束时间,即在拦截器的afterCompletion记录结束实现,并用结束时间-开始时间得到这次请求的处理时间。

 

问题:

我们的拦截器是单例,因此不管用户请求多少次都只有一个拦截器实现,即线程不安全,那我们应该怎么记录时间呢?

解决方案是使用ThreadLocal,它是线程绑定的变量,提供线程局部变量(一个线程一个ThreadLocal,A线程的ThreadLocal只能看到A线程的ThreadLocal,不能看到B线程的ThreadLocal)。

 

代码实现:

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter5.web.interceptor;  

  2. public class StopWatchHandlerInterceptor extends HandlerInterceptorAdapter {  

  3.     private NamedThreadLocal<Long>  startTimeThreadLocal =   

  4. new NamedThreadLocal<Long>("StopWatch-StartTime");  

  5.     @Override  

  6.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   

  7. Object handler) throws Exception {  

  8.         long beginTime = System.currentTimeMillis();//1、开始时间  

  9.         startTimeThreadLocal.set(beginTime);//线程绑定变量(该数据只有当前请求的线程可见)  

  10.         return true;//继续流程  

  11.     }  

  12.       

  13.     @Override  

  14.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response,   

  15. Object handler, Exception ex) throws Exception {  

  16.         long endTime = System.currentTimeMillis();//2、结束时间  

  17.         long beginTime = startTimeThreadLocal.get();//得到线程绑定的局部变量(开始时间)  

  18.         long consumeTime = endTime - beginTime;//3、消耗的时间  

  19.         if(consumeTime > 500) {//此处认为处理时间超过500毫秒的请求为慢请求  

  20.             //TODO 记录到日志文件  

  21.             System.out.println(  

  22. String.format("%s consume %d millis", request.getRequestURI(), consumeTime));  

  23.         }          

  24.     }  

  25. }  

 

NamedThreadLocal:Spring提供的一个命名的ThreadLocal实现。

 

在测试时需要把stopWatchHandlerInterceptor放在拦截器链的第一个,这样得到的时间才是比较准确的。

 

5.3.2、登录检测

在访问某些资源时(如订单页面),需要用户登录后才能查看,因此需要进行登录检测。

 

流程:

1、访问需要登录的资源时,由拦截器重定向到登录页面;

2、如果访问的是登录页面,拦截器不应该拦截;

3、用户登录成功后,往cookie/session添加登录成功的标识(如用户编号);

4、下次请求时,拦截器通过判断cookie/session中是否有该标识来决定继续流程还是到登录页面;

5、在此拦截器还应该允许游客访问的资源。

 

拦截器代码如下所示:

 

java代码:

查看复制到剪贴板打印

  1. @Override  

  2. public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   

  3. Object handler) throws Exception {  

  4.     //1、请求到登录页面 放行  

  5.     if(request.getServletPath().startsWith(loginUrl)) {  

  6.         return true;  

  7.     }  

  8.           

  9.     //2、TODO 比如退出、首页等页面无需登录,即此处要放行 允许游客的请求  

  10.           

  11.     //3、如果用户已经登录 放行    

  12.     if(request.getSession().getAttribute("username") != null) {  

  13.         //更好的实现方式的使用cookie  

  14.         return true;  

  15.     }  

  16.           

  17.     //4、非法请求 即这些请求需要登录后才能访问  

  18.     //重定向到登录页面  

  19.     response.sendRedirect(request.getContextPath() + loginUrl);  

  20.     return false;  

  21. }  

 

提示:推荐能使用servlet规范中的过滤器Filter实现的功能就用Filter实现,因为HandlerInteceptor只有在Spring Web MVC环境下才能使用,因此Filter是最通用的、最先应该使用的。如登录这种拦截器最好使用Filter来实现。

 第六章 注解式控制器详解——注解式控制器运行流程及处理器定义 

6.1、注解式控制器简介

一、Spring2.5之前,我们都是通过实现Controller接口或其实现来定义我们的处理器类。已经@Deprecated。

 

二、Spring2.5引入注解式处理器支持,通过@Controller 和 @RequestMapping注解定义我们的处理器类。并且提供了一组强大的注解:

 

需要通过处理器映射DefaultAnnotationHandlerMapping和处理器适配器AnnotationMethodHandlerAdapter来开启支持@Controller 和 @RequestMapping注解的处理器。

 

@Controller:用于标识是处理器类;

@RequestMapping:请求到处理器功能方法的映射规则;

@RequestParam:请求参数到处理器功能处理方法的方法参数上的绑定;

@ModelAttribute:请求参数到命令对象的绑定;

@SessionAttributes:用于声明session级别存储的属性,放置在处理器类上,通常列出模型属性(如@ModelAttribute)对应的名称,则这些属性会透明的保存到session中;

@InitBinder:自定义数据绑定注册支持,用于将请求参数转换到命令对象属性的对应类型;

 

三、Spring3.0引入RESTful架构风格支持(通过@PathVariable注解和一些其他特性支持),且又引入了更多的注解支持:

@CookieValue:cookie数据到处理器功能处理方法的方法参数上的绑定;

@RequestHeader:请求头(header)数据到处理器功能处理方法的方法参数上的绑定;

@RequestBody:请求的body体的绑定(通过HttpMessageConverter进行类型转换);

@ResponseBody:处理器功能处理方法的返回值作为响应体(通过HttpMessageConverter进行类型转换);

@ResponseStatus:定义处理器功能处理方法/异常处理器返回的状态码和原因;

@ExceptionHandler:注解式声明异常处理器;

@PathVariable:请求URI中的模板变量部分到处理器功能处理方法的方法参数上的绑定,从而支持RESTful架构风格的URI;

 

四、Spring3.1使用新的HandlerMapping 和 HandlerAdapter来支持@Contoller和@RequestMapping注解处理器。

新的@Contoller和@RequestMapping注解支持类:处理器映射RequestMappingHandlerMapping 和 处理器适配器RequestMappingHandlerAdapter组合来代替Spring2.5开始的处理器映射DefaultAnnotationHandlerMapping和处理器适配器AnnotationMethodHandlerAdapter,提供更多的扩展点。

 

接下来,我们一起开始学习基于注解的控制器吧。

6.2、入门

(1、控制器实现


java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter6.web.controller;  

  2. //省略import  

  3. @Controller         // 或 @RequestMapping               //①将一个POJO类声明为处理器  

  4. public class HelloWorldController {  

  5.     @RequestMapping(value = "/hello")                  //②请求URL到处理器功能处理方法的映射  

  6.     public ModelAndView helloWorld() {  

  7.         //1、收集参数  

  8.         //2、绑定参数到命令对象  

  9.         //3、调用业务对象  

  10.         //4、选择下一个页面  

  11.         ModelAndView mv = new ModelAndView();  

  12.         //添加模型数据 可以是任意的POJO对象  

  13.         mv.addObject("message""Hello World!");  

  14.         //设置逻辑视图名,视图解析器会根据该名字解析到具体的视图页面  

  15.         mv.setViewName("hello");  

  16.         return mv;                                         //○3 模型数据和逻辑视图名  

  17.     }  

  18. }  


1 可以通过在一个POJO类上放置@Controller或@RequestMapping,即可把一个POJO类变身为处理器;

@RequestMapping(value = "/hello") 请求URL(/hello) 到 处理器的功能处理方法的映射;

3 模型数据和逻辑视图名的返回。

 

现在的处理器无需实现/继承任何接口/类,只需要在相应的类/方法上放置相应的注解说明下即可,非常方便。

 

(2、Spring配置文件chapter6-servlet.xml

(2.1、HandlerMapping和HandlerAdapter的配置

如果您使用的是Spring3.1之前版本,开启注解式处理器支持的配置为:DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter。


java代码:

查看复制到剪贴板打印

  1. <!—Spring3.1之前的注解 HandlerMapping -->  

  2. <bean   

  3. class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping"/>  

  4.   

  5. <!—Spring3.1之前的注解 HandlerAdapter -->  

  6. <bean   

  7. class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"/>  

  8.       

 

如果您使用的Spring3.1开始的版本,建议使用RequestMappingHandlerMapping和RequestMappingHandlerAdapter。

 

 

java代码:

查看复制到剪贴板打印

  1. <!--Spring3.1开始的注解 HandlerMapping -->  

  2. <bean   

  3. class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping"/>  

  4. <!--Spring3.1开始的注解 HandlerAdapter -->  

  5. <bean  

  6. class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter"/>  

下一章我们介绍DefaultAnnotationHandlerMapping和AnnotationMethodHandlerAdapter 与RequestMappingHandlerMapping和RequestMappingHandlerAdapter 的区别。

 

(2.2、视图解析器的配置

还是使用之前的org.springframework.web.servlet.view.InternalResourceViewResolver。

(2.3、处理器的配置

 

java代码:

查看复制到剪贴板打印

  1. <!-- 处理器 -->  

  2. <bean class="cn.javass.chapter6.web.controller.HelloWorldController"/>  

 

只需要将处理器实现类注册到spring配置文件即可,spring的DefaultAnnotationHandlerMapping或RequestMappingHandlerMapping能根据注解@Controller或@RequestMapping自动发现。

 

(2.3、视图页面(/WEB-INF/jsp/hello.jsp)

 

java代码:

查看复制到剪贴板打印

  1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  

  3. <html>  

  4. <head>  

  5. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  

  6. <title>Hello World</title>  

  7. </head>  

  8. <body>  

  9. ${message}  

  10. </body>  

  11. </html>  

${message}:表示显示由HelloWorldController处理器传过来的模型数据。

 

(4、启动服务器测试

地址栏输入http://localhost:9080/springmvc-chapter6/hello,我们将看到页面显示“Hello World!”,表示成功了。

 

整个过程和我们第二章中的Hello World 类似,只是处理器的实现不一样。接下来我们来看一下具体流程吧。

 

6.3、运行流程

和第二章唯一不同的两处是:

1、HandlerMapping实现:使用DefaultAnnotationHandlerMapping(spring3.1之前)或RequestMappingHandlerMapping(spring3.1)替换之前的BeanNameUrlHandlerMapping。

注解式处理器映射会扫描spring容器中的bean,发现bean实现类上拥有@Controller或@RequestMapping注解的bean,并将它们作为处理器。

 

2、HandlerAdapter实现:使用AnnotationMethodHandlerAdapter(spring3.1之前)或RequestMappingHandlerAdapter(spring3.1)替换之前的SimpleControllerHandlerAdapter。

注解式处理器适配器会通过反射调用相应的功能处理方法(方法上拥有@RequestMapping注解)。

 

好了到此我们知道Spring如何发现处理器、如何调用处理的功能处理方法了,接下来我们详细学习下如何定义处理器、如何进行请求到功能处理方法的定义。

 

6.4、处理器定义

6.4.1、@Controller

 

java代码:

查看复制到剪贴板打印

  1. @Controller  

  2. public class HelloWorldController {  

  3. ……  

  4. }  

推荐使用这种方式声明处理器,它和我们的@Service、@[email protected]��件。

6.4.2、@RequestMapping

 

java代码:

查看复制到剪贴板打印

  1. @RequestMapping  

  2. public class HelloWorldController {  

  3. ……  

  4. }  

这种方式也是可以工作的,但如果在类上使用@ RequestMapping注解一般是用于窄化功能处理方法的映射的,详见6.4.3。

package cn.javass.chapter6.web.controller;@Controller@RequestMapping(value="/user")                 //①处理器的通用映射前缀public class HelloWorldController2 {    @RequestMapping(value = "/hello2")        //②相对于①处的映射进行窄化    public ModelAndView helloWorld() {         //省略实现    }} 

6.4.3、窄化请求映射

 

java代码:

查看复制到剪贴板打印

  1. package cn.javass.chapter6.web.controller;  

  2. @Controller  

  3. @RequestMapping(value="/user")                 //①处理器的通用映射前缀  

  4. public class HelloWorldController2 {  

  5.     @RequestMapping(value = "/hello2")        //②相对于①处的映射进行窄化  

  6.     public