@FeignClient注入找不到異常如何解決
前言
Springcloud中的服務(wù)間調(diào)用是通過Feign進(jìn)行調(diào)用的,在調(diào)用方服務(wù)中,我們需要定義一些帶有@FeignClient注解的接口類。并且在啟動(dòng)類上加上@EnableFeignClients注解。
程序啟動(dòng)的時(shí)候,會(huì)檢查是否有@EnableFeignClients注解,如果有該注解,則開啟包掃描,掃描帶有@FeignClient注解的接口。
這里結(jié)合之前遇到的一個(gè)問題來(lái)和大家一起學(xué)習(xí)下@EnableFeignClients啟動(dòng)過程。
問題描述
之前搭建一個(gè)簡(jiǎn)單demo的時(shí)候,啟動(dòng)之后總是報(bào)錯(cuò)
Field client1Feign in com.aiqinhai.client2.controller.Testrequired a bean of type
'com.aiqinhai.client2.feignclient.Client1Feign' that could not be found.
Action:
Consider defining a bean of type 'com.aiqinhai.client2.feignclient.Client1Feign' in your configuration.
Process finished with exit code 1
排查了一頓之后,發(fā)現(xiàn)啟動(dòng)上的@EnableFeignClients注解,沒有指定basePackages包掃描路徑。
而且Client1Feign接口不是和啟動(dòng)類在同一目錄下,所以啟動(dòng)的時(shí)候就會(huì)報(bào)上述錯(cuò)誤。
后來(lái)在@EnableFeignClients指定了掃描包路徑就解決了。
@SpringBootApplication @EnableDiscoveryClient @EnableFeignClients(basePackages = {"com.aiqinhai.client2.feignclient"}) public class Client2Application { public static void main(String[] args) { SpringApplication.run(Client2Application.class, args); } }
問題確實(shí)解決了,但是我們還是需要了解服務(wù)啟動(dòng)的時(shí)候,@EnableFeignClients注解干了哪些事。
刨根@EnableFeignClients
想了解清楚這個(gè)注解的作用,最好的方式就是看看注解的源碼。點(diǎn)進(jìn)去之后,可以看到
/** * 掃描注解@FeignClient標(biāo)注的接口 */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.TYPE}) @Documented @Import(FeignClientsRegistrar.class) public @interface EnableFeignClients { //同basePackages String[] value() default {}; //掃描的package. String[] basePackages() default {}; //feigin client全局配置,默認(rèn)配置在FeignClientsConfiguration類中 Class<?>[] defaultConfiguration() default {}; //@FeignClient注解的接口,如果指定了該屬性,則關(guān)閉掃描。 Class<?>[] clients() default {}; }
可以看到,注解中import了FeignClientsRegistrar類,我們進(jìn)去看看,可以看到包掃描的邏輯就是在FeignClientsRegistrar中實(shí)現(xiàn)的,會(huì)掃描所有的.class文件,過濾出@FeignClient標(biāo)注的接口,然后通過BeanDefinitionBuilder生成FeignClientFactoryBean對(duì)象,注入到IOC容器中。
具體代碼如下
class FeignClientsRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, EnvironmentAware { //包掃描方法入口 @Override public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //注冊(cè)默認(rèn)配置bean到ioc registerDefaultConfiguration(metadata, registry); //注冊(cè)@FeignClients標(biāo)注的接口bean,為其生成動(dòng)態(tài)代理 registerFeignClients(metadata, registry); } private void registerDefaultConfiguration(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //獲取@EnableFeignClients注解屬性 Map<String, Object> defaultAttrs = metadata .getAnnotationAttributes(EnableFeignClients.class.getName(), true); if (defaultAttrs != null && defaultAttrs.containsKey("defaultConfiguration")) { String name; if (metadata.hasEnclosingClass()) { name = "default." + metadata.getEnclosingClassName(); } else { name = "default." + metadata.getClassName(); } //注冊(cè)@EnableFeignClients defaultConfiguration 類中定義的bean到ioc registerClientConfiguration(registry, name, defaultAttrs.get("defaultConfiguration")); } } public void registerFeignClients(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //spring 掃描工具類 ClassPathScanningCandidateComponentProvider scanner = getScanner(); scanner.setResourceLoader(this.resourceLoader); //待掃描的包 Set<String> basePackages; //@EnableFeignClients注解屬性 Map<String, Object> attrs = metadata .getAnnotationAttributes(EnableFeignClients.class.getName()); //@FeignClient注解過濾器,只掃描@FeignClient注解標(biāo)注的接口 AnnotationTypeFilter annotationTypeFilter = new AnnotationTypeFilter( FeignClient.class); //解析@EnableFeignClient 屬性clients final Class<?>[] clients = attrs == null ? null : (Class<?>[]) attrs.get("clients"); //如果@EnableFeignClient沒有指定clients,則開啟包掃描,否則關(guān)閉掃描,使用clients if (clients == null || clients.length == 0) { scanner.addIncludeFilter(annotationTypeFilter); basePackages = getBasePackages(metadata); } else { final Set<String> clientClasses = new HashSet<>(); basePackages = new HashSet<>(); for (Class<?> clazz : clients) { basePackages.add(ClassUtils.getPackageName(clazz)); clientClasses.add(clazz.getCanonicalName()); } AbstractClassTestingTypeFilter filter = new AbstractClassTestingTypeFilter() { @Override protected boolean match(ClassMetadata metadata) { String cleaned = metadata.getClassName().replaceAll("\\$", "."); return clientClasses.contains(cleaned); } }; scanner.addIncludeFilter( new AllTypeFilter(Arrays.asList(filter, annotationTypeFilter))); } for (String basePackage : basePackages) { //從類路徑下的所有.class文件中掃描@FeignClient注解的接口 Set<BeanDefinition> candidateComponents = scanner .findCandidateComponents(basePackage); for (BeanDefinition candidateComponent : candidateComponents) { if (candidateComponent instanceof AnnotatedBeanDefinition) { // verify annotated class is an interface AnnotatedBeanDefinition beanDefinition = (AnnotatedBeanDefinition) candidateComponent; //獲取注解 AnnotationMetadata annotationMetadata = beanDefinition.getMetadata(); //@FeignClient注解必須應(yīng)用在接口上,否則拋出異常。 Assert.isTrue(annotationMetadata.isInterface(), "@FeignClient can only be specified on an interface"); //獲取FeignClient注解屬性 Map<String, Object> attributes = annotationMetadata .getAnnotationAttributes( FeignClient.class.getCanonicalName()); //服務(wù)名稱 String name = getClientName(attributes); //注冊(cè)configuration中指定的bean registerClientConfiguration(registry, name, attributes.get("configuration")); //生成FeignClient bean,并注冊(cè)到ioc registerFeignClient(registry, annotationMetadata, attributes); } } } } //生成bean,注入到IOC容器 private void registerFeignClient(BeanDefinitionRegistry registry, AnnotationMetadata annotationMetadata, Map<String, Object> attributes) { // feignclient類名稱 String className = annotationMetadata.getClassName(); BeanDefinitionBuilder definition = BeanDefinitionBuilder .genericBeanDefinition(FeignClientFactoryBean.class); validate(attributes); definition.addPropertyValue("url", getUrl(attributes)); definition.addPropertyValue("path", getPath(attributes)); String name = getName(attributes); definition.addPropertyValue("name", name); definition.addPropertyValue("type", className); definition.addPropertyValue("decode404", attributes.get("decode404")); definition.addPropertyValue("fallback", attributes.get("fallback")); definition.addPropertyValue("fallbackFactory", attributes.get("fallbackFactory")); definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE); String alias = name + "FeignClient"; AbstractBeanDefinition beanDefinition = definition.getBeanDefinition(); boolean primary = (Boolean)attributes.get("primary"); // has a default, won't be null beanDefinition.setPrimary(primary); String qualifier = getQualifier(attributes); if (StringUtils.hasText(qualifier)) { alias = qualifier; } BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition, className, new String[] { alias }); //注冊(cè)到ioc BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry); } }
@FeignClient 類,注入找不到類
原因:
@FeignClinet 和 @EnableFeignClients 不是同一個(gè)包。
可能因?yàn)閟pringboot和springcloud的版本不一致造成的。
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
盤點(diǎn)Java中延時(shí)任務(wù)的多種實(shí)現(xiàn)方式
當(dāng)需要一個(gè)定時(shí)發(fā)布系統(tǒng)通告的功能,如何實(shí)現(xiàn)??當(dāng)支付超時(shí),訂單自動(dòng)取消,如何實(shí)現(xiàn)?其實(shí)這些問題本質(zhì)都是延時(shí)任務(wù)的實(shí)現(xiàn),本文為大家盤點(diǎn)了多種常見的延時(shí)任務(wù)實(shí)現(xiàn)方法,希望對(duì)大家有所幫助2022-12-12springboot 配置文件配置項(xiàng)前綴為0的數(shù)字特殊處理方式
這篇文章主要介紹了springboot 配置文件配置項(xiàng)前綴為0的數(shù)字特殊處理方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02Java語(yǔ)言ReadWriteLock特性實(shí)例測(cè)試
這篇文章主要介紹了Java語(yǔ)言ReadWriteLock特性實(shí)例測(cè)試,分享了相關(guān)代碼示例,小編覺得還是挺不錯(cuò)的,具有一定借鑒價(jià)值,需要的朋友可以參考下2018-02-02關(guān)于@Autowired注解和靜態(tài)方法及new的關(guān)系
這篇文章主要介紹了關(guān)于@Autowired注解和靜態(tài)方法及new的關(guān)系,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-02-02SpringBoot整合Netty服務(wù)端的實(shí)現(xiàn)示例
Netty提供了一套完整的API,用于處理網(wǎng)絡(luò)IO操作,如TCP和UDP套接字,本文主要介紹了SpringBoot整合Netty服務(wù)端的實(shí)現(xiàn)示例,具有一定的參考價(jià)值,感興趣的可以了解一下2024-07-07SpringBoot集成Spring Security的方法
Spring security,是一個(gè)強(qiáng)大的和高度可定制的身份驗(yàn)證和訪問控制框架。這篇文章主要介紹了SpringBoot集成Spring Security的操作方法,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07