《“爱读书”--给你讲技术》，我来看书，你来进步，让我们开始吧！

本书简介

书名为《Spring+MyBatis企业应用实战》，是本人在学习JavaEE框架时候的一本基础书籍，本书对于SpringMVC和MyBatis框架及相关基础知识讲述的比较清晰，适合需要详细学习Java框架的读者。

本文内容为本书第二章--第八章，记录和总结了所有SpringMVC的知识

DispatcherServlet

1.DispatcherServlet使用和配置

SpringMVC提供了一个名为org.springframework.web.servlet.DispatcherServlet的Servlet充当前端控制器，所有请求驱动都围绕这个DispatcherServlet来分配请求。DispatcherServlet是一个Servlet类，需要在web.xml中完成配置。

（1）配置了启动时立即加载Servlet

（2）需要配置springmvc-config.xml配置文件

（3）配置了用当前servlet处理所有请求URL

2.DispatcherServlet的分发原理

先看一下DispatcherServlet源码中的方法

源码如下：

initStrategies方法将在WebApplicationContext初始化后自动执行，自动扫描上下文的Bean，根据名称或类型匹配机制查找自定义的组件。如果没有找到则会装配一套默认组件，默认组件在DispatcherServlet.properties配置文件中。

配置文件如下：

如 果开发者希望使用自定义类型的组件，则只需要在Spring配置文件中配置自定义的Bean即可。MVC如果发现上下文中有用户自定义的组件，就不会使用默认组件。

SpringMVC开发步骤

1.在web.xml中定义前端控制器DispatcherServlet来拦截用户请求

2.定义处理用户请求的Handle类，可以实现Controller接口或使用@Controller注解

3.配置Handle，可采用xml文件或注解的方式

<!-- 配置Handle，映射/hello请求 -->
<bean name="/hello" class="org.fkit.controller.HelloController"/>

@Controller
public class HelloController{
    @RequestMapping(value="/hello")
    public ModelAndView hello(){
    }
}

4.编写视图资源，Handle处理用户请求结束后，通常会返回一个ModelAndView对象，该对象包含返回的试图名和模型。试图名代表需要显示的物理视图资源；模型用于传输数据给视图资源。

SpringMVC执行流程

说明如下：

（1）用户向服务器发送请求，请求被Spring的前端控制器DispatcherServlet截获

（2）DispatcherServlet对请求URL进行解析，得到URI。然后根据URI，调用HandlerMapping获得该Handler配置的所有相关对象，包括Handler对象以及Handler对象对应的拦截器，会被封装到一个HandlerExecutionChain对象中返回

（3）DispatcherServlet根据获得的Handler，选择一个HandlerAdapter。HandlerAdapter会被用于处理多种Handler，调用Handler实际处理请求的方法

（4）提取请求中的模型数据，开始执行Handler。在填充Handler的入参过程中，根据配置spring会帮你实现消息转换、数据转换、数据格式化、数据验证

（5）Handler执行完成后，向DispatcherServlet返回一个ModelAndView对象。ModelAndView对象中包含试图名和模型

（6）根据返回的ModelAndView对象，选择一个ViewResolver返回给DispatcherServlet

（7）ViewResolver结合Model和View来渲染视图

（8）将试图渲染结果返回给客户端

SpringMVC常用注解

1.@Controller注解

@Controller用于标记一个类，使用它标记的类就是一个Controller对象，及一个控制器。Spring使用扫描机制查找应用中所有基于注解的控制器类。

@Controller
public class HelloController{
    @RequestMapping(value="/hello")
    public ModelAndView hello(){
    }
}

使用注解前需要如下步骤：

• 在SpringMVC配置文件的头中引入spring-context
• 使用<context:component-scan/>元素，功能是：启动包扫描功能，以便注册带有@Controller、@Service、@Repository、@Component等注解的类成为Bean。base-package指定了需要扫描的类包，类包及其递归子包中的所有类都会被扫描。配置如下：

<context:component-scan base-package="org.fkit.controller"/>

springmvc-config.xml常用配置

说明如下：

（1）使用<context:component-scan>指定需要扫描的包

（2）<mvc:annotation-driven>会自动注册RequestMappingHandlerMapping和Request MappingHandlerAdapter两个Bean，提供注解的必要支持

（3）<mvc:default-servlet-handler>是静态资源处理器，SpringMVC会默认捕获所有请求，包括静态资源请求。配置了当前元素后静态资源不会被DispatcherServlet处理

（4）视图解析器InternalResourceViewResolver来解析视图，将View呈现给用户。配置的prefix属性表示视图的前缀，suffix表示视图的后缀。

2.@RequestMapping注解

@RequestMapping注解可以用来注释一个控制器类，所有方法都将映射为相对于类级别的请求，表示该控制器处理的所有请求都被映射到value属性所指示的路径下。

