美文网首页
为什么引入@FeignClient注解接口的同时引入其实现类 通

为什么引入@FeignClient注解接口的同时引入其实现类 通

作者: Koosy | 来源:发表于2019-04-20 15:13 被阅读0次

    前言

    最近公司在进行项目的微服务升级采用的是Spring Cloud,每个拆分的服务大概分为两个模块 xxx-api 模块用于提供此服务对外的调用接口,接口上都标注了@FeignClient注解其他项目直接引用即可使用,xxx-service 模块是针对 xxx-api 的实现除了实现Service层的接口外还需要提供对应的Controller作为真正对外响应的HTTP服务。

    编写的Controller非常简单,通过@AutoWired自动注入对应的Service层接口即可,但是在实际开发中我们发现一个奇怪的问题,编写的Controller自动注入的居然是FeignClient生成的代理接口而不是我们实现的Service层接口。这到底是为什么了?而且同时存在两个相同类型的Bean在Spring容器中在注入时却没有报错这又是为什么?

    分析

    针对这个问题实际来说是有两个疑问的,1)为什么会优先注入 FeignClient 的接口代理类 2)为什么两个同类型的Bean 在自动注入时不会报错

    这个要从起点说起,我们引入Feign的功能,首先要在启动类上注解 @EnableFeignClients,表示启动FeignClient功能

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    @Import(FeignClientsRegistrar.class)
    public @interface EnableFeignClients{
        ...
    }
    

    根据注解的源码,我们可以知道当启动Spring应用之后,在初始的过程中会调用 FeignClientsRegistrar 的逻辑

    class FeignClientsRegistrar implements ImportBeanDefinitionRegistrar,
            ResourceLoaderAware, EnvironmentAware {
        
        ...
    
        @Override
        public void registerBeanDefinitions(AnnotationMetadata metadata,
                BeanDefinitionRegistry registry) {
            registerDefaultConfiguration(metadata, registry); //1)
            registerFeignClients(metadata, registry); //2)
        }
    
        ...
    }
    

    实际在初始化时会执行 ImportBeanDefinitionRegistrar#registerBeanDefinitions 方法
    1)注册 @EnableFeignClients#defaultConfiguration 配置的配置类到 Spring 容器中
    2)根据 @EnableFeignClients 注册的包路径,扫描所有注解了 @FeignClient 的接口,调用 ImportBeanDefinitionRegistrar#registerFeignClient 将其注册到 Spring 容器中

    private void registerFeignClient(BeanDefinitionRegistry registry,                          
            AnnotationMetadata annotationMetadata, Map<String, Object> attributes) {           
        String className = annotationMetadata.getClassName();                                  
        BeanDefinitionBuilder definition = BeanDefinitionBuilder                               
                .genericBeanDefinition(FeignClientFactoryBean.class); //1)                          
        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);//2)                                                    
                                                                                               
        String qualifier = getQualifier(attributes);                                           
        if (StringUtils.hasText(qualifier)) {                                                  
            alias = qualifier;                                                                 
        }                                                                                      
                                                                                               
        BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition, className,      
                new String[] { alias });                                                       
        BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);                    
    } 
    

    很明确的,我们可以知道FeignClient接口代理类实际是通过 FeignClientFactoryBean 生成的。
    1)FeignClientFactoryBean 作为生成代理类的Bean工厂
    2)是否将该 BeanDefinition 作为自动装配的第一候选者,@FeignClient#primary 默认为 true

    至此我们的两个疑问就都解答了,我们来看下 BeanDefinition#setPrimary 的注释

    /**                                                                     
    * Set whether this bean is a primary autowire candidate.               
    * <p>If this value is {@code true} for exactly one bean among multiple
    * matching candidates, it will serve as a tie-breaker.                 
    */                                                                     
    @Override                                                               
    public void setPrimary(boolean primary) {                               
        this.primary = primary;                                             
    }                                                                       
    

    简单翻译下:是否将此Bean设置为自动注入的第一候选,如果多个匹配候选中仅有一个的primary为true则它会胜出。

    对源码有兴趣的可以查看此方法 DefaultListableBeanFactory#resolveNamedBean 里面定义了通过Class获取Bean的完整过程。

    总结

    针对问题一,它是唯一将primary设置为true的候选者,所以会将其优先注入
    针对问题二,有多个候选者Spring会不知道该选择谁,所以他会报错,但是将primary设置为true后,将只有一个候选者

    所以我们在实际开发时想解决这个问题有两个方案

    1. 名称注入 @Resource("xxx") 或者 @Autowired + @Qualifier("xxx")
    2. 通过设置优先级解决 @FeignClient(primary = false) 然后在接口实现类上加入 @Primary

    相关文章

      网友评论

          本文标题:为什么引入@FeignClient注解接口的同时引入其实现类 通

          本文链接:https://www.haomeiwen.com/subject/vmwkgqtx.html