真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

OpenFeignAutoConfiguration源碼解析-創(chuàng)新互聯(lián)

本文約2千字，主要知識

在鳳慶等地區(qū)，都構(gòu)建了全面的區(qū)域性戰(zhàn)略布局，加強發(fā)展的系統(tǒng)性、市場前瞻性、產(chǎn)品創(chuàng)新能力，以專注、極致的服務理念，為客戶提供成都做網(wǎng)站、成都網(wǎng)站建設 網(wǎng)站設計制作定制網(wǎng)站制作,公司網(wǎng)站建設,企業(yè)網(wǎng)站建設,高端網(wǎng)站設計,全網(wǎng)整合營銷推廣,成都外貿(mào)網(wǎng)站建設,鳳慶網(wǎng)站建設費用合理。
  • OpenFeign的父子容器
  • FeignClient的注冊
背景

在使用Spring Cloud時，經(jīng)常使用OpenFeign 作為遠程服務調(diào)用的類庫；
Feign 是一種聲明式服務調(diào)用組件，它在 RestTemplate 的基礎上做了進一步的封裝。通過 Feign，我們只需要聲明一個接口并通過注解進行簡單的配置（類似于 Dao 接口上面的 Mapper 注解一樣）即可實現(xiàn)對 HTTP 接口的綁定。通過 Feign，我們可以像調(diào)用本地方法一樣來調(diào)用遠程服務，而完全感覺不到這是在進行遠程調(diào)用。
Spring Boot3中，也引入了一套全新的聲明式HTTP調(diào)用，這也可說明聲明式的調(diào)用方式收到足夠的青睞。

環(huán)境

Spring Boot : 2.7.6
spring-cloud：2021.0.5
OpenFeign-core : 11.10
jdk：17

示例工程

https://github.com/Fudeveloper/openfeign-demo.git

以下為示例工程的主要類

@FeignClient(name = "api-proxy"
             ,url = "http://127.0.0.1:8080"
             ,configuration = MyApiConfiguration.class)
public interface MyApi {@GetMapping("/test/my")
    String testForGet();
}
public class MyApiConfiguration {@Bean
    public Encoder myEncoder() {return new Encoder() {@Override
            public void encode(Object object, Type bodyType, RequestTemplate template) throws EncodeException {System.out.println("trigger myEncoder#encode");
            }
        };
    }
}
參考資料

OpenFeign 的使用文檔

FeignClient BeanDefinition的注冊

按照國際慣例，要啟用SpringBoot的某個組件，需要先標注@EnableXXX注解；OpenFeign 也不例外，其注解類@EnableFeignClients主要內(nèi)容如下：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
// 核心：導入FeignClientsRegistrar
@Import(FeignClientsRegistrar.class)
public @interface EnableFeignClients {	String[] basePackages() default {};
	Class[] clients() default {};
	// ... 
}

其中，最核心的動作是@Import(FeignClientsRegistrar.class)
FeignClientsRegistrar實現(xiàn)了ImportBeanDefinitionRegistrar接口，實現(xiàn)了一套自定義的BeanDefinition注冊流程。在SpringapplicationContext容器refresh的過程中（具體為invokeBeanFactoryPostProcessors->postProcessBeanDefinitionRegistry->processConfigBeanDefinitions）時，將調(diào)用FeignClientsRegistrar#registerBeanDefinitions