上图代表映射到如下路径：

http://localhost:8080/user/register
http://localhost:8080/user/login

常用属性如下：

3.请求处理方法可出现的参数类型

所有参数Spring会自动将值传给方法

（1）HttpServletRequest参数

（2）HttpSession参数

（3）HttpServletResponse

（4）InputStream

（5）OutputStream

（6）Map

（7）Model

（8）ModelMap

（9）BindingResult

（10）WebRequest

4.请求处理方法可返回的类型

• ModelAndView
• Model
• Map
• View
• String

下面做一些详细说明。

（1）Model和ModelMap

SpringMVC在调用处理方法之前会创建一个隐含的模型对象，作为模型数据的存储容器。如果处理方法的参数为Model或ModelMap类型，则SpringMVC会将隐含模型的引用传递给这些参数。在处理方法内部，开发者可以通过这个参数对象访问模型中的所有数据，也可以向模型中添加新的数据。

（2）ModelAndView

控制器处理方法的返回值如果是ModelAndView，则既包含模型数据，也包含视图信息。

常用方法如下：

//添加模型数据
addObject(String key, Object value);
//设置视图
setViewName(String name);

5.页面转发

（1）转发到JSP

//默认forward跳转
return "main";
modelAndView.setViewName("main");
//重定向页面
return "redirect:/main.jsp";
modelAndView.setViewName("redirect:/main.jsp");

（2）转发到其他处理方法

//forward跳转
return "forward:/main";
modelAndView.setViewName("forward:/main");
//重定向
return "redirect:/main";
modelAndView.setViewName("redirect:/main");

6.@RequestParam注解

@RequestParam用于将指定的请求参数赋值给方法中的形参。属性如下：

name：指定请求参数绑定的名称
value：name属性的别名
required：指定参数是否必须绑定
defaultValue：指定默认值

7.@PathVariable注解

@PathVariable可以方便的获得请求URL中的动态参数。属性如下：

举例如下：

@RequestMapping(value="/pathVariableTest/{userId}")
public void pathVariableTest(@PathVariable Integer userId)

假如请求的URL为http://localhost:8080/pathVariableTest/1，则自动将URL中模板变量{userId}绑定到通过@PathVariable注解的同名参数上，即userId变量将被赋值为1。

8.@RequestHeader注解

@RequestHeader注解用于将请求头信息数据映射到功能处理方法的参数上。属性如下：

举例如下：

9.@CookieValue注解

@CookieValue注解用于将请求的Cookie数据映射到功能处理方法的参数上。属性如下：

举例如下：

10.@RequestAttribute注解

@RequestAttribute注解用于访问由请求处理方法、过滤器或拦截器创建的、预先存在于request作用域中的属性，将该属性转换到目标方法的参数。属性如下：

举例如下：

11.@SessionAttribute注解

@SessionAttribute注解用于访问由请求处理方法、过滤器或拦截器创建的、预先存在于session作用域中的属性，将该属性转换到目标方法的参数。属性如下：

举例如下：

12.@ModelAttribute注解

@ModelAttribute注解用于将请求参数绑定到对象。

举例如下：

Form请求的参数值会自动入参到@ModelAttribute注解的对象的同名属性中

13.@RequestBody注解

@RequestBody注解用来处理content-type类型为：application/json或application/xml的情况，将请求数据绑定到方法参数上。

举例如下：

其中前台向处理方法传递了Json格式的数据，Json数据的key和Book属性相对应

14.@ResponseBody注解

@ResponseBody注解用于将请求处理方法返回的对象，转换为指定格式后，写入到Response对象的body中。返回的数据不是HTML页面，而是其他格式数据，如JSON、XML时使用注解。

举例如下：

上图将List转换为Json格式输出

15.@RestController注解

@RestController注解相当于同时使用了@Controller和@ResponseBody。用于RESTFUL风格的请求处理方式。

SpringMVC异常处理

SpringMVC提供的两种异常处理方式：

• 使用异常处理器SimpleMappingExceptionResolver，类有如下方法：

//该方法处理程序执行期间被抛出的异常，返回一个模型和视图，视图返回错误处理页面
ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response)

通过springmvc-config.xml配置实现

<!-- p:defaultErrorView="error"表示所有没有指定的异常都跳转到异常处理页面error
     p:exceptionAttribute="ex"表示异常处理页面中访问的异常对象变量名为ex -->
<bean class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver"
      p:defaultErrorView="error" p:exceptionAttribute="ex">
      <!-- exceptionMappings表示映射的异常，接受参数是一个Properties，key是异常类名，value是处理异常的页面 -->
      <property name="exceptionMappings">
          <props>
              <prop key="IOException">ioerror</prop>
              <prop key="SQLException">sqlerror</prop>
         </props>
     </property>
