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

本文約2千字，主要知識

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

• OpenFeign的父子容器
• FeignClient的注冊

背景

在使用Spring Cloud時，經(jīng)常使用OpenFeign 作為遠(yuǎn)程服務(wù)調(diào)用的類庫；
Feign 是一種聲明式服務(wù)調(diào)用組件，它在 RestTemplate 的基礎(chǔ)上做了進(jìn)一步的封裝。通過 Feign，我們只需要聲明一個接口并通過注解進(jìn)行簡單的配置（類似于 Dao 接口上面的 Mapper 注解一樣）即可實(shí)現(xiàn)對 HTTP 接口的綁定。通過 Feign，我們可以像調(diào)用本地方法一樣來調(diào)用遠(yuǎn)程服務(wù)，而完全感覺不到這是在進(jìn)行遠(yuǎn)程調(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的某個組件，需要先標(biāo)注@EnableXXX注解；OpenFeign 也不例外，其注解類@EnableFeignClients主要內(nèi)容如下：

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

其中，最核心的動作是@Import(FeignClientsRegistrar.class)
FeignClientsRegistrar實(shí)現(xiàn)了ImportBeanDefinitionRegistrar接口，實(shí)現(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) {// 注冊 默認(rèn)配置
        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 標(biāo)注類的屬性
				Mapattributes = annotationMetadata.getAnnotationAttributes(FeignClient.class.getCanonicalName());

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

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

private void registerFeignClient(BeanDefinitionRegistry registry, AnnotationMetadata annotationMetadata, Mapattributes) {String className = annotationMetadata.getClassName();
		Class clazz = ClassUtils.resolveClassName(className, null);
        // 強(qiáng)轉(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標(biāo)注類的配置信息構(gòu)建為BeanDefinition
        // clazz即為@FeignClinet標(biāo)注類的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標(biāo)注類注冊入Spring IOC父容器
		BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);
    	// 支持Request.Options的refresh 操作，非本章重點(diǎn)
		registerOptionsBeanDefinition(registry, contextId);
	}

registerDefaultConfiguration、registerFeignClients，最終都將調(diào)用registerClientConfiguration方法。
② 和③ 方法則將實(shí)際操作委托給DefaultListableBeanFactory#registerBeanDefinition；這涉及到Spring IOC的核心流程，此處不再贅述。在本文中只需記住如下現(xiàn)象。若要了解更多相關(guān)知識，可參考： 《Spring 揭秘》第二部分：Spring IOC容器

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 容器中

FeignContext 容器的實(shí)例化

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

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

public class FeignClientFactoryBean implements FactoryBean