SpringMVC拦截器

在项目开发后期,为了扩展系统功能,比如写日志,事务管理,权限校验等系统功能与业务功能没有太大关联,扩展系统功能时不能修改业务类的代码

实现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 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

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

定义一个实现 HandlerInterceptor 接口的类

public class AccessInterceptor implements HandlerInterceptor {
    /**
     * 在处理方法之前执行,一般用来做一些准备工作:比如日志,权限检查
     * 如果返回false 表示被拦截,将不会执行处理方法
     * 返回true继续执行处理方法
     */
    @Override
    public boolean preHandle(HttpServletRequest req, HttpServletResponse resp, Object handler) throws Exception {
        System.out.println("执行preHandler---------"+req.getRemoteHost()+req.getRemoteUser());
        return true;
    }
    /**
     * 在处理方法执行之后,在渲染视图执行之前执行,一般用来做一些清理工作
     */
    @Override
    public void postHandle(HttpServletRequest req, HttpServletResponse resp, Object handler, ModelAndView mv)
            throws Exception {
        System.out.println("执行postHandler");
    }
    /**
     * 在视图渲染后执行  一般用来释放资源
     */
    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("执行afterCompletion");
    }
}

在 springmvc 的配置文件中 ,添加拦截器配置

     
     
        
        
            
            
            
        
        
     

补充

只能映射某些需要拦截的请求,而用来排除某些特定的请求映射。当我们需要拦截的请求映射是比较通用的,但是其中又包含了某个特殊的请求是不需要使用该拦截器的时候我们就可以把它定义为exclude-mapping了。比如像下面示例这样,我们定义的拦截器将拦截所有匹配/interceptor/**模式的请求,但是不能拦截请求“/interceptor/b”,因为它定义为了exclude-mapping。当定义了exclude-mapping时,Spring MVC将优先判断一个请求是否在execlude-mapping定义的范围内,如果在则不进行拦截。


    
        
        
        
        
    

虽然笔者的示例中interceptor下面定义的mapping只有一个,但实际上一个interceptor下面定义的mapping和exclude-mapping都是可以有多个的。
另外,exclude-mapping的定义规则和mapping的定义规则是一样的,我们也可以使用一个星号表示任意字符,使用两个星号表示任意层次的任意字符。比如下面这样。


    
        
        
        
        
    

你可能感兴趣的:(SpringMVC拦截器)