</bean>

• 使用@ExceptionHandler注解实现局部异常处理

@ExceptionHandler注解只在当前类生效

• 使用@ControllerAdvice注解实现全局异常处理

使用<context:component-scan>扫描到@ControllerAdvice注解后，会将注解修饰的类内部使用@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法应用到所有请求的异常处理上。

SpringMVC国际化

1.messageSource接口

SpringMVC不直接使用java.util.ResourceBundle，而是使用messageSource的Bean来配置国际化属性文件。

上图basenames指定了资源文件的名称

2.localeResolver接口

SpringMVC使用语言区域解析器来实现用户选择语言区域。提供了一个语言区域解析器接口LocaleResolver，实现类包括：

• AcceptHeaderLocaleResolver
• SessionLocaleResolver
• CookieLocaleResolver

AcceptHeaderLocaleResolver是默认解析器，会读取浏览器accept-language标题，来确定使用哪个语言区域

3.message标签

SpringMVC显示本地化消息使用message标签，使用前需先导入taglib标签库。

<%@taglib prefix="spring" uri="http://www.springframework.org/tags"%>

message标签属性如下：

4.AcceptHeaderLocaleResolver

实现步骤：

（1）创建资源文件

message_en_US.properties

message_zh_CN.properties

（2）在JSP中使用message标签输出国际化消息

（3）在SpringMVC配置文件中加载国际化资源文件并配置

（4）可在controller中使用国际化

RequestContext requestContext = new RequestContext(request);
String username = requestContext.getMessage("username");

SpringMVC数据转换、格式化、校验原理

Spring MVC框架将ServletRequest对象及处理方法的参数对象传递给DataBinder，DataBinder调用ConversionService组件进行数据类型转换、数据格式化工作，并将ServletRequest中的消息填充到参数对象中。然后再调用Validator组件对已经绑定了请求消息数据的参数对象进行数据合法性校验，并最终生成 数据绑定结果BindingResult 对象。

SpringMVC文件上传

实现步骤：

（1）创建表单并设置为multipart/form-data

（2）创建controller

SpringMVC会将上传文件绑定到MultipartFile对象。MultipartFile提供了获取上传文件内容、文件名等方法。

MultipartFile常用方法如下：

byte[] getBytes()：获取文件数据
String getContentType()：获取文件MIME类型，如image/jpeg
InputStream getInputStream()：获取文件流
String getName()： 获取表单中文件组件的名称
String getOriginalFilename()：获取上传文件的原名
long getSize()： 获取文件的字节大小，单位为byte
boolean isEmpty()： 是否有上传的文件
void transferTo(File file)：将上传文件保存到一个目标文件中

（3）在SpringMVC配置文件中增加文件上传功能（配置MultipartResolver）

CommonsMultipartResolver必须依赖于Apach FileUpload组件，需要引入JAR包

SpringMVC文件下载

实现步骤：

（1）在页面中加入下载超链接，链接地址指向controller方法

（2）编写controller处理方法，用于文件下载

使用Apache FileUpload组件FileUtils读取要下载的文件，并将其构建成ResponseEntity对象返回。ResponseEntity对象可以方便的定义返回的BodyBuilder、HttpHeaders、HttpStatus。

BodyBuilder对象用来构建返回的Body

HttpHeaders代表Http协议头信息

HttpStatus代表Http协议的状态

SpringMVC拦截器

Interceptor拦截器的主要作用是拦截用户的请求并进行相应的处理（比如通过拦截器来进行用户权限验证，或者用来判断用户是否已经登录等）

1.HandlerInterceptor接口

定义拦截器类需要实现HandlerInterceptor接口或继承抽象类HandlerInterceptorAdapter

接口中的方法如下：

//该方法在请求处理之前被调用，可以做前置的初始化操作或者是对当前请求的一个预处理，也可以判断来请求是否要继续进行下去。当返回值为false，表示请求结束，后续的Interceptor和Controller不会再执行；当返回值为true泽会继续执行
boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
//该方法在controller方法被执行，在视图返回渲染前被调用。可以在这个方法中对处理后的ModelAndView进行操作
void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView mv)
//该方法将在整个请求结束后执行，作用是进行资源清理
void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception)

实现步骤：

（1）定义拦截器类，实现接口和接口中的方法

（2）在配置文件中配置拦截器（springmvc-config.xml）

<!-- 拦截器定义 -->
<mvc:interceptors>
    <mvc:interceptor>
        <!-- 拦截所有请求 -->
        <mvc:mapping path="/*"/>
        <!-- 使用Bean定义一个Interceptor -->
        <bean class="org.fkit.interceptor.AuthorizationInterceptor"/>
    </mvc:interceptor>    
</mvc:interceptors>