Spring MVC 拦截器

Posted 2022-12-10 Do_GH

Spring MVC集成的拦截器功能与Servlet的Filter功能相类似，拦截器主要是对请求过程的前后进行过滤，底层基于Spring AOP的切面技术。

引入Maven依赖

由于拦截器的实现需要拦截HTTP请求所以需要引入javax.servlet-api的jar包，但是在发布时Tomcat中集成了该jar包，所以可以设置jar包的使用范围在打包时不再对该jar包进行打包。

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.2.14.RELEASE</version>
</dependency>
<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
    <scope>provided</scope>
</dependency>

创建拦截器

拦截器都需要实现HandlerInterceptor接口，该接口需要实现三个方法：

• public boolean preHandler(HttpServletRequest request, HttpServletResponse response, Object handler)：该方法主要在请求处理开始前进行处理，返回布尔类型，当返回true时则继续处理请求，当返回false时则不再继续处理请求。
• public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)：该方法在请求处理后，响应生成前执行。
• public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)：该方法在响应生成后执行。

示例：

package com.restful.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

public class TestInterceptor implements HandlerInterceptor 
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        System.out.println(request.getRequestURL() + "-请求处理前执行");
        return true;
    

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception 
        System.out.println(request.getRequestURL() + "-产生响应前执行");
    

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception 
        System.out.println(request.getRequestURL() + "-产生响应后执行");
    

添加配置

拦截器创建成功后，需要在Spring配置文件中添加全局配置，示例：

<!-- 添加拦截器 -->
<mvc:interceptors>
    <mvc:interceptor>
        <!-- 拦截restful后的所有请求 -->
        <mvc:mapping path="/restful/**"/>
        <mvc:exclude-mapping path="/**.js"/>
        <mvc:exclude-mapping path="/**.css"/>
        <mvc:exclude-mapping path="/**.jpg"/>
        <bean class="com.restful.interceptor.TestInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

如果需要配置多个拦截器可以再次书写<mvc:interceptors>标签，

• <mvc:mapping path="" />标签主要指定拦截器需要拦截的URL地址，可以使用通配符*
• <mvc:exclude-mapping path=""/>标签描述需要排除拦截的资源路径，例如一些静态资源CSS，JS和一些图片资源。设置后当前端请求静态资源时不会再使用拦截器进行过滤
• <bean class=""/>标签指定拦截器的类

如果对一个地址存在多个拦截器会按照配置的顺序前置方法进行逐个拦截，而对于后置拦截方法则会按照反向的顺序进行拦截。