为何你写的拦截器注入不了 Java bean？

1、如何实现拦截器

在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对象。

2、如何将拦截器托管给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));
    }
}

3、总结

网上关于拦截器的代码基本都是经过new一个拦截器进行配置的，这时候就会出现没法注入其余bean的状况。不少人想固然地直接在拦截器加@Component注解使其成为一个bean对象。这是一种错误的作法。咱们须要保证的是在WebMvc配置类中添加的拦截器是Spring 的一个bean对象，也就是说咱们须要将拦截器注成一个bean，同时将这个bean添加的WebMvc配置类中。

4、点关注、不迷路

若是以为文章不错，欢迎关注、点赞、收藏，大家的支持是我创做的动力，感谢你们。

若是文章写的有问题，请不要吝惜文笔，欢迎留言指出，我会及时核查修改。

若是你还想看到更多别的东西，能够微信搜索「Java旅途」进行关注。「Java旅途」目前已经整理各类中间件的使用教程及各种Java相关的面试题。