图解+源码讲解 Feign 如何将客户端注入到容器中
成功永远属于那些爱拼搏的人
从哪里开始看
主要是有两个比较核心的注解，一个是 @EnableFeignClients 一个是 @FeignClient(value = "GOODS-APPLICATION") , 这两个注解是非常重要的我们进入这两个注解看看里面主要是做什么的
注解 @FeignClient
从注释上来看就是，这个 @FeignClient注解就是生命在接口上面，之后被创建了一个 RestClient 客户端，如果 Ribbon 是可用的话，那么就会去使用 Ribbon 的负载均衡器去进行请求
使用 @FeignClient 注解
声明一个获取商品接口客户端，访问的是 GOODS-APPLICATION 这个服务的接口，这个服务是 EurekaServer 注册中心注册的服务
(value = "GOODS-APPLICATION")
public interface GoodsClient {
(value = "/good/getGoods", method = RequestMethod.GET)
ResponseEntity<ResultObject> goods();
}注解 @EnableFeignClients
从上面的注解上看就是扫描声明了 @FeignClient这个注解的接口，这里面还 @import 引入了 FeignClientsRegistrar.class 这个类，这个类从名字就能看出来是 FeignClient 客户端注册类，下面我们会详细讲解这个类的
使用 @EnableFeignClients 注解
// 开启Feign功能
// 开启EurekaClient功能
public class PortalApplication {
public static void main(String[] args) {
SpringApplication.run(PortalApplication.class, args);
}
}FeignClientsRegistrar 详解
这个类主要是做了两件事情，一个是向容器中注册Feign客户端配置，一个是向容器中注册所有的Feign客户端
class FeignClientsRegistrar
implements ImportBeanDefinitionRegistrar, ResourceLoaderAware, EnvironmentAware {
// 注册默认的配置
registerDefaultConfiguration(metadata, registry);
// 注册所有的feign客户端
registerFeignClients(metadata, registry);
}注册默认配置 registerDefaultConfiguration
解析默认的配置
private void registerDefaultConfiguration(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
// 获取注解属性
Map<String, Object> defaultAttrs = metadata
.getAnnotationAttributes(EnableFeignClients.class.getName(), true);
// 获取属性中的默认配置 defaultConfiguration
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"));
}
}
向spring容器中注入 FeignClient 配置
private void registerClientConfiguration(BeanDefinitionRegistry registry, Object name,
Object configuration) {
// 创建一个 FeignClientSpecification.class 构造器
BeanDefinitionBuilder builder = BeanDefinitionBuilder
.genericBeanDefinition(FeignClientSpecification.class);
builder.addConstructorArgValue(name);
builder.addConstructorArgValue(configuration);
// 向容器中注册默认配置
registry.registerBeanDefinition(
name + "." + FeignClientSpecification.class.getSimpleName(),
builder.getBeanDefinition());
}注册所有feign客户端
注册所有的feign客户端
public void registerFeignClients(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
// 顶一个扫描器
ClassPathScanningCandidateComponentProvider scanner = getScanner();
// 扫描的资源路径
scanner.setResourceLoader(this.resourceLoader);
Set<String> basePackages;
// 获取 EnableFeignClients 注解中的指定配置
Map<String, Object> attrs = metadata
.getAnnotationAttributes(EnableFeignClients.class.getName());
attrs 该 map里面的值不为空，里面有五个键值对,里面的 clients 对应的class[0] 是没有值得
// 定义一个 FeignClient 注解类型过滤器
AnnotationTypeFilter annotationTypeFilter = new AnnotationTypeFilter(
FeignClient.class);
// 因为 attrs 该 map里面的值不为空，所以 clients 是不为空的，获取的attrs里面 clients key
// 对应的 Class 数组长度是0
final Class<?>[] clients = attrs == null ? null
: (Class<?>[]) attrs.get("clients");
if (clients == null || clients.length == 0) {
// 讲 annotationTypeFilter也就是 FeignClient 注解过滤器设置到扫描器重
scanner.addIncludeFilter(annotationTypeFilter);
// 获取基础包，因为注解EnableFeignClients上面什么都没设置，所以basePackages、
// basePackageClasses 等信息都是空的所以此处获取的包就是Application对应的跟路径包
// com.shangde.springcloud
basePackages = getBasePackages(metadata);
}else{
// 如果clients不为空的话话就走下面的逻辑，不过也就是获取包路径，添加注解过滤器
final Set<String> clientClasses = new HashSet<>();
basePackages = new HashSet<>();
for (Class<?> clazz : clients) {
basePackages.add(ClassUtils.getPackageName(clazz));
clientClasses.add(clazz.getCanonicalName());
}
AbstractClassTestingTypeFilter filter = new AbstractClassTestingTypeFilter() {
protected boolean match(ClassMetadata metadata) {
String cleaned = metadata.getClassName().replaceAll("\\$", ".");
return clientClasses.contains(cleaned);
}
};
scanner.addIncludeFilter(
new AllTypeFilter(Arrays.asList(filter, annotationTypeFilter)));
}遍历上面获取的路径包，获取标记好的@FeignClient注解的接口进行向容器中注入
for (String basePackage : basePackages) { // 上面获取的包路径
Set<BeanDefinition> candidateComponents = scanner
.findCandidateComponents(basePackage); //根据包获取相应的bean
// com.shangde.springcloud.service.GoodsClient
for (BeanDefinition candidateComponent : candidateComponents) {
// 遍历获取的bend进行处理
if (candidateComponent instanceof AnnotatedBeanDefinition) {
AnnotatedBeanDefinition beanDefinition =
(AnnotatedBeanDefinition) candidateComponent;
// 获取到 bean 的元数据
AnnotationMetadata annotationMetadata = beanDefinition.getMetadata();
// 获取bean注解上的属性
Map<String, Object> attributes = annotationMetadata
.getAnnotationAttributes(FeignClient.class.getCanonicalName());
// 获取bean注解上定义的name属性也就是 GOODS-APPLICATION
String name = getClientName(attributes);
// 注册客户端配置
registerClientConfiguration(registry, name,attributes.get("configuration"));
// 进行客户端注册
registerFeignClient(registry, annotationMetadata, attributes);
}
}
}
} 详细信息在下面的图里面
真正的注册feign客户端
private void registerFeignClient(BeanDefinitionRegistry registry,
AnnotationMetadata annotationMetadata, Map<String, Object> attributes) {
// 获取注解元数据的className com.shangde.springcloud.service.GoodsClient
String className = annotationMetadata.getClassName();
// 定义了一个 FeignClientFactoryBean bean定义构造器
BeanDefinitionBuilder definition = BeanDefinitionBuilder
.genericBeanDefinition(FeignClientFactoryBean.class);
......
// 省略了一些赋值的语句
// 进行属性赋值，之后注入到Spring容器中
BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);
}小结
- 在springboot应用启动上面加一个注解叫@EnableFeignClients
- 写一个服务接口,这个接口上面写一个注解叫@FeignClient
- 扫描所有带@FeignClient注解的接口，之后将所有的接口都注入到spring容器中去
