Spring MVC中的拦截器/过滤器HandlerInterceptorAdapter的使用

╰半橙微兮° 2022-05-15 01:58 318阅读 0赞

转载自 [https://www.cnblogs.com/EasonJim/p/7704740.html][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这个适配器，继承此类，可以非常方便的实现自己的拦截器。

它有三个方法：

![复制代码][copycode.gif]

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception {    
            return true;    
    }    
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception {    
    }    
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception {    
    }

![复制代码][copycode.gif]

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开放，那么就可以使用拦截器实现这个功能。

![复制代码][copycode.gif]

public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {  
        private int openingTime;  
        private int closingTime;  
        private String mappingURL;//利用正则映射到需要拦截的路径  
        public void setOpeningTime(int openingTime) {  
            this.openingTime = openingTime;  
        }  
        public void setClosingTime(int closingTime) {  
            this.closingTime = closingTime;  
        }  
        public void setMappingURL(String mappingURL) {  
            this.mappingURL = mappingURL;  
        }  
        @Override  
        public boolean preHandle(HttpServletRequest request,  
                HttpServletResponse response, Object handler) throws Exception {  
            String url=request.getRequestURL().toString();  
            if(mappingURL==null || url.matches(mappingURL)){  
                Calendar c=Calendar.getInstance();  
                c.setTime(new Date());  
                int now=c.get(Calendar.HOUR_OF_DAY);  
                if(now<openingTime || now>closingTime){  
                    request.setAttribute("msg", "注册开放时间：9：00-12：00");  
                    request.getRequestDispatcher("/msg.jsp").forward(request, response);  
                    return false;  
                }  
                return true;  
            }  
            return true;  
        }  
    }

![复制代码][copycode.gif]

XML配置：

![复制代码][copycode.gif]

![复制代码][copycode.gif]

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

UserController:

![复制代码][copycode.gif]

@Controller    
    @RequestMapping("/user.do")    
    public class UserController{    
        @Autowired    
        private UserService userService;    
        @RequestMapping(params="action=reg")    
        public ModelAndView reg(Users user) throws Exception {    
            userService.addUser(user);    
            return new ModelAndView("profile","user",user);    
        }    
        // other option ...    
    }

![复制代码][copycode.gif]

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

示例二：

主要是XML配置不一样

![复制代码][copycode.gif]

<mvc:interceptors>    
        <mvc:interceptor>    
              
            <mvc:mapping path="/" />  
            <mvc:mapping path="/user/**" />  
            <mvc:mapping path="/test/**" />  
            <bean class="com.alibaba.interceptor.CommonInterceptor"></bean>    
        </mvc:interceptor>  
          
    </mvc:interceptors>

![复制代码][copycode.gif]

package com.alibaba.interceptor;  
      
    import javax.servlet.http.HttpServletRequest;  
    import javax.servlet.http.HttpServletResponse;  
      
    import org.slf4j.Logger;  
    import org.slf4j.LoggerFactory;  
    import org.springframework.web.servlet.ModelAndView;  
    import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;  
      
    import com.alibaba.util.RequestUtil;  
      
    public class CommonInterceptor extends HandlerInterceptorAdapter{  
        private final Logger log = LoggerFactory.getLogger(CommonInterceptor.class);  
        public static final String LAST_PAGE = "com.alibaba.lastPage";  
        /* 
         * 利用正则映射到需要拦截的路径     
          
        private String mappingURL; 
         
        public void setMappingURL(String mappingURL) {     
                   this.mappingURL = mappingURL;     
        }    
      */  
        /**  
         * 在业务处理器处理请求之前被调用  
         * 如果返回false  
         *     从当前的拦截器往回执行所有拦截器的afterCompletion(),再退出拦截器链 
         * 如果返回true  
         *    执行下一个拦截器,直到所有的拦截器都执行完毕  
         *    再执行被拦截的Controller  
         *    然后进入拦截器链,  
         *    从最后一个拦截器往回执行所有的postHandle()  
         *    接着再从最后一个拦截器往回执行所有的afterCompletion()  
         */    
        @Override    
        public boolean preHandle(HttpServletRequest request,    
                HttpServletResponse response, Object handler) throws Exception {    
            if ("GET".equalsIgnoreCase(request.getMethod())) {  
                RequestUtil.saveRequest();  
            }  
            log.info("==============执行顺序: 1、preHandle================");    
            String requestUri = request.getRequestURI();  
            String contextPath = request.getContextPath();  
            String url = requestUri.substring(contextPath.length());  
            
            log.info("requestUri:"+requestUri);    
            log.info("contextPath:"+contextPath);    
            log.info("url:"+url);    
              
            String username =  (String)request.getSession().getAttribute("user");   
            if(username == null){  
                log.info("Interceptor：跳转到login页面！");  
                request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);  
                return false;  
            }else  
                return true;     
        }    
        
        /** 
         * 在业务处理器处理请求执行完成后,生成视图之前执行的动作    
         * 可在modelAndView中加入数据，比如当前时间 
         */  
        @Override    
        public void postHandle(HttpServletRequest request,    
                HttpServletResponse response, Object handler,    
                ModelAndView modelAndView) throws Exception {     
            log.info("==============执行顺序: 2、postHandle================");    
            if(modelAndView != null){  //加入当前时间    
                modelAndView.addObject("var", "测试postHandle");    
            }    
        }    
        
        /**  
         * 在DispatcherServlet完全处理完请求后被调用,可用于清理资源等   
         *   
         * 当有拦截器抛出异常时,会从当前拦截器往回执行所有的拦截器的afterCompletion()  
         */    
        @Override    
        public void afterCompletion(HttpServletRequest request,    
                HttpServletResponse response, Object handler, Exception ex)    
                throws Exception {    
            log.info("==============执行顺序: 3、afterCompletion================");    
        }    
      
    }

![复制代码][copycode.gif]

参考：

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

[http://www.cnblogs.com/xingele0917/p/4318008.html][http_www.cnblogs.com_xingele0917_p_4318008.html]

[http://blog.csdn.net/ye\_sheng/article/details/48395663 ][http_blog.csdn.net_ye_sheng_article_details_48395663]（以上内容部分转自此篇文章）

[https_www.cnblogs.com_EasonJim_p_7704740.html]: https://www.cnblogs.com/EasonJim/p/7704740.html
[copycode.gif]: /images/20220515/ffad2a9da8dc4d7da9218810086df35d.png
[http_blog.csdn.net_liuwenbo0920_article_details_7283757]: http://blog.csdn.net/liuwenbo0920/article/details/7283757
[http_www.cnblogs.com_xingele0917_p_4318008.html]: http://www.cnblogs.com/xingele0917/p/4318008.html
[http_blog.csdn.net_ye_sheng_article_details_48395663]: http://blog.csdn.net/ye_sheng/article/details/48395663