Springboot拦截器的使用

本文介绍了如何在Spring Boot应用中创建一个HandlerInterceptor,用于拦截所有请求,并实现用户登录状态检查和临时用户cookie处理。通过实现WebMvcConfigurer接口,配置了全局拦截器,确保在目标方法执行前进行必要的操作。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1.创建拦截器

  1. 实现HandlerInterceptor 接口
  2. 重写preHandle方法
@Component
public class CartInterceptor implements HandlerInterceptor {

    public static ThreadLocal<UserInfoTo> threadLocal = new ThreadLocal<>();
    /**
     * 在目标方法执行之前拦截
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
                             HttpServletResponse response,
                             Object handler) throws Exception {
        UserInfoTo userInfoTo = new UserInfoTo();

        HttpSession session = request.getSession();
        MemberRespVo member = (MemberRespVo) session.getAttribute(AuthServerConstant.LOGIN_USER);
        if (member != null) {
            //用户登录
            userInfoTo.setUserId(member.getId());

        }
        //思考:什么时候存了cookies?
        Cookie[] cookies = request.getCookies();
        if (cookies != null && cookies.length > 0) {
            for (Cookie cookie : cookies) {
                String name = cookie.getName();
                if (name.equals(CartConstant.TEMP_USER_COOKIE_NAME)) {
                    userInfoTo.setUserKey(cookie.getValue());
                }
            }
        }
        //目标方法执行之前
        threadLocal.set(userInfoTo);
        return true;
    }
}

2.配置拦截哪些请求

  1. 实现WebMvcConfigurer 接口
  2. 重写addInterceptors方法
@Configuration
public class MallWebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new CartInterceptor()).addPathPatterns("/**");
    }
}


### 如何在 Spring Boot 中使用拦截器 #### 创建自定义拦截器 为了创建一个自定义拦截器,在应用程序中需要实现 `HandlerInterceptor` 接口。此接口提供了三个主要的方法:`preHandle()`、`postHandle()` 和 `afterCompletion()`, 这些方法允许开发者分别在控制器之前、视图渲染之后以及整个请求完成之后执行逻辑[^1]。 ```java import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyCustomInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("Before handling the controller..."); return true; // 如果返回false,则不会继续调用后续的处理器 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("After handling but before rendering view..."); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("After completing all operations..."); } } ``` #### 注册拦截器到配置类 为了让上述自定义拦截器生效,还需要将其注册至 Web 配置文件中。这通常是在实现了 `WebMvcConfigurer` 的配置类里完成的: ```java 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 { private final MyCustomInterceptor myCustomInterceptor; public WebConfig(MyCustomInterceptor myCustomInterceptor){ this.myCustomInterceptor = myCustomInterceptor; } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(myCustomInterceptor).addPathPatterns("/api/**"); } } ``` 这里指定了 `/api/**` 路径模式下的所有请求都将被该拦截器所捕获并处理。 #### 关联注解 对于某些场景下可能希望仅当满足特定条件才触发拦截操作,这就可以利用一些内置或自定义的注解来达到目的。例如,可以通过编写带有参数验证功能的自定义注解,并结合 AOP 或者其他机制让其影响拦截行为;也可以直接在拦截器内部解析 HTTP 请求中的头信息或者其他元数据来进行判断[^2]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值