SpringMVC -03- 详解 xml 文件 + DispatcherServlet + 拦截器

前面，在上一篇文章：Spring MVC -02- 第一个 Spring MVC 应用 Hello world！中，已经成功运行第一个 Spring MVC 应用了！

那么，之前提到的 web.xml 文件中，前端控制器 DispatcherServlet 在截获请求后做了什么工作呢？DispatcherServlet 又是如何分派请求的呢？下面进行详解：

（本篇部分内容来自网络，部分来自疯狂软件的那套书籍，没听过不要紧，应该不是很厉害，我感觉还好，有点基础再读更好，像博主这样笨就只能边百度，边看书喽）

DispatcherServlet 前置控制器

使用 Spring MVC，配置 DispatcherServlet 是第一步。DispatcherServlet 是一个Servlet，所以可以配置多个 DispatcherServlet。DispatcherServlet 是前置控制器，配置在 web.xml 文件中的。拦截匹配的请求，Servlet 拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标 Controller(我们写的Action)来处理

例如这样的配置：

<servlet>
		<servlet-name>springmvc</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>/WEB-INF/spring/mvc-config.xml</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>springmvc</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>

DispatcherServlet 是一个Servlet，可以同时配置多个，每个 DispatcherServlet 有一个自己的 WebApplicationContext 上下文，这个上下文继承了根上下文中所有东西。保存在 ServletContext 中，key 是 “org.springframework.web.servlet.FrameworkServlet.CONTEXT”+Servlet 名称。

当一个 Request 对象产生时，会把这个 WebApplicationContext 上下文保存在 Request 对象中，key 是 DispatcherServlet.class.getName() + “.CONTEXT”。可以使用工具类取出上下文：RequestContextUtils.getWebApplicationContext(request)；

使用 listener 监听器来加载配置

什么是 Listener?

监听器就是一个 Java类(狗仔) 用来监听其他的 JavaBean 的变化

在 javaweb 中监听器就是监听三个域对象的状态的。request,session,servletContext

例如这样的配置：

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

Spring 会创建一个全局的 WebApplicationContext 上下文，称为根上下文，保存在 ServletContext 中，key 是 WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE 属性的值。可以使用工具类取出上下文： WebApplicationContextUtils.getWebApplicationContext(ServletContext);

springmvc-config.xml 配置文件片段讲解

例如这样的配置：

<!-- 自动扫描的包名 -->  
<context:component-scan base-package="com.app,com.core,JUnit4" >
</context:component-scan>  
     
<!-- 默认的注解映射的支持 -->  
<mvc:annotation-driven />  
     
<!-- 视图解释类 -->  
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">  
    <property name="prefix" value="/WEB-INF/jsp/"/>  
    <property name="suffix" value=".jsp"/><!--可为空,方便实现自已的依据扩展名来选择视图解释类的逻辑  -->  
    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" />  
</bean>  
     
<!-- 拦截器 -->  
<mvc:interceptors>  
     <bean class="com.core.mvc.MyInteceptor" />  
</mvc:interceptors>       
  
<!-- 对静态资源文件的访问  方案一 （二选一） -->  
<mvc:default-servlet-handler/>  
      
<!-- 对静态资源文件的访问  方案二 （二选一）-->  
<mvc:resources mapping="/images/**" location="/images/" cache-period="31556926"/>  
<mvc:resources mapping="/js/**" location="/js/" cache-period="31556926"/>  
<mvc:resources mapping="/css/**" location="/css/" cache-period="31556926"/>

<context:component-scan/> 扫描指定的包中的类上的注解

常用的注解有：

@Controller 声明Action组件
@Service 声明Service组件 @Service(“myMovieLister”)
@Repository 声明Dao组件
@Component 泛指组件, 当不好归类时.
@RequestMapping("/menu") 请求映射
@Resource 用于注入，( j2ee提供的 ) 默认按名称装配，
@Resource(name=“beanName”)
@Autowired 用于注入，(srping提供的) 默认按类型装配
@Transactional( rollbackFor={Exception.class}) 事务管理
@ResponseBody
@Scope(“prototype”) 设定 bean 的作用域

<mvc:annotation-driven /> 是一种简写形式，完全可以手动配置替代这种简写形式，简写形式可以让初学都快速应用默认配置方案。

<mvc:annotation-driven /> 会自动注册 DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter 两个 bean，是 spring MVC 为 @Controllers 分发请求所必须的。