class FeignClientsRegistrar implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, EnvironmentAware {@Override
    public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {// 注冊 默認配置
        registerDefaultConfiguration(metadata, registry);
        // 注冊 FeignClient
        registerFeignClients(metadata, registry);
    }
}
registerFeignClients注冊所有@FeignClient
public void registerFeignClients(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {// 保存clients BeanDefinition 的數(shù)組
		LinkedHashSetcandidateComponents = new LinkedHashSet<>();
		Mapattrs = metadata.getAnnotationAttributes(EnableFeignClients.class.getName());
		final Class[] clients = attrs == null ? null : (Class[]) attrs.get("clients");
		if (clients == null || clients.length == 0) {// 如果未手動指定 clients，則掃描后添加
			ClassPathScanningCandidateComponentProvider scanner = getScanner();
			scanner.setResourceLoader(this.resourceLoader);
			scanner.addIncludeFilter(new AnnotationTypeFilter(FeignClient.class));
			SetbasePackages = getBasePackages(metadata);
			for (String basePackage : basePackages) {		candidateComponents.addAll(scanner.findCandidateComponents(basePackage));
			}
		}
		else {// 已手動指定，直接添加
			for (Classclazz : clients) {		candidateComponents.add(new AnnotatedGenericBeanDefinition(clazz));
			}
		}
        // ①遍歷所有client，并注冊
		for (BeanDefinition candidateComponent : candidateComponents) {	if (candidateComponent instanceof AnnotatedBeanDefinition) {// ... 

                // 獲取@FeignClient 標注類的屬性
				Mapattributes = annotationMetadata.getAnnotationAttributes(FeignClient.class.getCanonicalName());

				String name = getClientName(attributes);
                // ② 注冊 ${name}.FeignClientSpecification 
				registerClientConfiguration(registry, name, attributes.get("configuration"));
            	// ③ 注冊client的bean
				registerFeignClient(registry, annotationMetadata, attributes);
			}
		}
	}

在①處斷點后可以發(fā)現(xiàn)，candidateComponents已裝載我們自定義的FeignClient
image.png

private void registerFeignClient(BeanDefinitionRegistry registry, AnnotationMetadata annotationMetadata, Mapattributes) {String className = annotationMetadata.getClassName();
		Class clazz = ClassUtils.resolveClassName(className, null);
        // 強轉(zhuǎn)
		ConfigurableBeanFactory beanFactory = registry instanceof ConfigurableBeanFactory
				? (ConfigurableBeanFactory) registry : null;
		String contextId = getContextId(beanFactory, attributes);
		String name = getName(attributes);
        // ③.1 構(gòu)建factoryBean
		FeignClientFactoryBean factoryBean = new FeignClientFactoryBean();
		factoryBean.setBeanFactory(beanFactory);
		factoryBean.setName(name);
		factoryBean.setContextId(contextId);
		factoryBean.setType(clazz);
        // 是否可刷新，從feign.client.refresh-enabled配置解析
		factoryBean.setRefreshableClient(isClientRefreshEnabled());

        // 將@FeignClinet標注類的配置信息構(gòu)建為BeanDefinition
        // clazz即為@FeignClinet標注類的class
		BeanDefinitionBuilder definition = BeanDefinitionBuilder.genericBeanDefinition(clazz, () ->{	factoryBean.setUrl(getUrl(beanFactory, attributes));
			factoryBean.setPath(getPath(beanFactory, attributes));
			factoryBean.setDecode404(Boolean.parseBoolean(String.valueOf(attributes.get("decode404"))));
			Object fallback = attributes.get("fallback");
			if (fallback != null) {		factoryBean.setFallback(fallback instanceof Class ? (Class) fallback
						: ClassUtils.resolveClassName(fallback.toString(), null));
			}
			Object fallbackFactory = attributes.get("fallbackFactory");
			if (fallbackFactory != null) {		factoryBean.setFallbackFactory(fallbackFactory instanceof Class ? (Class) fallbackFactory
						: ClassUtils.resolveClassName(fallbackFactory.toString(), null));
			}
            // ③.2 注意此處是從factoryBean 獲取對象，具體為FeignClientFactoryBean#getObject
			return factoryBean.getObject();
		});
		definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
		definition.setLazyInit(true);
		validate(attributes);

		AbstractBeanDefinition beanDefinition = definition.getBeanDefinition();
		beanDefinition.setAttribute(FactoryBean.OBJECT_TYPE_ATTRIBUTE, className);
		beanDefinition.setAttribute("feignClientsRegistrarFactoryBean", factoryBean);

		// has a default, won't be null
		boolean primary = (Boolean) attributes.get("primary");

		beanDefinition.setPrimary(primary);

		String[] qualifiers = getQualifiers(attributes);
		if (ObjectUtils.isEmpty(qualifiers)) {	qualifiers = new String[] {contextId + "FeignClient" };
		}

		BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition, className, qualifiers);
        // 委托給DefaultListableBeanFactory#registerBeanDefinition
        // ④ 將@FeignClinet標注類注冊入Spring IOC父容器
		BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);
    	// 支持Request.Options的refresh 操作，非本章重點
		registerOptionsBeanDefinition(registry, contextId);
	}

