SpringBoot 拦截器

发布于:2023-01-02 ⋅ 阅读:(562) ⋅ 点赞:(0)

个人博客地址:
http://xiaohe-blog.top

1. 什么是拦截器

拦截器就是对于将要进入 controller 的请求进行拦截,可以进行用户校验。它的底层其实就是aop。

拦截器类似于javaweb中学习的过滤器,但是二者有很大的区别。

拦截器特点 :

  1. 拦截器只能拦截通过 controller 的请求。
  2. 拦截器可以中断请求轨迹。
  3. 请求执行前经过拦截器,请求执行后还经过拦截器。

(前后端不分离:)

image-20220901104150161

2. 拦截器实现

SpringMVC拦截器的实现步骤 :实现HandlerInterceptor接口、配置拦截器。

SpringBoot无需进行配置,实现 HandlerInterceptor接口,将拦截器加入 WebMvcConfigrer

所以实现拦截器共分为两步:

  1. 实现HandlerInterceptor接口。
  2. 将其加入WevMvcConfigrer

2.1 HandlerInterceptor

(SpringMVC已经学过,这里就不做讲解了)

@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器执行..preHandle");
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) 
            throws Exception {
        System.out.println("拦截器执行..postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) 
            throws Exception {
        System.out.println("拦截器执行..afterCompletion");
    }
}
image-20220901104825185

2.2 WebMvcConfigrer

它是一个配置类,需要加 @Configuration 注解,怎么将拦截器加入呢 ?它有一个方法 addInterceptors(InterceptorRegistry registry)。registry 就是拦截器的注册。调用它的 addInterceptor(拦截器对象),将拦截其注入。

使用 addPathPattern(String path)来确定拦截路径;

使用 excludePathPattern(String path) 确定哪些路径不拦截。

@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private HandlerInterceptor interceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(interceptor) // 注册拦截器
                .addPathPattern("/**"); // 确认拦截路径
    }
}

2.3 代码实现

我想,springboot学习拦截器的目的就是做登录校验吧?所以这里使用登录校验的例子来实现拦截器。

我们想要对进入controller 的请求进行拦截,判断是否登录:

如果已经登录就可以访问;

如果没有登陆,返回登陆界面;

  1. 拦截器
@Component
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        User user = request.getSession().getAttribute("user");
        if (user != null) {
            // 已登录,放行
            return true;
        } else {
            // 未登录,嘎掉
            response.sendRedirect("登陆界面");
            return false;
        }
    }
}
  1. 拦截器配置类
@Configuration
public class MyWebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private HandlerInterceptor interceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(interceptor) // 注册拦截器
                .addPathPattern("/**")
                .excludePathPattern("/user/login"); 
        // 不拦截登录的controller, 因为这个就是处理用户登录的.
    }
}

如果你写了多个拦截器,执行顺序如图所示 :遵守123、321、321 的规则。

registry.addInterceptor(拦截器1);
registry.addInterceptor(拦截器2);
registry.addInterceptor(拦截器3);
image-20220901103912710

当然,可以指定拦截器的执行顺序,使用 order(int) ,数字越小,执行越早

registry.addInterceptor(拦截器1).order(3);
registry.addInterceptor(拦截器2).order(2);
registry.addInterceptor(拦截器3).order(1);

3. 拦截器与过滤器的区别

过滤器和拦截器都体现了 aop 的思想,都可以实现登陆验证等功能,但是二者有很大区别。

  1. 适用范围不同

过滤器依赖于 servlet,其生命周期由 服务器 管理;

拦截器依赖于 Spring ,其生命周期由 Spring 管理。

  1. 实现原理不同

过滤器基于 函数回调 实现;

拦截器基于 aop 实现。

  1. 拦截的请求不同

过滤器全部拦截

拦截器最多拦截 controller。

  1. 执行规则不同

过滤器不指定 order ,按照 Filter 名字字典序执行

拦截器不指定 order ,按照 配置顺序 执行


网站公告

今日签到

点亮在社区的每一天
去签到