springboot 自定义拦截器

2023-11-13 20:45:10

在 springmvc 处理 web 请求时，调用 HandlerMapper 返回的 Handler 对象，是通过 HandlerExecutionChain 对象进行封装的。HandlerExecutionChain 是一个数据载体，它包含两方面的数据，一个就是用于处理 Web 请求的 Handler，另一个则是一组随同 Handler 一起返回的 HandlerInterceptor。

HandlerInterceptor 就是我们常说的拦截器，可以在 Handler 的执行前后对处理流程进行拦截操作。

HandlerInterceptor 的源码如下：

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }

    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

三个方法简单说明。

boolean preHandle(..) ：该拦截方法在响应的 Handler 处理 web 请求之前执行，也是我们用得最多的拦截方法。返回值是一个 boolean ，返回 true 表明允许后继处理流程继续执行，返回 false 表明不允许后继流程继续执行。当然，抛出相应异常的方式也可以达到与返回 false 同样的阻断效果。
void postHandle(..) ：在Handler 处理完 web 请求之后，并且在视图的解析和渲染之前执行。通过该方法我们可以获取 Handler 执行后的 ModelAndView。返回值是 void，不可以阻断后继处理流程。
void afterCompletion(..) ：在框架内整个处理流程结束之后，不管是否发生异常，该方法都将被执行。如果是异常结束的话，可以在该方法中获得异常（Exception）的引用并对其进行统一处理。另外，如果 web 请求处理过程中有相应资源需要清理的话，可以在这里完成。

例子

这里 springboot 的环境是 2.4.4

1.编写自定义的拦截器实现类，实现接口 HandlerInterceptor

import org.springframework.web.servlet.HandlerInterceptor;

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

/**
 * 自定义拦截器
 * Create by Lusl  2021/5/31
 */
public class MyHandler implements HandlerInterceptor {

    /**
     * 这里只对 preHandle 进行处理
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("************************");
        System.out.println("hello， this is custom Interceptor");
        System.out.println("************************");
        return true;
    }
}

上面我们自定义的拦截器，但是 springmvc 对这个是识别不了的，我们还要将自定义的拦截器注册到拦截器配置当中。

2.编写拦截器配置类，继承 WebMvcConfigurer 类并重写 addInterceptors(..) 方法

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * 注册自定义的拦截器
 * Create by Lusl  2021/5/31
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注册 MyHandler 拦截器
        InterceptorRegistration addInterceptor = registry.addInterceptor(new MyHandler());
        //  /**表示拦截所有请求
        addInterceptor.addPathPatterns("/**");
        // 放行下面的请求，一般是静态资源
        addInterceptor.excludePathPatterns("/login","/static/**");
    }
}

对于需要拦截的路径和需要放行的路径，根据需要自行添加

然后再随便写一个 Controller 去获取请求

@Controller
public class BaseController {

    @GetMapping("/")
    public String toPage() {
        return "login";
    }
}

项目启动并执行请求之后，控制台会输出我们拦截的内容：

码农公寓

相关文章