spring boot拦截器注入不了java bean的原因
一、如何实现拦截器
在spring boot项目中,拦截器经常被用来做登陆验证,日志记录等操作。拦截器是spring提供的,所以可以将拦截器注成bean,由ioc容器来管理。实现拦截器的方式很简单,主要由以下两个步骤:
- 自定义拦截器类实现handlerinterceptor接口
- 自定义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配置类中。
以上就是spring boot拦截器注入不了java bean的原因的详细内容,更多关于spring boot拦截器的资料请关注其它相关文章!