博客

Spring Boot 实现自定义拦截器方法：

本篇文章就来讲讲拦截器，Spring Boot 中拦截器的注册还是比较方便的。就是下面两个步骤：

1.实现 HandlerInterceptor 接口创建拦截器

2.实现 WebMvcConfigurer 接口配置拦截器

1.第一步创建一个类实现 HandlerInterceptor，重写接口方法，添加 @Component 注解，注入spring容器。

package com.example.interceptor;

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

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

@Component
public class MyHandlerInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        /**
         * 预处理回调方法，实现处理器的预处理（如检查登陆），第三个参数为响应的处理器，自定义Controller
         * 返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），
         * 不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；
         */
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        /**
         * 后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）
         * 对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
         */
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        /**
         * 整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，
         * 还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中
         */
    }
}

2.第二步，创建一个类实现 WebMvcConfigurer 接口，重写 addInterceptors 方法，添加 @Configuration 注解，声明这是一个配置类

package com.example.config;

import com.example.cache.interceptor.RedisCacheInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration      //声明这是一个配置类
public class WebConfig implements WebMvcConfigurer {

    @Autowired
    private MyHandlerInterceptor myHandlerInterceptor ;

    /**
     * 声明拦截器拦截规则        /** ：拦截所有
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注意拦截器的顺序
        registry.addInterceptor(this.myHandlerInterceptor ).addPathPatterns("/**");
    }
}

3.到这里已经实现了自定义拦截器