SpringMVC-拦截器

文章目录

• • • 1、拦截器的配置
    • 2、拦截器的三个抽象方法
    • 3、多个拦截器的执行顺序

Spring MVC 中的拦截器（Interceptor）是一种强大的机制，用于拦截请求和响应。它允许开发者在请求处理的不同阶段执行预处理和后处理操作，比如日志记录、权限检查、国际化等。以下是关于 Spring MVC 拦截器的基本概念和用法：

1. 拦截器的作用
   拦截器主要用于以下场景：

日志记录：记录请求的详细信息，如请求时间、请求参数等。
权限检查：验证用户是否有权限访问特定资源。
跨域请求处理：处理跨域请求，添加必要的头部信息。
国际化处理：根据请求的语言设置响应的语言环境。
2. 实现拦截器
要实现一个拦截器，需要创建一个类并实现 Spring 的 HandlerInterceptor 接口，它包括了三个方法：

preHandle：在请求处理之前调用，返回 true 继续处理请求链，返回 false 中断请求链。
postHandle：在请求处理之后、视图渲染之前调用。
afterCompletion：在整个请求完成后调用，包括视图渲染完成后。

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在请求处理之前进行调用，返回true则继续处理请求，返回false则中断请求
        System.out.println("请求处理之前，URI: " + request.getRequestURI());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 在请求处理之后，视图渲染之前进行调用
        System.out.println("请求处理之后，准备渲染视图");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 在整个请求完成之后进行调用，包括视图渲染完成后
        System.out.println("请求处理完成");
    }
}

3. 配置拦截器
   在 Spring MVC 的配置文件中（通常是 dispatcher-servlet.xml 或通过 Java 配置类），将拦截器注册到拦截器链中：

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/**"/> <!-- 可以指定拦截的路径 -->
        <bean class="com.example.CustomInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

4. 多个拦截器的执行顺序
   如果有多个拦截器，它们按照声明的顺序依次执行 preHandle 方法，但逆序执行 postHandle 和 afterCompletion 方法。

1、拦截器的配置

SpringMVC中的拦截器用于拦截控制器方法的执行
SpringMVC中的拦截器需要实现HandlerInterceptor
SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置：

<bean class="com.interceptor.FirstInterceptor"></bean>
<ref bean="firstInterceptor"></ref>
<!-- 以上两种配置方式都是对DispatcherServlet所处理的所有的请求进行拦截 -->
<mvc:interceptor>
    <mvc:mapping path="/**"/>
    <mvc:exclude-mapping path="/testRequestEntity"/>
    <ref bean="firstInterceptor"></ref>
</mvc:interceptor>
<!-- 
	以上配置方式可以通过ref或bean标签设置拦截器，通过mvc:mapping设置需要拦截的请求，通过mvc:exclude-mapping设置需要排除的请求，即不需要拦截的请求
-->

2、拦截器的三个抽象方法

SpringMVC中的拦截器有三个抽象方法：
preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示是否拦截或放行，返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法
postHandle：控制器方法执行之后执行postHandle()
afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()

3、多个拦截器的执行顺序

a>若每个拦截器的preHandle()都返回true
此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：
preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行

b>若某个拦截器的preHandle()返回了false
preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false的拦截器之前的拦截器的afterComplation()会执行