Spring MVC 中 HandlerInterceptorAdapter的使用

一般情况下，对来自浏览器的请求的拦截，是利用Filter实现的，这种方式可以实现Bean预处理、后处理。

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

spring为我们提供了org.springframework.web.servlet.handler.HandlerInterceptorAdapter这个适配器，继承此类，可以非常方便的实现自己的拦截器。他有三个方法：

1. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
2. throws Exception {
3. return true;
4. }
5. public void postHandle(
6. HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
7. throws Exception {
8. }
9. public void afterCompletion(
10. HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
11. throws Exception {
12. }

分别实现预处理、后处理（调用了Service并返回ModelAndView，但未进行页面渲染）、返回处理（已经渲染了页面）

在preHandle中，可以进行编码、安全控制等处理；

在postHandle中，有机会修改ModelAndView；

在afterCompletion中，可以根据ex是否为null判断是否发生了异常，进行日志记录。



如果基于xml配置使用Spring MVC，

可以利用SimpleUrlHandlerMapping、BeanNameUrlHandlerMapping进行Url映射（相当于struts的path映射）和拦截请求（注入interceptors），

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

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



一个demo：

在这个例子中，我们假设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. }

这个Controller相当于Struts的DispatchAction



你也可以配置多个拦截器，每个拦截器进行不同的分工. 一般情况下，对来自浏览器的请求的拦截，是利用Filter实现的，这种方式可以实现Bean预处理、后处理。

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

spring为我们提供了org.springframework.web.servlet.handler.HandlerInterceptorAdapter这个适配器，继承此类，可以非常方便的实现自己的拦截器。他有三个方法：

1. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
2. throws Exception {
3. return true;
4. }
5. public void postHandle(
6. HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
7. throws Exception {
8. }
9. public void afterCompletion(
10. HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
11. throws Exception {
12. }

分别实现预处理、后处理（调用了Service并返回ModelAndView，但未进行页面渲染）、返回处理（已经渲染了页面）

在preHandle中，可以进行编码、安全控制等处理；

在postHandle中，有机会修改ModelAndView；

在afterCompletion中，可以根据ex是否为null判断是否发生了异常，进行日志记录。



如果基于xml配置使用Spring MVC，

可以利用SimpleUrlHandlerMapping、BeanNameUrlHandlerMapping进行Url映射（相当于struts的path映射）和拦截请求（注入interceptors），

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

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



一个demo：

在这个例子中，我们假设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. }

这个Controller相当于Struts的DispatchAction



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