registerDefaultConfiguration、registerFeignClients，最終都將調(diào)用registerClientConfiguration方法。
② 和③ 方法則將實際操作委托給DefaultListableBeanFactory#registerBeanDefinition；這涉及到Spring IOC的核心流程，此處不再贅述。在本文中只需記住如下現(xiàn)象。若要了解更多相關知識，可參考： 《Spring 揭秘》第二部分：Spring IOC容器
![](https://img-blog.csdnimg.cn/img_convert/183575716fde7fefbf7cffe4f2f9da87.png#averageHue=#f0f0f0&crop=0&crop=0&crop=1&crop=1&from=url&height=296&id=BnAcr&margin=[object Object]&originHeight=323&originWidth=775&originalType=binary&ratio=1&rotation=0&showTitle=false&status=done&style=none&title=&width=711)

BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
if (existingDefinition != null) {// 不存在則加入集合
    this.beanDefinitionMap.put(beanName, beanDefinition);
    this.beanDefinitionNames.add(beanName);
}

在③結(jié)束后，查看DefaultListableBeanFactory#beanDefinitionMap,可發(fā)現(xiàn)我們自定義的FeignClient已注冊到IOC 容器中
image.png

FeignContext 容器的實例化

回看③.1 、③.2的操作，即創(chuàng)建FeignClientFactoryBean并從中獲取對象；在Spring中，FactoryBean是個舉足輕重的類，可參考：What’s a FactoryBean?

注意③.2的后續(xù)操作：FeignClientFactoryBean#getObject

public class FeignClientFactoryBean implements FactoryBean, InitializingBean, ApplicationContextAware, BeanFactoryAware {@Override    
    public Object getObject() {return getTarget();
    }

T getTarget() {// ③.3 以注入的FeignContext，構(gòu)建Feign
        FeignContext context = beanFactory != null ? beanFactory.getBean(FeignContext.class)
            : applicationContext.getBean(FeignContext.class);
        // ③.5 構(gòu)建feign，并創(chuàng)建子容器
        Feign.Builder builder = feign(context);

        String url = this.url + cleanPath();
        Client client = getOptional(context, Client.class);
        if (client != null) {// ... 
            builder.client(client);
        }
    	// 應用自定義的配置項
        applyBuildCustomizers(context, builder);

        Targeter targeter = get(context, Targeter.class);
        return (T) targeter.target(this, builder, context, new HardCodedTarget<>(type, name, url));
    }

    protected Feign.Builder feign(FeignContext context) {// ③.5.1 首次從子容器獲取bean，將觸發(fā)子容器創(chuàng)建
		FeignLoggerFactory loggerFactory = get(context, FeignLoggerFactory.class);
		Logger logger = loggerFactory.create(type);

		Feign.Builder builder = get(context, Feign.Builder.class)
				// required values
				.logger(logger)
				.encoder(get(context, Encoder.class))
				.decoder(get(context, Decoder.class))
				.contract(get(context, Contract.class));
	
        // ③.5.2  根據(jù)FeignClientProperties、FeignClientConfiguration、父容器配置Feign
		configureFeign(context, builder);

		return builder;
	}

    protectedT get(FeignContext context, Classtype) {T instance = context.getInstance(contextId, type);
		if (instance == null) {	throw new IllegalStateException("No bean found of type " + type + " for " + contextId);
		}
		return instance;
	}

}
根據(jù)Spring Boot的SPI機制，可以發(fā)現(xiàn)在IOC 容器中引入了FeignAutoConfiguration。
image.png
FeignAutoConfiguration主要工作是注入一個FeignContext，與上方③.3 相呼應
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(Feign.class)
@EnableConfigurationProperties({FeignClientProperties.class, FeignHttpClientProperties.class, FeignEncoderProperties.class })
public class FeignAutoConfiguration {// 注入第一節(jié)中的所有配置
    @Autowired(required = false)
    private Listconfigurations = new ArrayList<>();
    
    // ③.4 構(gòu)建FeignContext
    @Bean
    public FeignContext feignContext() {FeignContext context = new FeignContext();
        context.setConfigurations(this.configurations);
        return context;
    }
}

在③.4 步驟時，斷點查看configurations，可看到 步驟② 注冊到Spring IOC容器中的FeignClientSpecification
image.png
public class FeignContext extends NamedContextFactory{public FeignContext() {// 注意FeignClientsConfiguration 類，其中存放了默認Bean配置
        super(FeignClientsConfiguration.class, "feign", "feign.client.name");
    }
}
FeignContext繼承于NamedContextFactory：NamedContextFactory 可以創(chuàng)建一個子容器（或者說子上下文）。OpenFeign則是依賴它來實現(xiàn)子容器機制的。
FeignContext 子容器的創(chuàng)建
在③.5中，多處調(diào)用了FeignClientFactoryBean#get方法，此方法將調(diào)用NamedContextFactory#createContext方法創(chuàng)建子容器。
image.png
// 子容器 map集合
private Mapcontexts = new ConcurrentHashMap<>();


publicT getInstance(String name, Classtype) {AnnotationConfigApplicationContext context = getContext(name);
    try {// 從容器中獲取Bean
        return context.getBean(type);
    }
    catch (NoSuchBeanDefinitionException e) {// ignore
    }
    return null;
}

protected AnnotationConfigApplicationContext getContext(String name) {if (!this.contexts.containsKey(name)) {synchronized (this.contexts) {if (!this.contexts.containsKey(name)) {// 不存在時，將創(chuàng)建子容器
                this.contexts.put(name, createContext(name));
            }
        }
    }
    // 從子容器中獲取
    return this.contexts.get(name);
}

// 創(chuàng)建子容器的方法
protected AnnotationConfigApplicationContext createContext(String name) {AnnotationConfigApplicationContext context;
    if (this.parent != null) {// 處理父類信息
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();
        if (parent instanceof ConfigurableApplicationContext) {beanFactory.setBeanClassLoader(
                ((ConfigurableApplicationContext) parent).getBeanFactory().getBeanClassLoader());
        }
        else {beanFactory.setBeanClassLoader(parent.getClassLoader());
        }
        context = new AnnotationConfigApplicationContext(beanFactory);
        context.setClassLoader(this.parent.getClassLoader());
    }
    else {// 當前已為頂級
        context = new AnnotationConfigApplicationContext();
    }
    
    if (this.configurations.containsKey(name)) {for (Classconfiguration : this.configurations.get(name).getConfiguration()) {// 處理@FeignClient 中定義的configuration，對應背景中的`MyApiConfiguration`
            context.register(configuration);
        }
    }
    for (Map.Entryentry : this.configurations.entrySet()) {if (entry.getKey().startsWith("default.")) {for (Classconfiguration : entry.getValue().getConfiguration()) {context.register(configuration);
            }
        }
    }
    context.register(PropertyPlaceholderAutoConfiguration.class, this.defaultConfigType);
    context.getEnvironment().getPropertySources().addFirst(new MapPropertySource(this.propertySourceName,
                                                                                 Collections.singletonMap(this.propertyName, name)));
    if (this.parent != null) {// 設置父容器，目的是讓所有bean也使用父容器的上下文信息
        context.setParent(this.parent);
    }
    context.setDisplayName(generateDisplayName(name));
    // 和Spring IOC容器相同，走refresh流程
    context.refresh();
    return context;
}
同樣的，在子容器的refresh 過程中（具體為finishBeanFactoryInitialization->beanFactory.preInstantiateSingletons），將初始化子容器所需要的Bean，如背景中定義的MyEncoder，以及FeignClientsConfiguration類中定義的名為feignXX的各個bean。
之后情況則與IOC 容器初始化過程類似，此處不再贅述。
image.png
子容器初始化完成后，執(zhí)行到③.5.2 處的代碼，其根據(jù)FeignClientProperties、FeignClientConfiguration、父容器配置Feign；其中，FeignClientConfiguration主要是注入一些默認Bean，如下所示
@Configuration(proxyBeanMethods = false)
public class FeignClientsConfiguration {@Bean
    @ConditionalOnMissingBean
    public Decoder feignDecoder() {return new OptionalDecoder(new ResponseEntityDecoder(new SpringDecoder(this.messageConverters)));
    }

    //... 省略其他默認Encoder、Capability 等
}
之后，執(zhí)行至④，將@FeignClinet標注類，以bean的形式注冊入Spring IOC父容器。至此，F(xiàn)eignClient的注冊已完成。
總結(jié)

                
     
你是否還在尋找穩(wěn)定的海外服務器提供商？創(chuàng)新互聯(lián)www.cdcxhl.cn海外機房具備T級流量清洗系統(tǒng)配攻擊溯源，準確流量調(diào)度確保服務器高可用性，企業(yè)級服務器適合批量采購，新人活動首月15元起，快前往官網(wǎng)查看詳情吧
            

            網(wǎng)站標題：OpenFeignAutoConfiguration源碼解析-創(chuàng)新互聯(lián)            

            文章轉(zhuǎn)載：http://weahome.cn/article/dhosop.html
        
    






    

        

            
                
                
在線咨詢

            
        

    

    

        
微信咨詢

        

    

    

        
電話咨詢

        

            
028-86922220（工作日）

            
18980820575（7×24）

        

    

    

        

            
                
提交需求

            
        

    

    

        

            
                
返回頂部