并提供了：数据绑定支持，@NumberFormatannotation支持，@DateTimeFormat支持，@Valid支持，读写XML的支持（JAXB），读写JSON的支持（Jackson）。

后面，我们处理响应ajax请求时，就使用到了对json的支持。

后面，对action写JUnit单元测试时，要从spring IOC容器中取 DefaultAnnotationHandlerMapping 与 AnnotationMethodHandlerAdapter 两个bean，来完成测试，取的时候要知道是

<mvc:annotation-driven />这一句注册的这两个bean。

<mvc:interceptors/> 是一种简写形式。可以配置多个HandlerMapping。

<mvc:interceptors/>会为每一个HandlerMapping，注入一个拦截器。其实我们也可以手动配置为每个HandlerMapping注入一个拦截器。

<mvc:default-servlet-handler/> 使用默认的Servlet来响应静态文件。

<mvc:resources mapping="/images/*" location="/images/" cache-period=“31556926”/> 匹配URL /images/** 的 URL 被当做静态资源，由Spring读出到内存中再响应 http。

访问到静态的文件，如 jpg，js，css

如何你的 DispatcherServlet 拦截 *.do 这样的 URL，就不存在访问不到静态资源的问题。如果你的拦截“/”，拦截了所有的请求，同时对 *.js，*.jpg 的访问也就被拦截了。

目的： 可以正常访问静态文件，不要找不到静态文件报404。

方案一：激活Tomcat的defaultServlet来处理静态文件

例如这样的配置：

<servlet-mapping>   
    <servlet-name>default</servlet-name>  
    <url-pattern>*.jpg</url-pattern>     
</servlet-mapping>    
<servlet-mapping>       
    <servlet-name>default</servlet-name>    
    <url-pattern>*.js</url-pattern>    
</servlet-mapping>    
<servlet-mapping>        
    <servlet-name>default</servlet-name>       
    <url-pattern>*.css</url-pattern>      
</servlet-mapping>

要配置多个，每种文件配置一个

要写在 DispatcherServlet 的前面，让 defaultServlet 先拦截，这个就不会进入Spring了

Tomcat, Jetty, JBoss, and GlassFish 默认 Servlet 的名字 – “default”
Google App Engine 默认 Servlet 的名字 – “_ah_default”
Resin 默认 Servlet 的名字 – “resin-file”
WebLogic 默认 Servlet 的名字 – “FileServlet”
WebSphere 默认 Servlet 的名字 – “SimpleFileServlet”

方案二：在 spring3.0.4 以后版本提供了 mvc:resources

mvc:resources 的使用方法：

<!-- 对静态资源文件的访问 -->    
<mvc:resources mapping="/images/**" location="/images/" />

mapping 映射到 ResourceHttpRequestHandler 进行处理
location 指定静态资源的位置。可以是 web application 根目录下、jar 包里面，这样可以把静态资源压缩到 jar 包中
cache-period 可以使得静态资源进行 web cache

如果出现下面的错误，可能是没有配置<mvc:annotation-driven />的原因。
报错WARNING: No mapping found for HTTP request with URI [/mvc/user/findUser/lisi/770] in DispatcherServlet with name ‘springMVC’

使用 <mvc:resources/> 元素，把 mapping 的 URI 注册到 SimpleUrlHandlerMapping 的 urlMap 中，key 为 mapping 的 URI pattern 值，而 value 为 ResourceHttpRequestHandler，这样就巧妙的把对静态资源的访问由 HandlerMapping 转到 ResourceHttpRequestHandler 处理并返回，所以就支持classpath 目录，jar 包内静态资源的访问。另外需要注意的一点是，不要对 SimpleUrlHandlerMapping 设置 defaultHandler。因为对 static uri 的 defaultHandler 就是 ResourceHttpRequestHandler，否则无法处理 static resources request。

方案三，使用 <mvc:default-servlet-handler/>

<mvc:default-servlet-handler/>

会把"/**" url，注册到 SimpleUrlHandlerMapping 的 urlMap 中，把对静态资源的访问由 HandlerMapping 转到 org.springframework.web.servlet.resource。

DefaultServletHttpRequestHandler 处理并返回。DefaultServletHttpRequestHandler 使用就是各个 Servlet 容器自己的默认 Servlet。

补充说明： 多个 HandlerMapping 的执行顺序问题：

DefaultAnnotationHandlerMapping 的 order 属性值是：0
<mvc:resources/ >自动注册的 SimpleUrlHandlerMapping 的 order 属性值是： 2147483646

<mvc:default-servlet-handler/> 自动注册的 SimpleUrlHandlerMapping 的 order 属性值是： 2147483647

spring 会先执行 order 值比较小的。当访问一个 a.jpg 图片文件时，先通过 DefaultAnnotationHandlerMapping 来找处理器，一定是找不到的，我们没有叫a.jpg 的 Action。再按 order 值升序找，由于最后一个 SimpleUrlHandlerMapping 是匹 “/**” 的，所以一定会匹配上，再响应图片。

Spring 中的拦截器：

Spring为我们提供了：org.springframework.web.servlet.HandlerInterceptor 接口， org.springframework.web.servlet.handler.HandlerInterceptorAdapter 适配器，实现这个接口或继承此类，可以非常方便的实现自己的拦截器。

 public boolean preHandle(HttpServletRequest request,
     HttpServletResponse response, Object handler);

 public void postHandle(HttpServletRequest request,
     HttpServletResponse response, Object handler,ModelAndView modelAndView);

 public void afterCompletion(HttpServletRequest request,
     HttpServletResponse response, Object handler, Exception ex)

分别实现预处理、后处理（调用了Service并返回ModelAndView，但未进行页面渲染）、返回处理（已经渲染了页面）
在preHandle中，可以进行编码、安全控制等处理；
在postHandle中，有机会修改ModelAndView；
在afterCompletion中，可以根据ex是否为null判断是否发生了异常，进行日志记录。
参数中的 Object handler 是下一个拦截器。

自定义一个拦截器，要实现 HandlerInterceptor 接口：

public class MyInteceptor implements HandlerInterceptor

Spring MVC并没有总的拦截器，不能对所有的请求进行前后拦截。Spring MVC的拦截器，是属于HandlerMapping级别的，可以有多个HandlerMapping ，每个HandlerMapping可以有自己的拦截器。

在spring MVC的配置文件中配置有三种方法：

方案一（近似）总拦截器，拦截所有 url

<mvc:interceptors>  
    <bean class="com.app.mvc.MyInteceptor" />  
</mvc:interceptors>

mvc:interceptors/会为每一个HandlerMapping，注入一个拦截器。总有一个HandlerMapping是可以找到处理器的，最多也只找到一个处理器，所以这个拦截器总会被执行的。起到了总拦截器的作用。

方案二（近似）总拦截器，拦截匹配的 URL。比方案一多一个 URL 匹配。

<mvc:interceptors >    
  <mvc:interceptor>    
        <mvc:mapping path="/user/*" /> <!-- /user/*  -->    
        <bean class="com.mvc.MyInteceptor"></bean>    
    </mvc:interceptor>    
</mvc:interceptors>

方案三 HandlerMapping 上的拦截器

<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">       
 <property name="interceptors">       
     <list>       
         <bean class="com.mvc.MyInteceptor"></bean>      
     </list>       
 </property>       
</bean>

<mvc:annotation-driven /> 会自动注册 DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter 这两个 bean，所以就没有机会再给它注入interceptors属性，就无法指定拦截器。

如果我们手动配置上面的两个 Bean，不使用 <mvc:annotation-driven />，就可以给 interceptors 属性注入拦截器了。

实现全局的异常处理

<!-- 总错误处理-->  
<bean id="exceptionResolver" class="org.springframework.web.servlet.handler.SimpleMappingExceptionResolver">  
    <property name="defaultErrorView">    
        <value>/error/error</value>  
    </property>  
    <property name="defaultStatusCode">    
        <value>500</value>  
    </property>     
    <property name="warnLogCategory">    
        <value>org.springframework.web.servlet.handler.SimpleMappingExceptionResolver</value>  
    </property>     
</bean>

通过 SimpleMappingExceptionResolver 我们可以将不同的异常映射到不同的 jsp 页面（通过 exceptionMappings 属性的配置）。如果所抛出的异常在 exceptionMappings 中没有对应的映射，则 Spring 将用此默认配置显示异常信息（通过 defaultErrorView 属性的配置）。

<html>  
<head>  
<meta http-equiv="Content-Type" content="text/html; charset=GBK">  
<title>错误页面</title>  
</head>  
<body>  
<h1>出错了</h1>  
<%  
Exception e = (Exception)request.getAttribute("exception");  
out.print(e.getMessage());  
%>  
</body>  
</html>

其中一句：request.getAttribute(“exception”)，key 是 exception，也是在 SimpleMappingExceptionResolver 类默认指定的，是可能通过配置文件修改这个值的。