为什么你写的拦截器注入不了 Java bean?

简介: 为什么你写的拦截器注入不了 Java bean?

一、如何实现拦截器

在Spring Boot项目中,拦截器经常被用来做登陆验证,日志记录等操作。拦截器是Spring提供的,所以可以将拦截器注成bean,由IOC容器来管理。实现拦截器的方式很简单,主要由以下两个步骤:

  1. 自定义拦截器类实现HandlerInterceptor接口
  2. 自定义WebMvc配置类实现WebMvcConfigurer接口,添加自定义拦截器类

简要实现代码如下:

自定义拦截器 LoginInterceptor

public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String token = request.getHeader("token");
        if(StringUtils.isEmpty(token)){
             ...
            return false;
        }
        return true;
    }
}

配置自定义拦截器:

@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                // 拦截的请求
                .addPathPatterns("/**")
                // 不用拦截的请求
                .excludePathPatterns("/login");
    }
}

这个拦截器的主要作用就是拦截所有访问请求,验证所带token是否有效,当token验证成功后,才能访问我们的业务接口。这时候就需要提供一个验证token有效性的接口,在拦截器中验证token,由于拦截器是Spring提供的,因此很容易想到使用@Component注解将拦截器注成一个 bean。然后使用@Autowired注解将验证token的类注入到拦截器进行验证。

改造完的代码如下:

验证token接口类:

@Component
public class TokenUtil {
    /**
     * 验证token 是否有效
     */
    public boolean checkToken(String token){
        ...
    }
}

改造完的拦截器代码如下:

@Component
public class LoginInterceptor implements HandlerInterceptor {

    @Autowired
    private TokenUtil tokenUtil;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if(!tokenUtil.checkToken(token)){
            ...
            return false;
        }
        return true;
    }
}

调用接口时发现,TokenUtil并没有被注入进来!明明代码写的没问题,为什么不能正常注入TokenUtil呢?

仔细观察我们自定义的配置类WebConfiguration,在添加拦截器的时候用的是new LoginInterceptor()如果想要拦截器生效,必须将拦截器配置到WebMvc的配置类中,就是我们自定义的WebConfiguration类。现在添加拦截器的时候是 new 了一个拦截器,也就是说并没有将拦截器托管给IOC容器,所以就无法引入Spring的bean对象

二、如何将拦截器托管给IOC容器

解决问题的思路也很简单,就是将拦截器也托管给IOC容器,这样容器内的对象就可以相互注入了。总共有以下三种方式进行处理上述问题。

2.1 在WebConfiguration注入拦截器

拦截器代码不变,在拦截器上使用@Component,同时在WebConfiguration中使用@Autowired注解将拦截器注入。

拦截器代码:

@Component
public class LoginInterceptor implements HandlerInterceptor {
}

配置类代码:

@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    @Autowired
    private LoginInterceptor loginInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor);
    }
}

2.2 在WebConfiguration将拦截器注成bean

拦截器无需增加@Component注解,在WebConfiguration类中使用@Bean注解将拦截器注成bean。

拦截器代码:

public class LoginInterceptor implements HandlerInterceptor {
}

配置类代码:

@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    @Bean
    public LoginInterceptor loginInterceptor(){
        return new LoginInterceptor();
    }

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor( loginInterceptor());
    }
}

2.3 通过构造器处理

思路是在WebConfiguration类中注入需要的验证token的业务类,然后在初始化拦截器的时候将业务类通过构造器带入拦截器中,这样就不用把拦截器注成Spring Bean对象了。

拦截器代码:

public class LoginInterceptor implements HandlerInterceptor {

    private TokenUtil tokenUtil;

    public LoginInterceptor(TokenUtil tokenUtil) {
        this.tokenUtil = tokenUtil;
    }
}

配置类代码:

@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    @Autowired
    private TokenUtil tokenUtil;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor(tokenUtil));
    }
}

三、总结

网上关于拦截器的代码基本都是通过new一个拦截器进行配置的,这时候就会出现无法注入其他bean的情况。很多人想当然地直接在拦截器加@Component注解使其成为一个bean对象。这是一种错误的做法。我们需要保证的是在WebMvc配置类中添加的拦截器是Spring 的一个bean对象,也就是说我们需要将拦截器注成一个bean,同时将这个bean添加的WebMvc配置类中。

目录
相关文章
|
11天前
|
监控 Java 数据管理
java会话跟踪和拦截器过滤器
本文介绍了Web开发中的会话跟踪技术——Cookie与Session,以及过滤器(Filter)和监听器(Listener)的概念和应用。Cookie通过在客户端记录信息来识别用户,而Session则在服务器端保存用户状态。过滤器用于拦截和处理请求及响应,监听器则监控域对象的状态变化。文章详细解释了这些技术的实现方式、应用场景和主要方法,帮助开发者更好地理解和使用这些工具。
28 1
|
22天前
|
Java 程序员 测试技术
Java|让 JUnit4 测试类自动注入 logger 和被测 Service
本文介绍如何通过自定义 IDEA 的 JUnit4 Test Class 模板,实现生成测试类时自动注入 logger 和被测 Service。
21 5
|
6月前
|
搜索推荐 Java 开发者
org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException 问题处理
【5月更文挑战第14天】org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException 问题处理
538 1
|
2月前
|
监控 前端开发 Java
Java里的过滤器和拦截器是什么原理,如何选择?
Java里的过滤器和拦截器是什么原理,如何选择?
30 0
|
3月前
|
Java Spring 容器
Java SpringBoot 中,动态执行 bean 对象中的方法
Java SpringBoot 中,动态执行 bean 对象中的方法
40 0
|
3月前
|
Java Spring
Java SpringBoot Bean InitializingBean 项目初始化
Java SpringBoot Bean InitializingBean 项目初始化
54 0
|
4月前
|
存储 前端开发 Java
Java中的不同Bean作用域
【7月更文挑战第5天】
56 0
Java中的不同Bean作用域
|
5月前
|
SQL 安全 Java
java的SQL注入与XSS攻击
java的SQL注入与XSS攻击
128 2
|
5月前
|
Java 持续交付 Maven
Java报错:Missing ServletWebServerFactory bean,如何解决
Java开发中遇到`Missing ServletWebServerFactory bean`错误?该问题可能由依赖冲突、配置问题或环境不一致引起。解决方法包括:检查依赖版本一致性、修复配置错误、确保环境匹配,以及查看IDE中的JRE配置。预防这类问题,可采用版本管理工具、CI/CD流程、代码审查和社区学习。木头左提醒,记得点赞和分享,下次见!
Java报错:Missing ServletWebServerFactory bean,如何解决
|
5月前
|
存储 NoSQL Java
Redis系列学习文章分享---第三篇(Redis快速入门之Java客户端--短信登录+session+验证码+拦截器+登录刷新)
Redis系列学习文章分享---第三篇(Redis快速入门之Java客户端--短信登录+session+验证码+拦截器+登录刷新)
100 0