SpringMVC处理器拦截器 Interceptor

2023-11-11 20:23:04

拦截器概念

　　Java 里的拦截器是动态拦截action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码，也可以在一个action执行前阻止其执行，同时也提供了一种可以提取action中可重用部分的方式。在 AOP（Aspect-Oriented Programming，面向切面编程）中拦截器用于在某个方法（包括构造器）或字段被访问之前进行拦截，然后在之前或之后加入某些操作。特别地，现阶段 Spring 自身仅支持基于方法的拦截操作！如果基于方法的拦截操作不能满足需求，可以使用 AspectJ 与 Spring 进行集成，以实现更细粒度或更多方面的拦截操作。

常见应用场景　

　　1、日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。

　　2、权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；

　　3、性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；

　　4、通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。

　　5、OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。

　　…………本质也是AOP（面向切面编程），也就是说符合横切关注点的所有功能都可以放入拦截器实现。

拦截器接口（通过实现HandlerInterceptor接口, 一般通过继承HandlerInterceptorAdapter抽象类实现。）

package org.springframework.web.servlet;  
public interface HandlerInterceptor {  
    boolean preHandle(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler)   
            throws Exception;  
  
    void postHandle(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler, ModelAndView modelAndView)   
            throws Exception;  
  
    void afterCompletion(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler, Exception ex)  
            throws Exception;  
}

preHandle：预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器（如我们上一章的Controller实现）；

　返回值：true表示继续流程（如调用下一个拦截器或处理器）；

　　　　　　false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；

postHandle：后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

afterCompletion：整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。

实战代码：

工程结构

springmvc.xml spring的配置

定义三个拦截器 AllInterceptor 是全局拦截器， Interceptor1、 Interceptor2是独立的拦截器使用

package com.spring.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

public class AllInterceptor extends HandlerInterceptorAdapter{
    @Override  
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
        System.out.println("===========AllInterceptor preHandle");  
        return true;  
    }  
    @Override  
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  
        System.out.println("===========AllInterceptor postHandle");  
    }  
    @Override  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  
        System.out.println("===========AllInterceptor afterCompletion");  
    }  
}

package com.spring.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

public class Interceptor1 extends HandlerInterceptorAdapter{
    @Override  
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
        System.out.println("===========Interceptor1 preHandle");  
        return true;  
    }  
    @Override  
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  
        System.out.println("===========Interceptor1 postHandle");  
    }  
    @Override  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  
        System.out.println("===========Interceptor1 afterCompletion");  
    } 
}

package com.spring.interceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

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

public class Interceptor2 extends HandlerInterceptorAdapter{
    @Override  
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
        System.out.println("===========Interceptor2 preHandle");  
        return true;  
    }  
    @Override  
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  
        System.out.println("===========Interceptor2 postHandle");  
    }  
    @Override  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  
        System.out.println("===========Interceptor2 afterCompletion");  
    } 
}

Controller层 TestController1.java

package com.spring.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("interceptor")
public class TestController1 {

    @RequestMapping("test1")
    public void test1() {
        System.out.println("Controller test1 !");
    }
    
    @RequestMapping("test2")
    public void test2() {
        System.out.println("Controller test2 !");
    }
}

spring相关配置

<!-- 扫描含有@Controller注解 -->
    <context:component-scan base-package="com.spring.controller">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

<!-- 使用mvc:interceptors标签来声明需要加入到SpringMVC拦截器链中的拦截器 -->
    <mvc:interceptors>  
        <!-- 使用bean定义一个Interceptor，直接定义在mvc:interceptors根下面的Interceptor将拦截所有的请求 -->  
        <bean class="com.spring.interceptor.AllInterceptor"/>  
        <mvc:interceptor>  
            <mvc:mapping path="/interceptor/test1"/>  
            <!-- 定义在mvc:interceptor下面的表示是对特定的请求才进行拦截的 -->  
            <bean class="com.spring.interceptor.Interceptor1"/>  
        </mvc:interceptor>  
        <mvc:interceptor>  
            <mvc:mapping path="/interceptor/test2"/>  
            <bean class="com.spring.interceptor.Interceptor2"/>  
        </mvc:interceptor> 
    </mvc:interceptors>

测试结果：

url: http://localhost:8080/dynamicdatasource/interceptor/test1

url: http://localhost:8080/dynamicdatasource/interceptor/test2

另外对已拦截器的配置，有时候需要是对全部请求url进行拦截，有时候对一些url不进行拦截，可以采用下面几种方式；

<mvc:interceptors>
        <bean id="allInterceptor" class="com.base.interceptor.AllInterceptor"/>
        <mvc:interceptor>
            <mvc:mapping path="/*/**" />
            <bean id="CommonInterceptor" class="com.base.interceptor.CommonInterceptor"/>
        </mvc:interceptor>   
        <mvc:interceptor>
            <mvc:mapping path="/dical/**"/> //拦截的url
            <mvc:mapping path="/admin/**"/>//拦截的url
            <mvc:exclude-mapping path="/admin/login"/> //不拦截的url
            <mvc:exclude-mapping path="/admin/main"/>//不拦截的url
                <bean id="DicalInterceptor" class="com.base.interceptor.DicalInterceptor"/>
        </mvc:interceptor>

</mvc:interceptors>

或者：

<mvc:interceptors>
         <mvc:interceptor>
             <mvc:mapping path="/**"/>
             <mvc:exclude-mapping path="/bank/modifCode/**"/>
             <mvc:exclude-mapping path="/bank/tialize/**"/>
             <mvc:exclude-mapping path="/bank/**"/>
             <bean class="com.intercr.MthoduestIneptor" />
         </mvc:interceptor>
    </mvc:interceptors>

说明：

　　1）mvc:mapping 拦截器路径配置

　　2）mvc:exclude-mapping 拦截器不需要拦截的路径

码农公寓

拦截器概念

常见应用场景

拦截器接口（ 通过实现HandlerInterceptor接口, 一般通过继承HandlerInterceptorAdapter抽象类实现。）

相关文章

常见应用场景　

拦截器接口（通过实现HandlerInterceptor接口, 一般通过继承HandlerInterceptorAdapter抽象类实现。）