【转载】Spring MVC中的拦截器/过滤器HandlerInterceptorAdapter的使用

转载自 https://www.cnblogs.com/EasonJim/p/7704740.html

一般情况下，对来自浏览器的请求的拦截，是利用Filter实现的

而在Spring中，基于Filter这种方式可以实现Bean预处理、后处理。 比如注入FilterRegistrationBean，然后在这个Bean上传递自己继承Filter实现的自定义Filter进入即可。

而Spring MVC也有拦截器，不仅可实现Filter的所有功能，还可以更精确的控制拦截精度。 

Spring MVC提供的org.springframework.web.servlet.handler.HandlerInterceptorAdapter这个适配器，继承此类，可以非常方便的实现自己的拦截器。

它有三个方法：

1. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception {

2. return true;

3. }

4. public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception {

5. }

6. public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception {

7. }

preHandle在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制等处理； 

postHandle在业务处理器处理请求执行完成后，生成视图之前执行。后处理（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView； 

afterCompletion在DispatcherServlet完全处理完请求后被调用，可用于清理资源等。返回处理（已经渲染了页面），可以根据ex是否为null判断是否发生了异常，进行日志记录；

如果基于XML配置使用Spring MVC，可以利用SimpleUrlHandlerMapping、BeanNameUrlHandlerMapping进行Url映射（相当于struts的path映射）和拦截请求（注入interceptors）。

如果基于注解使用Spring MVC，可以使用DefaultAnnotationHandlerMapping注入interceptors。

注意无论基于XML还是基于注解，HandlerMapping Bean都是需要在XML中配置的。 

示例一：

在这个例子中，我们假设UserController中的注册操作只在9:00-12:00开放，那么就可以使用拦截器实现这个功能。 

1. public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {

2. private int openingTime;

3. private int closingTime;

4. private String mappingURL;//利用正则映射到需要拦截的路径

5. public void setOpeningTime(int openingTime) {

6. this.openingTime = openingTime;

7. }

8. public void setClosingTime(int closingTime) {

9. this.closingTime = closingTime;

10. }

11. public void setMappingURL(String mappingURL) {

12. this.mappingURL = mappingURL;

13. }

14. @Override

15. public boolean preHandle(HttpServletRequest request,

16. HttpServletResponse response, Object handler) throws Exception {

17. String url=request.getRequestURL().toString();

18. if(mappingURL==null || url.matches(mappingURL)){

19. Calendar c=Calendar.getInstance();

20. c.setTime(new Date());

21. int now=c.get(Calendar.HOUR_OF_DAY);

22. if(now<openingTime || now>closingTime){

23. request.setAttribute("msg", "注册开放时间：9：00-12：00");

24. request.getRequestDispatcher("/msg.jsp").forward(request, response);

25. return false;

26. }

27. return true;

28. }

29. return true;

30. }

31. }

XML配置：

1. <bean id="timeBasedAccessInterceptor" class="com.spring.handler.TimeBasedAccessInterceptor">

2. <property name="openingTime" value="9" />

3. <property name="closingTime" value="12" />

4. <property name="mappingURL" value=".*/user\.do\?action=reg.*" />

5. </bean>

6. <bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">

7. <property name="interceptors">

8. <list>

9. <ref bean="timeBasedAccessInterceptor"/>

10. </list>

11. </property>

12. </bean>

这里我们定义了一个mappingURL属性，实现利用正则表达式对url进行匹配，从而更细粒度的进行拦截。当然如果不定义mappingURL，则默认拦截所有对Controller的请求。 

UserController:

1. @Controller

2. @RequestMapping("/user.do")

3. public class UserController{

4. @Autowired

5. private UserService userService;

6. @RequestMapping(params="action=reg")

7. public ModelAndView reg(Users user) throws Exception {

8. userService.addUser(user);

9. return new ModelAndView("profile","user",user);

10. }

11. // other option ...

12. }

也可以配置多个拦截器，每个拦截器进行不同的分工。

示例二：

