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客户端。
- 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