SpringMVC中使用Interceptor拦截器

SpringMVC中的Interceptor拦截器也是相当重要和相当有用的，它的主要作用是拦截用户的请求并进行相应的处理。比如通过它来进行权限验证，或者是来判断用户是否登陆，或者是像12306那样子判断当前时间是否是购票时间。

一、定义Interceptor实现类

SpringMVC中的Interceptor拦截请求是通过HandlerInterceptor来实现的。在SpringMVC中定义一个Interceptor非常简单，主要有两种方式，第一种方式是要定义的Interceptor类要实现了Spring的HandlerInterceptor接口，或者是这个类继承实现了HandlerInterceptor接口的类，比如Spring已经提供的实现了HandlerInterceptor接口的抽象类HandlerInterceptorAdapter；第二种方式是实现Spring的WebRequestInterceptor接口，或者是继承实现了WebRequestInterceptor的类。

（一）实现HandlerInterceptor接口

HandlerInterceptor接口中定义了三个方法，我们就是通过这三个方法来对用户的请求进行拦截处理的。

（1）preHandle(HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顾名思义，该方法将在请求处理之前进行调用。SpringMVC中的Interceptor是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor。每个Interceptor的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor中的preHandle方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。该方法的返回值是布尔值Boolean类型的，当它返回为false时，表示请求结束，后续的Interceptor和Controller都不会再执行；当返回值为true时就会继续调用下一个Interceptor的preHandle方法，如果已经是最后一个Interceptor的时候就会是调用当前请求的Controller方法。

（2）postHandle(HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，由preHandle方法的解释我们知道这个方法包括后面要说到的afterCompletion方法都只能是在当前所属的Interceptor的preHandle方法的返回值为true时才能被调用。postHandle方法，顾名思义就是在当前请求进行处理之后，也就是Controller方法调用之后执行，但是它会在DispatcherServlet进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller处理之后的ModelAndView对象进行操作。postHandle方法被调用的方向跟preHandle是相反的，也就是说先声明的Interceptor的postHandle方法反而会后执行，这和Struts2里面的Interceptor的执行过程有点类型。Struts2里面的Interceptor的执行过程也是链式的，只是在Struts2里面需要手动调用ActionInvocation的invoke方法来触发对下一个Interceptor或者是Action的调用，然后每一个Interceptor中在invoke方法调用之前的内容都是按照声明顺序执行的，而invoke方法之后的内容就是反向的。

（3）afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex)方法，该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。顾名思义，该方法将在整个请求结束之后，也就是在DispatcherServlet渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

下面是一个简单的代码说明：

Java代码

1. importjavax.servlet.http.HttpServletRequest;
2. importjavax.servlet.http.HttpServletResponse;
4. importorg.springframework.web.servlet.HandlerInterceptor;
5. importorg.springframework.web.servlet.ModelAndView;
7. publicclassSpringMVCInterceptorimplementsHandlerInterceptor{
10. /**
11. *preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，SpringMVC中的Interceptor拦截器是链式的，可以同时存在
12. *多个Interceptor，然后SpringMVC会根据声明的前后顺序一个接一个的执行，而且所有的Interceptor中的preHandle方法都会在
13. *Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的，这种中断方式是令preHandle的返
14. *回值为false，当preHandle的返回值为false的时候整个请求就结束了。
15. */
16. @Override
17. publicbooleanpreHandle(HttpServletRequestrequest,
18. HttpServletResponseresponse,Objecthandler)throwsException{
19. //TODOAuto-generatedmethodstub
20. returnfalse;
21. }
23. /**
24. *这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，它的执行时间是在处理器进行处理之
25. *后，也就是在Controller的方法调用之后执行，但是它会在DispatcherServlet进行视图的渲染之前执行，也就是说在这个方法中你可以对ModelAndView进行操
26. *作。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用，这跟Struts2里面的拦截器的执行过程有点像，
27. *只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor
28. *或者是调用action，然后要在Interceptor之前调用的内容都写在调用invoke之前，要在Interceptor之后调用的内容都写在调用invoke方法之后。
29. */
30. @Override
31. publicvoidpostHandle(HttpServletRequestrequest,
32. HttpServletResponseresponse,Objecthandler,
33. ModelAndViewmodelAndView)throwsException{
34. //TODOAuto-generatedmethodstub
36. }
38. /**
39. *该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后，也就是DispatcherServlet渲染了视图执行，
40. *这个方法的主要作用是用于清理资源的，当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。
41. */
42. @Override
43. publicvoidafterCompletion(HttpServletRequestrequest,
44. HttpServletResponseresponse,Objecthandler,Exceptionex)
45. throwsException{
46. //TODOAuto-generatedmethodstub
48. }
50. }

（二）实现WebRequestInterceptor接口

WebRequestInterceptor中也定义了三个方法，我们也是通过这三个方法来实现拦截的。这三个方法都传递了同一个参数WebRequest，那么这个WebRequest是什么呢？这个WebRequest是Spring定义的一个接口，它里面的方法定义都基本跟HttpServletRequest一样，在WebRequestInterceptor中对WebRequest进行的所有操作都将同步到HttpServletRequest中，然后在当前请求中一直传递。

（1）preHandle(WebRequest request)方法。该方法将在请求处理之前进行调用，也就是说会在Controller方法调用之前被调用。这个方法跟HandlerInterceptor中的preHandle是不同的，主要区别在于该方法的返回值是void，也就是没有返回值，所以我们一般主要用它来进行资源的准备工作，比如我们在使用Hibernate的时候可以在这个方法中准备一个Hibernate的Session对象，然后利用WebRequest的setAttribute(name, value, scope)把它放到WebRequest的属性中。这里可以说说这个setAttribute方法的第三个参数scope，该参数是一个Integer类型的。在WebRequest的父层接口RequestAttributes中对它定义了三个常量：

SCOPE_REQUEST：它的值是0，代表只有在request中可以访问。

SCOPE_SESSION：它的值是1，如果环境允许的话它代表的是一个局部的隔离的session，否则就代表普通的session，并且在该session范围内可以访问。

SCOPE_GLOBAL_SESSION：它的值是2，如果环境允许的话，它代表的是一个全局共享的session，否则就代表普通的session，并且在该session范围内可以访问。

（2）postHandle(WebRequest request, ModelMap model)方法。该方法将在请求处理之后，也就是在Controller方法调用之后被调用，但是会在视图返回被渲染之前被调用，所以可以在这个方法里面通过改变数据模型ModelMap来改变数据的展示。该方法有两个参数，WebRequest对象是用于传递整个请求数据的，比如在preHandle中准备的数据都可以通过WebRequest来传递和访问；ModelMap就是Controller处理之后返回的Model对象，我们可以通过改变它的属性来改变返回的Model模型。

（3）afterCompletion(WebRequest request, Exception ex)方法。该方法会在整个请求处理完成，也就是在视图返回并被渲染之后执行。所以在该方法中可以进行资源的释放操作。而WebRequest参数就可以把我们在preHandle中准备的资源传递到这里进行释放。Exception参数表示的是当前请求的异常对象，如果在Controller中抛出的异常已经被Spring的异常处理器给处理了的话，那么这个异常对象就是是null。

下面是一个简单的代码说明：

Java代码

1. importorg.springframework.ui.ModelMap;
2. importorg.springframework.web.context.request.WebRequest;
3. importorg.springframework.web.context.request.WebRequestInterceptor;
5. publicclassAllInterceptorimplementsWebRequestInterceptor{
7. /**
8. *在请求处理之前执行，该方法主要是用于准备资源数据的，然后可以把它们当做请求属性放到WebRequest中
9. */
10. @Override
11. publicvoidpreHandle(WebRequestrequest)throwsException{
12. //TODOAuto-generatedmethodstub
13. System.out.println("AllInterceptor...............................");
14. request.setAttribute("request","request",WebRequest.SCOPE_REQUEST);//这个是放到request范围内的，所以只能在当前请求中的request中获取到
15. request.setAttribute("session","session",WebRequest.SCOPE_SESSION);//这个是放到session范围内的，如果环境允许的话它只能在局部的隔离的会话中访问，否则就是在普通的当前会话中可以访问
16. request.setAttribute("globalSession","globalSession",WebRequest.SCOPE_GLOBAL_SESSION);//如果环境允许的话，它能在全局共享的会话中访问，否则就是在普通的当前会话中访问
17. }
19. /**
20. *该方法将在Controller执行之后，返回视图之前执行，ModelMap表示请求Controller处理之后返回的Model对象，所以可以在
21. *这个方法中修改ModelMap的属性，从而达到改变返回的模型的效果。
22. */
23. @Override
24. publicvoidpostHandle(WebRequestrequest,ModelMapmap)throwsException{
25. //TODOAuto-generatedmethodstub
26. for(Stringkey:map.keySet())
27. System.out.println(key+"-------------------------");;
28. map.put("name3","value3");
29. map.put("name1","name1");
30. }
32. /**
33. *该方法将在整个请求完成之后，也就是说在视图渲染之后进行调用，主要用于进行一些资源的释放
34. */
35. @Override
36. publicvoidafterCompletion(WebRequestrequest,Exceptionexception)
37. throwsException{
38. //TODOAuto-generatedmethodstub
39. System.out.println(exception+"-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=");
40. }
42. }

二、把定义的拦截器类加到SpringMVC的拦截体系中

1.在SpringMVC的配置文件中加上支持MVC的schema

Xml代码

1. xmlns:mvc="http://www.springframework.org/schema/mvc"
2. xsi:schemaLocation="http://www.springframework.org/schema/mvc
3. http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"

下面是我的声明示例：

Xml代码

1. <beansxmlns="http://www.springframework.org/schema/beans"
2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"
3. xmlns:mvc="http://www.springframework.org/schema/mvc"
4. xsi:schemaLocation="http://www.springframework.org/schema/beans
5. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
6. http://www.springframework.org/schema/context
7. http://www.springframework.org/schema/context/spring-context-3.0.xsd
8. http://www.springframework.org/schema/mvc
9. http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">

这样在SpringMVC的配置文件中就可以使用mvc标签了，mvc标签中有一个mvc:interceptors是用于声明SpringMVC的拦截器的。

（二）使用mvc:interceptors标签来声明需要加入到SpringMVC拦截器链中的拦截器

Xml代码

1. <mvc:interceptors>
2. <!--使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求-->
3. <beanclass="com.host.app.web.interceptor.AllInterceptor"/>
4. <mvc:interceptor>
5. <mvc:mappingpath="/test/number.do"/>
6. <!--定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的-->
7. <beanclass="com.host.app.web.interceptor.LoginInterceptor"/>
8. </mvc:interceptor>
9. </mvc:interceptors>

由上面的示例可以看出可以利用mvc:interceptors标签声明一系列的拦截器，然后它们就可以形成一个拦截器链，拦截器的执行顺序是按声明的先后顺序执行的，先声明的拦截器中的preHandle方法会先执行，然而它的postHandle方法和afterCompletion方法却会后执行。

在mvc:interceptors标签下声明interceptor主要有两种方式：

（1）直接定义一个Interceptor实现类的bean对象。使用这种方式声明的Interceptor拦截器将会对所有的请求进行拦截。

（2）使用mvc:interceptor标签进行声明。使用这种方式进行声明的Interceptor可以通过mvc:mapping子标签来定义需要进行拦截的请求路径。

经过上述两步之后，定义的拦截器就会发生作用对特定的请求进行拦截了。

拦截路径配置：

SpringMVC拦截器（资源和权限管理）

1.DispatcherServlet

SpringMVC具有统一的入口DispatcherServlet，所有的请求都通过DispatcherServlet。
DispatcherServlet是前置控制器，配置在web.xml文件中的。拦截匹配的请求，Servlet拦截匹配规则要自已定义，把拦截下来的请求，依据某某规则分发到目标Controller来处理。 所以我们现在web.xml中加入以下配置：

<!--初始化DispatcherServlet时，该框架在web应用程序WEB-INF目录中寻找一个名为[servlet-名称]-servlet.xml的文件，
并在那里定义相关的Beans，重写在全局中定义的任何Beans-->
<servlet>
<servlet-name>springMybatis</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springMybatis</servlet-name>
<!--所有的的请求，都会被DispatcherServlet处理-->
<url-pattern>/</url-pattern>
</servlet-mapping>

2.静态资源不拦截

如果只配置拦截类似于*.do格式的url，则对静态资源的访问是没有问题的，但是如果配置拦截了所有的请求（如我们上面配置的“/”），就会造成js文件、css文件、图片文件等静态资源无法访问。
一般实现拦截器主要是为了权限管理，主要是拦截一些url请求，所以不对静态资源进行拦截。要过滤掉静态资源一般有两种方式，
第一种是采用<mvc:default-servlet-handler />，（一般Web应用服务器默认的Servlet名称是"default"，所以这里我们激活Tomcat的defaultServlet来处理静态文件，在web.xml里配置如下代码即可：）

<!--　该servlet为tomcat,jetty等容器提供,将静态资源映射从/改为/static/目录，如原来访问　http://localhost/foo.css　,现在http://localhost/static/foo.css　-->
<!--不拦截静态文件-->
<servlet-mapping>
<servlet-name>default</servlet-name>
<url-pattern>/js/*</url-pattern>
<url-pattern>/css/*</url-pattern>
<url-pattern>/images/*</url-pattern>
<url-pattern>/fonts/*</url-pattern>
</servlet-mapping>

Tomcat, Jetty, JBoss, and GlassFish 默认 Servlet的名字 -- "default"
Resin 默认 Servlet的名字 -- "resin-file"
WebLogic 默认 Servlet的名字 -- "FileServlet"
WebSphere 默认 Servlet的名字 -- "SimpleFileServlet"

如果你所有的Web应用服务器的默认Servlet名称不是"default"，则需要通过default-servlet-name属性显示指定：

<mvc:default-servlet-handlerdefault-servlet-name="所使用的Web服务器默认使用的Servlet名称"/>

第二种是采用<mvc:resources />，在springmvc的配置文件中加入以下代码：

<mvc:resourcesmapping="/js/**"location="/static_resources/javascript/"/>
<mvc:resourcesmapping="/styles/**"location="/static_resources/css/"/>
<mvc:resourcesmapping="/images/**"location="/static_resources/images/"/>

3.自定义拦截器

SpringMVC的拦截器HandlerInterceptorAdapter对应提供了三个preHandle，postHandle，afterCompletion方法。preHandle在业务处理器处理请求之前被调用，
postHandle在业务处理器处理请求执行完成后,生成视图之前执行，afterCompletion在DispatcherServlet完全处理完请求后被调用,可用于清理资源等 。所以要想实现自己的权限管理逻辑，需要继承HandlerInterceptorAdapter并重写其三个方法。
首先在springmvc.xml中加入自己定义的拦截器我的实现逻辑CommonInterceptor，

<!--配置拦截器,多个拦截器,顺序执行-->
<mvc:interceptors>
<mvc:interceptor>
<!--匹配的是url路径，如果不配置或/**,将拦截所有的Controller-->
<mvc:mappingpath="/"/>
<mvc:mappingpath="/user/**"/>
<mvc:mappingpath="/test/**"/>
<beanclass="com.alibaba.interceptor.CommonInterceptor"></bean>
</mvc:interceptor>
<!--当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法-->
</mvc:interceptors>

我的拦截逻辑是“在未登录前，任何访问url都跳转到login页面；登录成功后跳转至先前的url”，具体代码如下：

/**
*
*/
packagecom.alibaba.interceptor;

importjavax.servlet.http.HttpServletRequest;
importjavax.servlet.http.HttpServletResponse;

importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
importorg.springframework.web.servlet.ModelAndView;
importorg.springframework.web.servlet.handler.HandlerInterceptorAdapter;

importcom.alibaba.util.RequestUtil;


/**
*@authortfj
*2014-8-1
*/
publicclassCommonInterceptorextendsHandlerInterceptorAdapter{
privatefinalLoggerlog=LoggerFactory.getLogger(CommonInterceptor.class);
publicstaticfinalStringLAST_PAGE="com.alibaba.lastPage";
/*
*利用正则映射到需要拦截的路径

privateStringmappingURL;

publicvoidsetMappingURL(StringmappingURL){
this.mappingURL=mappingURL;
}
*/
/**
*在业务处理器处理请求之前被调用
*如果返回false
*从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链
*如果返回true
*执行下一个拦截器,直到所有的拦截器都执行完毕
*再执行被拦截的Controller
*然后进入拦截器链,
*从最后一个拦截器往回执行所有的postHandle()
*接着再从最后一个拦截器往回执行所有的afterCompletion()
*/
@Override
publicbooleanpreHandle(HttpServletRequestrequest,
HttpServletResponseresponse,Objecthandler)throwsException{
if("GET".equalsIgnoreCase(request.getMethod())){
RequestUtil.saveRequest();
}
log.info("==============执行顺序:1、preHandle================");
StringrequestUri=request.getRequestURI();
StringcontextPath=request.getContextPath();
Stringurl=requestUri.substring(contextPath.length());

log.info("requestUri:"+requestUri);
log.info("contextPath:"+contextPath);
log.info("url:"+url);

Stringusername=(String)request.getSession().getAttribute("user");
if(username==null){
log.info("Interceptor：跳转到login页面！");
request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
returnfalse;
}else
returntrue;
}

/**
*在业务处理器处理请求执行完成后,生成视图之前执行的动作
*可在modelAndView中加入数据，比如当前时间
*/
@Override
publicvoidpostHandle(HttpServletRequestrequest,
HttpServletResponseresponse,Objecthandler,
ModelAndViewmodelAndView)throwsException{
log.info("==============执行顺序:2、postHandle================");
if(modelAndView!=null){//加入当前时间
modelAndView.addObject("var","测试postHandle");
}
}

/**
*在DispatcherServlet完全处理完请求后被调用,可用于清理资源等
*
*当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion()
*/
@Override
publicvoidafterCompletion(HttpServletRequestrequest,
HttpServletResponseresponse,Objecthandler,Exceptionex)
throwsException{
log.info("==============执行顺序:3、afterCompletion================");
}

}

注：上述代码里我写了一个RequestUtil,主要实现获取当前Request、Session对象，保存和加密页面，取出等功能。

至此，拦截器已经实现了，效果如图：

我直接访问/test/hello，会被拦截

登录成功后会跳转至/test/hello对应的页面