springboot-拦截器

最新推荐文章于 2025-07-25 21:22:42 发布

原创最新推荐文章于 2025-07-25 21:22:42 发布 · 3.8k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#springboot #拦截器

java_springboot 专栏收录该内容

25 篇文章

订阅专栏

本文介绍了如何在SpringBoot中创建并使用拦截器。首先，自定义了LoginInterceptor类，实现HandlerInterceptor接口，检查请求头中的token并从redis获取用户信息。接着，通过重写WebMvcConfigurerAdapter的addInterceptors方法，将拦截器添加到SpringBoot的拦截器链中，设置拦截规则并排除特定路径。最后，进行了测试访问。

创建我们自己的拦截器类

实现 HandlerInterceptor 接口

package com.gary.interseptor;
/**
* @Description: 全局拦截器
*/
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.gary.exception.CustomException;
import com.gary.exception.ErrorCode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
@Component
public class LoginInterceptor implements HandlerInterceptor {
    private static final Logger logger = LoggerFactory.getLogger(LoginInterceptor.class);
    @Resource
    private RedisUtil redisUtil;

    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
    }

    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object arg2) throws Exception {
        String uri = request.getRequestURI().toString();
        logger.info(uri);

        String token = request.getHeader("h-token");
        if (null == token){
            logger.error("no token error");
            throw new CustomException(ErrorCode.NO_TOKEN_ERROR);
        }

        User user = TokenUtil.getIdentity(redisUtil, token);
        if(user == null) {
            logger.error("not login , token:{}",token);
            throw new CustomException(ErrorCode.USER_NOT_LOGIN);
        }

        request.setAttribute("user", user);
        return true;
    }
}

约定登录成功后，将token放入到请求头中，拦截器从请求头中获取token，从redis中获取对应的用户信息，如果没有token返回没有token异常；如果没有用户信息，返回token过期异常。

2.WebMvcConfigurerAdapter

重写WebMvcConfigurerAdapter中的addInterceptors方法把自定义的拦截器类添加进来

package com.gary.interseptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
@Configuration
public class MyWebMvcConfigurerAdapter extends WebMvcConfigurerAdapter{
    /**
     * 拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // addPathPatterns 用于添加拦截规则
        // excludePathPatterns 用户排除拦截
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**").excludePathPatterns("/toLogin","/doLogin");
        super.addInterceptors(registry);
    }
}

3.测试访问