Feign源码解析之注入IOC容器

本文深入解析Feign在SpringBoot中的作用,详细介绍了如何通过@EnableFeignClients注解将Feign接口注入到IOC容器。文章探讨了FeignClientsRegistrar类的registerBeanDefinitions方法,以及注册默认配置和Feign客户端的步骤,包括scanner对象的初始化、basePackages和includeFilters的设置,以及扫描并注入IOC容器的过程。
摘要由CSDN通过智能技术生成

feign是springboot中特别重要的一部分,@FeignClient用来注解接口,通过处理注解的方式封装成http请求,从而通过调用服务的方式实现http请求。
要在项目中使用@FeignClients首先需要在项目中加上@EnableFeignClients注解。

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

	/**
	 * Alias for the {@link #basePackages()} attribute. Allows for more concise annotation
	 * declarations e.g.: {@code @ComponentScan("org.my.pkg")} instead of
	 * {@code @ComponentScan(basePackages="org.my.pkg")}.
	 * @return the array of 'basePackages'.
	 */
	String[] value() default {};

	/**
	 * Base packages to scan for annotated components.
	 * <p>
	 * {@link #value()} is an alias for (and mutually exclusive with) this attribute.
	 * <p>
	 * Use {@link #basePackageClasses()} for a type-safe alternative to String-based
	 * package names.
	 *
	 * @return the array of 'basePackages'.
	 */
	String[] basePackages() default {};

	/**
	 * Type-safe alternative to {@link #basePackages()} for specifying the packages to
	 * scan for annotated components. The package of each class specified will be scanned.
	 * <p>
	 * Consider creating a special no-op marker class or interface in each package that
	 * serves no purpose other than being referenced by this attribute.
	 *
	 * @return the array of 'basePackageClasses'.
	 */
	Class<?>[] basePackageClasses() default {};

	/**
	 * A custom <code>@Configuration</code> for all feign clients. Can contain override
	 * <code>@Bean</code> definition for the pieces that make up the client, for instance
	 * {@link feign.codec.Decoder}, {@link feign.codec.Encoder}, {@link feign.Contract}.
	 *
	 * @see FeignClientsConfiguration for the defaults
	 */
	Class<?>[] defaultConfiguration() default {};

	/**
	 * List of classes annotated with @FeignClient. If not empty, disables classpath scanning.
	 * @return
	 */
	Class<?>[] clients() default {};
}

如上所示,@EnableFeignClients有5个属性,@EnableFeignClients通过扫描路径的方式将@Feign注解的接口注入IOC容器,其中value, basePackages, basePackageClasses和clients都是用来指定扫路径,defaultConfiguration指定feign相关的配置。
@EnableFeignClients通过@import引入FeignClientsRegistrar实现注入逻辑,FeignXlientsRegistrar实现了ImportBeanDefinitionRegistrar接口,因此我们需要关注其核心方法registerBeanDefinitions。另外,FeignClientsRegistrar通过扫描路径的方式注入IOC容器,因此我们通过实现EnvironmentAware和ResourceLoaderAware接口来获取到项目的resourceLoader和environment。

@Override
public void registerBeanDefinitions(AnnotationMetadata metadata,
		BeanDefinitionRegistry registry) {
	registerDefaultConfiguration(metadata, registry);
	registerFeignClients(metadata, registry);
}

registerBeanDefinitions又分为两步分别调用了两个方法来注入默认配置和feign客户端。

  1. registerDefaultConfiguration方法
private void registerDefaultConfiguration(AnnotationMetadata metadata,
			BeanDefinitionRegistry registry) {
	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();
		}
		registerClientConfiguration(registry, name,
				defaultAttrs.get("defaultConfiguration"));
	}
}

registerDefaultConfiguration方法逻辑并不复杂,其目的是注入@EnableFeignClients方法中的defaultConfiguration属性作为feign的默认配置。
如果@EnableFeignClients含有defaultConfiguration属性,我们有委托了registerClientConfiguration方法将其注入IOC容器,在进入registerClientConfiguration方法,我们组装了name

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值