JavaWeb-Springboot-拦截器【Interceptor】

---

一、概述

• 拦截器是一种动态拦截方法调用的机制，类似于过滤器【Filter】，由Spring框架提供的，用来动态拦截控制器方法的执行。
• 作用：拦截请求，在指定的方法调用前后，根据业务需要执行预先设定的代码

二、快速入门

• 定义拦截器

实现HandlerInterceptor接口，并重写其所有方法。

• 注册拦截器

定义拦截器：实现 HandlerInterceptor 接口

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

@Slf4j
@Component
public class LoginCheckInterceptor implements HandlerInterceptor {
    @Override  // 目标方法执行前执行：true 放行 false 不放行
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("preHandle ---> 运行了！！！");
        return true;
    }

    @Override // 目标方法执行后执行
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle ---> 运行了！！！");
    }

    @Override // 视图渲染完毕后执行，最后执行
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion ---> 运行了！！！");
    }
}

注册拦截器：实现 WebMvcConfigurer 接口，增加 @Configuration 注解

import com.ming.interceptor.LoginCheckInterceptor;
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 LoginCheckInterceptor loginCheckInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册拦截器，并增加拦截资源
        registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");
    }
}

三、详解

3.1 拦截路径配置

3.2 执行流程

四、过滤器与拦截器的区别

• 接口规范不同：过滤器需要实现Filter接口，而拦截器需要实现HandlerInterceptor接口。
• 拦截范围不同：过滤器Filter会拦截所有的资源，而Interceptor只会拦截Spring环境中的资源。

五、登录校验

import com.alibaba.fastjson.JSONObject;
import com.ming.pojo.Result;
import com.ming.utils.JwtUtils;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

@Slf4j
@Component
public class LoginCheckInterceptor implements HandlerInterceptor {
    @Override  // 目标方法执行前执行：true 放行 false 不放行
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        // 1. 获取请求的URL
        String url = request.getRequestURI();
        log.info("请求的URL ---> {}！！！", url);

        // 2. 判断URL中是否包含login，如果包含，说明是登录操作，放行
        if (url.contains("login")) {
            log.info("登录操作 ---> 放行！！！");
            return true;
        }

        // 3. 获取请求头中的令牌（token）
        String jwt = request.getHeader("token");

        // 4. 判断令牌是否存在，如果不存在，返回错误结果（未登录）
        if (!StringUtils.hasLength(jwt)) {
            log.info("请求头token为空 ---> 登录失败！！！");
            Result error = Result.error("NOT_LOGIN");
            // 手动转换 对象 ---> json
            String notLogin = JSONObject.toJSONString(error);
            // 响应给浏览器
            response.getWriter().write(notLogin);
            return false;
        }

        // 5. 解析token，如果解析失败，返回错误结果（未登录）
        try {
            JwtUtils.parseJWT(jwt);
        } catch (Exception e) {
            e.printStackTrace();
            log.info("令牌解析失败 ---> 登录失败！！！");
            Result error = Result.error("NOT_LOGIN");
            // 手动转换 对象 ---> json
            String notLogin = JSONObject.toJSONString(error);
            // 响应给浏览器
            response.getWriter().write(notLogin);
            return false;
        }

        // 6. 放行请求，必须增加，否则所有的请求都会卡在这里
        log.info("令牌合法 ---> 放行！！！");
        return true;
    }

    @Override // 目标方法执行后执行
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle ---> 运行了！！！");
    }

    @Override // 视图渲染完毕后执行，最后执行
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion ---> 运行了！！！");
    }
}