主要是XML配置不一样

1. <!--配置拦截器, 多个拦截器,顺序执行 -->

2. <mvc:interceptors>

3. <mvc:interceptor>

4. <!-- 匹配的是url路径， 如果不配置或/**,将拦截所有的Controller -->

5. <mvc:mapping path="/" />

6. <mvc:mapping path="/user/**" />

7. <mvc:mapping path="/test/**" />

8. <bean class="com.alibaba.interceptor.CommonInterceptor"></bean>

9. </mvc:interceptor>

10. <!-- 当设置多个拦截器时，先按顺序调用preHandle方法，然后逆序调用每个拦截器的postHandle和afterCompletion方法 -->

11. </mvc:interceptors>

1. package com.alibaba.interceptor;

2.  

3. import javax.servlet.http.HttpServletRequest;

4. import javax.servlet.http.HttpServletResponse;

5.  

6. import org.slf4j.Logger;

7. import org.slf4j.LoggerFactory;

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

9. import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

10.  

11. import com.alibaba.util.RequestUtil;

12.  

13. public class CommonInterceptor extends HandlerInterceptorAdapter{

14. private final Logger log = LoggerFactory.getLogger(CommonInterceptor.class);

15. public static final String LAST_PAGE = "com.alibaba.lastPage";

16. /*

17. * 利用正则映射到需要拦截的路径

18.  

19. private String mappingURL;

20.  

21. public void setMappingURL(String mappingURL) {

22. this.mappingURL = mappingURL;

23. }

24. */

25. /**

26. * 在业务处理器处理请求之前被调用

27. * 如果返回false

28. * 从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链

29. * 如果返回true

30. * 执行下一个拦截器,直到所有的拦截器都执行完毕

31. * 再执行被拦截的Controller

32. * 然后进入拦截器链,

33. * 从最后一个拦截器往回执行所有的postHandle()

34. * 接着再从最后一个拦截器往回执行所有的afterCompletion()

35. */

36. @Override

37. public boolean preHandle(HttpServletRequest request,

38. HttpServletResponse response, Object handler) throws Exception {

39. if ("GET".equalsIgnoreCase(request.getMethod())) {

40. RequestUtil.saveRequest();

41. }

42. log.info("==============执行顺序: 1、preHandle================");

43. String requestUri = request.getRequestURI();

44. String contextPath = request.getContextPath();

45. String url = requestUri.substring(contextPath.length());

46.  

47. log.info("requestUri:"+requestUri);

48. log.info("contextPath:"+contextPath);

49. log.info("url:"+url);

50.  

51. String username = (String)request.getSession().getAttribute("user");

52. if(username == null){

53. log.info("Interceptor：跳转到login页面！");

54. request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);

55. return false;

56. }else

57. return true;

58. }

59.  

60. /**

61. * 在业务处理器处理请求执行完成后,生成视图之前执行的动作

62. * 可在modelAndView中加入数据，比如当前时间

63. */

64. @Override

65. public void postHandle(HttpServletRequest request,

66. HttpServletResponse response, Object handler,

67. ModelAndView modelAndView) throws Exception {

68. log.info("==============执行顺序: 2、postHandle================");

69. if(modelAndView != null){ //加入当前时间

70. modelAndView.addObject("var", "测试postHandle");

71. }

72. }

73.  

74. /**

75. * 在DispatcherServlet完全处理完请求后被调用,可用于清理资源等

76. *

77. * 当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion()

78. */

79. @Override

80. public void afterCompletion(HttpServletRequest request,

81. HttpServletResponse response, Object handler, Exception ex)

82. throws Exception {

83. log.info("==============执行顺序: 3、afterCompletion================");

84. }

85.  

86. }

 

参考：

http://blog.csdn.net/liuwenbo0920/article/details/7283757（以上内容部分转自此篇文章）

http://www.cnblogs.com/xingele0917/p/4318008.html

http://blog.csdn.net/ye_sheng/article/details/48395663 （以上内容部分转自此篇文章）