java自定义拦截器使用@Autowired时注入失败

朴灿烈づ我的快乐病毒、 2022-11-01 05:26 355阅读 0赞

### 问题背景 ###

打算自己写个自定义拦截器，通过配置文件中的开关switch来判断是否对请求的header进行校验；写完了自定义拦截器后，并且测试通过，此时认为拦截器写的是对的并开始写拦截器里面的具体逻辑。写完拦截方法里面的逻辑后发现一直报空指针异常。通过debug查看发现是配置类自动注入为null，导致一直获取不到。（部分代码如下）

##### WebMvcConfig #####

@Configuration
    public class WebMvcConfig implements WebMvcConfigurer { 
        public void addInterceptors(InterceptorRegistry registry){ 
            registry.addInterceptor(new HandlerInterceptorAdapter()).addPathPatterns("/hello/**");
        }
    }

##### HandlerInterceptorAdapter #####

public class HandlerInterceptorAdapter implements HandlerInterceptor { 
        // 日志配置
        private static final Logger logger = LoggerFactory.getLogger(HandlerInterceptorAdapter.class);
    
        @Autowired
        private SwitchConfig switchConfig;
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler){ 
            // 在业务处理器处理请求之前被调用
            logger.info("在业务处理器处理请求之前被调用");
            // 设置个校验开关 校验token
            if(switchConfig.isTokenCheckSwitch()) { 
                logger.info("token开关校验打开");
                String authorization = request.getHeader("Authorization");
                if(!StringUtils.isEmpty(authorization) && authorization.equals("root")) { 
                    logger.info("校验成功");
                    return true;
                }
                logger.info("校验失败");
                return false;
            }
    
            return true;
        }
    }

##### SwitchConfig #####

@Data
    @Component
    @ConfigurationProperties(prefix = "switch")
    public class SwitchConfig { 
        private boolean tokenCheckSwitch;
    
    }

##### application.yml #####

# 部分开关配置
    switch:
      # token校验开关
      tokenCheckSwitch: true
    server:
      port: 8000

运行后发现，报空指针异常；debug后发现整个switchConfig都是null，也就是说Autowired 注入失败了

### 问题排查 ###

##### 1. 校验是否是因为读取配置文件读取失败导致的 #####

由于没有写具体逻辑的时候拦截器是可以使用的，所以一直认为是读取配置文件中的tokerCheckSwitch读取失败。最后在配置文件中修改了服务器的启动端口后，发现配置文件没有问题，应该是其他原因导致的

##### 2. 校验是否是SwitchConfig 的用错相关注解导致 #####

排查问题的第二步就是看看是不是自己代码上写错了，配置类是不是注解错误，百度了相关注解，了解完后确认注解是正确的

##### 3. Autowried注入失败会是什么原因 #####

排查问题的第三步最终排查到autowried注入为null，经过多方资料查询发现这个拦截器加载的时间点是先于SpringContext的，并且又在代码中使用了`new HandlerInterceptorAdapter()` .也就是这个类完全没有交给Spring容器管理，那么内部使用了@Autowried也就是无效的

### 问题原因 ###

原因是：这个拦截器使用了`new HandlerInterceptorAdapter()` ,new的话就是没有交给spring容器管理，自然这整个类中使用的@Autowried 也不会被Spring处理，自动就会注入失败 switchConfig=null;

### 问题解决 ###

将`HandlerInterceptorAdapter` 配置为bean,交由Spring容器实例化，这样`HandlerInterceptorAdapter`内部使用对应的注解@Autowried 便会注入成功。代码修改如下（仅修改`WebMvcConfig.java`）

@Configuration
    public class WebMvcConfig implements WebMvcConfigurer { 
        @Bean
        public HandlerInterceptorAdapter headerParamsCheckInterceptor() { 
            return new HandlerInterceptorAdapter();
        }
    
        public void addInterceptors(InterceptorRegistry registry){ 
            registry.addInterceptor(headerParamsCheckInterceptor()).addPathPatterns("/hello/**");
        }
    }