为什么你写的拦截器中不能注入Java bean?
一、如何實(shí)現(xiàn)攔截器
在Spring Boot項(xiàng)目中,攔截器經(jīng)常被用來(lái)做登陸驗(yàn)證,日志記錄等操作。攔截器是Spring提供的,所以可以將攔截器注成bean,由IOC容器來(lái)管理。實(shí)現(xiàn)攔截器的方式很簡(jiǎn)單,主要由以下兩個(gè)步驟:
自定義攔截器類實(shí)現(xiàn)HandlerInterceptor接口
自定義WebMvc配置類實(shí)現(xiàn)WebMvcConfigurer接口,添加自定義攔截器類
簡(jiǎn)要實(shí)現(xiàn)代碼如下:
自定義攔截器 LoginInterceptor:
public?class?LoginInterceptor?implements?HandlerInterceptor?{@Overridepublic?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?{@Overridepublic?void?addInterceptors(InterceptorRegistry?registry)?{registry.addInterceptor(new?LoginInterceptor())//?攔截的請(qǐng)求.addPathPatterns("/**")//?不用攔截的請(qǐng)求.excludePathPatterns("/login");} }這個(gè)攔截器的主要作用就是攔截所有訪問(wèn)請(qǐng)求,驗(yàn)證所帶token是否有效,當(dāng)token驗(yàn)證成功后,才能訪問(wèn)我們的業(yè)務(wù)接口。這時(shí)候就需要提供一個(gè)驗(yàn)證token有效性的接口,在攔截器中驗(yàn)證token,由于攔截器是Spring提供的,因此很容易想到使用@Component注解將攔截器注成一個(gè) bean。然后使用@Autowired注解將驗(yàn)證token的類注入到攔截器進(jìn)行驗(yàn)證。
改造完的代碼如下:
驗(yàn)證token接口類:
@Component public?class?TokenUtil?{/***?驗(yàn)證token?是否有效*/public?boolean?checkToken(String?token){...} }改造完的攔截器代碼如下:
@Component public?class?LoginInterceptor?implements?HandlerInterceptor?{@Autowiredprivate?TokenUtil?tokenUtil;@Overridepublic?boolean?preHandle(HttpServletRequest?request,?HttpServletResponse?response,?Object?handler)?throws?Exception?{if(!tokenUtil.checkToken(token)){...return?false;}return?true;} }調(diào)用接口時(shí)發(fā)現(xiàn),TokenUtil并沒(méi)有被注入進(jìn)來(lái)!明明代碼寫的沒(méi)問(wèn)題,為什么不能正常注入TokenUtil呢?
仔細(xì)觀察我們自定義的配置類WebConfiguration,在添加攔截器的時(shí)候用的是new LoginInterceptor(),如果想要攔截器生效,必須將攔截器配置到WebMvc的配置類中,就是我們自定義的WebConfiguration類。現(xiàn)在添加攔截器的時(shí)候是 new 了一個(gè)攔截器,也就是說(shuō)并沒(méi)有將攔截器托管給IOC容器,所以就無(wú)法引入Spring的bean對(duì)象。
?
二、如何將攔截器托管給IOC容器
解決問(wèn)題的思路也很簡(jiǎn)單,就是將攔截器也托管給IOC容器,這樣容器內(nèi)的對(duì)象就可以相互注入了。總共有以下三種方式進(jìn)行處理上述問(wèn)題。
2.1 在WebConfiguration注入攔截器
攔截器代碼不變,在攔截器上使用@Component,同時(shí)在WebConfiguration中使用@Autowired注解將攔截器注入。
攔截器代碼:
@Component public?class?LoginInterceptor?implements?HandlerInterceptor?{ }配置類代碼:
@Configuration public?class?WebConfiguration?implements?WebMvcConfigurer?{@Autowiredprivate?LoginInterceptor?loginInterceptor;@Overridepublic?void?addInterceptors(InterceptorRegistry?registry)?{registry.addInterceptor(loginInterceptor);} }2.2 在WebConfiguration將攔截器注成bean
攔截器無(wú)需增加@Component注解,在WebConfiguration類中使用@Bean注解將攔截器注成bean。
攔截器代碼:
public?class?LoginInterceptor?implements?HandlerInterceptor?{ }配置類代碼:
@Configuration public?class?WebConfiguration?implements?WebMvcConfigurer?{@Beanpublic?LoginInterceptor?loginInterceptor(){return?new?LoginInterceptor();}@Overridepublic?void?addInterceptors(InterceptorRegistry?registry)?{registry.addInterceptor(?loginInterceptor());} }2.3 通過(guò)構(gòu)造器處理
思路是在WebConfiguration類中注入需要的驗(yàn)證token的業(yè)務(wù)類,然后在初始化攔截器的時(shí)候?qū)I(yè)務(wù)類通過(guò)構(gòu)造器帶入攔截器中,這樣就不用把攔截器注成Spring Bean對(duì)象了。
攔截器代碼:
public?class?LoginInterceptor?implements?HandlerInterceptor?{private?TokenUtil?tokenUtil;public?LoginInterceptor(TokenUtil?tokenUtil)?{this.tokenUtil?=?tokenUtil;} }配置類代碼:
@Configuration public?class?WebConfiguration?implements?WebMvcConfigurer?{@Autowiredprivate?TokenUtil?tokenUtil;@Overridepublic?void?addInterceptors(InterceptorRegistry?registry)?{registry.addInterceptor(new?LoginInterceptor(tokenUtil));} }?
?
三、總結(jié)
網(wǎng)上關(guān)于攔截器的代碼基本都是通過(guò)new一個(gè)攔截器進(jìn)行配置的,這時(shí)候就會(huì)出現(xiàn)無(wú)法注入其他bean的情況。很多人想當(dāng)然地直接在攔截器加@Component注解使其成為一個(gè)bean對(duì)象。這是一種錯(cuò)誤的做法。我們需要保證的是在WebMvc配置類中添加的攔截器是Spring 的一個(gè)bean對(duì)象,也就是說(shuō)我們需要將攔截器注成一個(gè)bean,同時(shí)將這個(gè)bean添加的WebMvc配置類中。
有道無(wú)術(shù),術(shù)可成;有術(shù)無(wú)道,止于術(shù)
歡迎大家關(guān)注Java之道公眾號(hào)
好文章,我在看??
總結(jié)
以上是生活随笔為你收集整理的为什么你写的拦截器中不能注入Java bean?的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: python day2 python基础
- 下一篇: 装了这几个插件后,我不得不给 IDEA