Feign的构建过程及自定义扩展功能

spring-cloud-openfeign-core-2.1.1.RELEASE.jar 中 HystrixFeign 的详细构建过程：

@EnableFeignClients -> FeignClientsRegistrar 扫描 @Feign注解的类 -> FeignClientFactoryBean通过Targeter生产FeignClient -> Targeter通过Feign.Builder构建Feign -> Feign.Builder

1. 准备工作（配置）

  1. FeignAutoConfiguration自动配置类
    @Configuration@ConditionalOnClass(name = "feign.hystrix.HystrixFeign")protected static class HystrixFeignTargeterConfiguration {@Bean@ConditionalOnMissingBeanpublic Targeter feignTargeter() {return new HystrixTargeter();}}@Configuration@ConditionalOnMissingClass("feign.hystrix.HystrixFeign")protected static class DefaultFeignTargeterConfiguration {@Bean@ConditionalOnMissingBeanpublic Targeter feignTargeter() {return new DefaultTargeter();}}
  1. feign.hystrix.HystrixFeign类存在时，将 HystrixTargeter 注册为 Targeter 类型的 bean
  2. feign.hystrix.HystrixFeign类不存在时，使用 DefaultTargeter 。

  3. 看起来似乎可以使用自定义的Targeter代替Hystrix或默认的，这样就可以自定义各种功能了。实际上不行，因为 Targeter 是 package 访问级别的。

  4. FeignClientsConfiguration
@Configuration
public class FeignClientsConfiguration {@Bean@ConditionalOnMissingBeanpublic Retryer feignRetryer() {return Retryer.NEVER_RETRY;}@Bean@Scope("prototype")@ConditionalOnMissingBeanpublic Feign.Builder feignBuilder(Retryer retryer) {return Feign.builder().retryer(retryer);}@Configuration@ConditionalOnClass({ HystrixCommand.class, HystrixFeign.class })protected static class HystrixFeignConfiguration {@Bean@Scope("prototype")@ConditionalOnMissingBean@ConditionalOnProperty(name = "feign.hystrix.enabled")public Feign.Builder feignHystrixBuilder() {return HystrixFeign.builder();}}
}

重要：Feign 以及内部类 Feign.Builder 都是 public 访问级别，可以注入自定义的bean。

2.EnableFeignClients与FeignClientsRegistrar类

将使用@FeignClient注解的类注册成spring bean，并使用注解中的配置

  1. 在@EnableFeignClients注解中导入FeignClientsRegistrar类
  2. FeignClientsRegistrar类实现了ImportBeanDefinitionRegistrar类，会由spring框架执行实现方法 registerBeanDefinitions(AnnotationMetaData, BeanDefinitionRegistry)
  3. FeignClientsRegistrar中的 registerBeanDefinitions方法调用两个方法
    1. registerDefaultConfiguration：注册默认的配置
    2. registerFeignClients：注册Feign客户端（重点）
  4. registerFeignClients：获取 @EnableFeignClients注解中定义的配置扫描feign客户端
  5. registerFeignClients：通过registerFeignClient(BeanDefinitionRegistry, AnnotationMetadata, Map)方法注册每一个feignClient，过程：先获取 @FeignClient注解中定义的配置，将配置应用在spring bean 工厂 FeignClientFactoryBean， 通过工厂类 FeignClientFactoryBean 为每一个使用@FeignClient注解的类生产 FeignClient，详细过程见下一节

3.FeignClientFactoryBean

FeignClient工厂bean。

class FeignClientFactoryBeanimplements FactoryBean<Object>, InitializingBean, ApplicationContextAware{//...
}

通过实现方法 FactoryBean#getObject()来由spring框架生产FeignClient。

@Override
public Object getObject() throws Exception {return getTarget();
}/*** 获得目标* 1. 获得FeignContext* 2. 从FeignContext中获得Feign构建器Feign.Builder* 3. 从FeignContext中获得Client，判断是否进行负载均衡* 4. 从FeignContext中获得Target，并执行Target的默认方法target(FeignClientFactoryBean, Feign.Builder,FeignContext, Target.HardCodedTarget<T>);* 5.由于一开始注入的Feign.Builder是HystrixFeign.Builder,则此处是调用HystrixFeign.Builder里的对应方法*/
<T> T getTarget() {FeignContext context = this.applicationContext.getBean(FeignContext.class);Feign.Builder builder = feign(context);//省略部分代码// ......Client client = getOptional(context, Client.class);if (client != null) {if (client instanceof LoadBalancerFeignClient) {// not load balancing because we have a url,// but ribbon is on the classpath, so unwrapclient = ((LoadBalancerFeignClient) client).getDelegate();}builder.client(client);}Targeter targeter = get(context, Targeter.class);return (T) targeter.target(this, builder, context,new HardCodedTarget<>(this.type, this.name, url));
}protected Feign.Builder feign(FeignContext context) {FeignLoggerFactory loggerFactory = get(context, FeignLoggerFactory.class);Logger logger = loggerFactory.create(this.type);// @formatter:offFeign.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));// @formatter:onconfigureFeign(context, builder);return builder;}

工厂获得对象（目标）：

1. 获得FeignContext（feign上下文）
2. 从FeignContext中获得Feign构建器Feign.Builder（public，可以在此使用自定义构建器）
3. 从FeignContext中获得Client，判断是否进行负载均衡
4. 从FeignContext中获得Target，并执行Target的默认方法target(FeignClientFactoryBean, Feign.Builder,FeignContext, Target.HardCodedTarget<T>);
5. 由于一开始注入的 *Targeter* 是 *HystrixTargeter* ,则此处是调用 HystrixTargeter 里的对应方法（从第一节的配置来看，只要 *feign.hystrix.HystrixFeign* 类存在，就是注入的 *HystrixTargeter *， 否则是 *DefaultTargeter*，对于需要**自定义构建feign的，这里不太重要**）

4.Targeter

4.1.HystrixTargeter

class HystrixTargeter implements Targeter {@Overridepublic <T> T target(FeignClientFactoryBean factory, Feign.Builder feign,FeignContext context, Target.HardCodedTarget<T> target) {// 若不是 HystrixFeign，则执行其对应的默认target方法。// 此处只处理HystrixFeign。if (!(feign instanceof feign.hystrix.HystrixFeign.Builder)) {return feign.target(target);}feign.hystrix.HystrixFeign.Builder builder = (feign.hystrix.HystrixFeign.Builder) feign;SetterFactory setterFactory = getOptional(factory.getName(), context,SetterFactory.class);if (setterFactory != null) {builder.setterFactory(setterFactory);}Class<?> fallback = factory.getFallback();if (fallback != void.class) {return targetWithFallback(factory.getName(), context, target, builder,fallback);}Class<?> fallbackFactory = factory.getFallbackFactory();if (fallbackFactory != void.class) {return targetWithFallbackFactory(factory.getName(), context, target, builder,fallbackFactory);}// 调用从Feign.Builder继承的方法。return feign.target(target);}private <T> T targetWithFallbackFactory(String feignClientName, FeignContext context,Target.HardCodedTarget<T> target, HystrixFeign.Builder builder,Class<?> fallbackFactoryClass) {FallbackFactory<? extends T> fallbackFactory = (FallbackFactory<? extends T>) getFromContext("fallbackFactory", feignClientName, context, fallbackFactoryClass,FallbackFactory.class);return builder.target(target, fallbackFactory);}private <T> T targetWithFallback(String feignClientName, FeignContext context,Target.HardCodedTarget<T> target, HystrixFeign.Builder builder,Class<?> fallback) {T fallbackInstance = getFromContext("fallback", feignClientName, context,fallback, target.type());return builder.target(target, fallbackInstance);}//...
}
  1. HystrixTarget只处理 Feign.Builder 类型为 feign.hystrix.HystrixFeign.Builder 的
  2. 若feign构建器不是 feign.hystrix.HystrixFeign.Builder 类型，则执行注入的 feign 构建器的默认target方法
  3. 因此，即使注入的 Targeter 是 HystrixTargeter,此处也可以执行自定义 Feign.Builder。
  4. 理解：Feign.Builder#target(Target) 方法通常不会被 override（后续会讲解为什么不重写此方法）

4.2.DefaultTargeter

class DefaultTargeter implements Targeter {@Overridepublic <T> T target(FeignClientFactoryBean factory, Feign.Builder feign,FeignContext context, Target.HardCodedTarget<T> target) {return feign.target(target);}
}
  1. 执行 Feign.Builder （子）类型对应的 默认 target方法。
  2. 理解：Feign.Builder#target(Target) 方法通常不会被 override（后续会讲解为什么不重写此方法）

5.FeignBuilder

feign构建器：构建feign对象。

Feign的目的是将 http api 包装成 restful 风格以便开发。

在实现中，Feign 是一个为目标http apis 生成 feign对象（Feign#newInstance）的工厂。

上述步骤目前需要的都是通过对应的 Builder 构建对应的Feign。

public abstract class Feign {public static Builder builder() {return new Builder();}public abstract <T> T newInstance(Target<T> target);public static class Builder {public <T> T target(Target<T> target) {return build().newInstance(target);}public Feign build() {SynchronousMethodHandler.Factory synchronousMethodHandlerFactory =new SynchronousMethodHandler.Factory(client, retryer, requestInterceptors, logger, logLevel, decode404, closeAfterDecode, propagationPolicy);ParseHandlersByName handlersByName =new ParseHandlersByName(contract, options, encoder, decoder, queryMapEncoder,errorDecoder, synchronousMethodHandlerFactory);return new ReflectiveFeign(handlersByName, invocationHandlerFactory, queryMapEncoder);}}
}
  1. Feign.Builder#target(Target) 方法里面实际上调用的是 build() 方法来构建对象，因此重写 build() 方法即可，没有必要还重写 target(Target) 方法
  2. Feign 以及内部类 Feign.Builder 都是 public ，可以重写并注入自定义的bean。

5.1.HystrixFeign

public final class HystrixFeign {public static final class Builder extends Feign.Builder {  @Overridepublic Feign build() {return build(null);}// 提供一系列的target方法，支持各种配置：fallback、FallBackFactory等public <T> T target(Target<T> target, T fallback) {return build(fallback != null ? new FallbackFactory.Default<T>(fallback) : null).newInstance(target);}public <T> T target(Target<T> target, FallbackFactory<? extends T> fallbackFactory) {return build(fallbackFactory).newInstance(target);}public <T> T target(Class<T> apiType, String url, T fallback) {return target(new Target.HardCodedTarget<T>(apiType, url), fallback);}public <T> T target(Class<T> apiType,String url,FallbackFactory<? extends T> fallbackFactory) {return target(new Target.HardCodedTarget<T>(apiType, url), fallbackFactory);}/** Configures components needed for hystrix integration. */Feign build(final FallbackFactory<?> nullableFallbackFactory) {super.invocationHandlerFactory(new InvocationHandlerFactory() {@Overridepublic InvocationHandler create(Target target,Map<Method, MethodHandler> dispatch) {return new HystrixInvocationHandler(target, dispatch, setterFactory,nullableFallbackFactory);}});super.contract(new HystrixDelegatingContract(contract));return super.build();}

基本到了这一步，需要设置的东西，都可以配置了。

  1. 虽然 build 方法中涉及到 InvocationHandler,但基本不需要改什么，而 InvocationHandler 竟然也是 package 访问级别，所以只好复制一个，使用自己的。
  2. HystrixDelegatingContract 是 public 级别，不需要修改的话，仍然用这个。

5.2示例

以下示例参考 SentinelFeign

@Override
public Feign build() {super.invocationHandlerFactory(new InvocationHandlerFactory() {@Overridepublic InvocationHandler create(Target target,Map<Method, MethodHandler> dispatch) {// using reflect get fallback and fallbackFactory properties from// FeignClientFactoryBean because FeignClientFactoryBean is a package// level class, we can not use it in our packageObject feignClientFactoryBean = Builder.this.applicationContext.getBean("&" + target.type().getName());Class fallback = (Class) getFieldValue(feignClientFactoryBean,"fallback");Class fallbackFactory = (Class) getFieldValue(feignClientFactoryBean,"fallbackFactory");String name = (String) getFieldValue(feignClientFactoryBean, "name");Object fallbackInstance;FallbackFactory fallbackFactoryInstance;// check fallback and fallbackFactory properties// 以下逻辑在HystrixTargeter中有，但执行自定义的builder，不会执行到那段逻辑，因此此处加上。if (void.class != fallback) {fallbackInstance = getFromContext(name, "fallback", fallback,target.type());return new PegasusInvocationHandler(target, dispatch, setterFactory,new FallbackFactory.Default(fallbackInstance));}if (void.class != fallbackFactory) {fallbackFactoryInstance = (FallbackFactory) getFromContext(name,"fallbackFactory", fallbackFactory,FallbackFactory.class);return new PegasusInvocationHandler(target, dispatch, setterFactory,fallbackFactoryInstance);}// 此处还是会使用一个默认的FallbackFactory。return new PegasusInvocationHandler(target, dispatch, setterFactory, new PegasusFeignFallbackFactory<>(target));}private Object getFromContext(String name, String type,Class fallbackType, Class targetType) {Object fallbackInstance = feignContext.getInstance(name,fallbackType);if (fallbackInstance == null) {throw new IllegalStateException(String.format("No %s instance of type %s found for feign client %s",type, fallbackType, name));}if (!targetType.isAssignableFrom(fallbackType)) {throw new IllegalStateException(String.format("Incompatible %s instance. Fallback/fallbackFactory of type %s is not assignable to %s for feign client %s",type, fallbackType, targetType, name));}return fallbackInstance;}});super.contract(new HystrixDelegatingContract(contract));return super.build();
}

需要自定义fallbackFactory，则实现 feign.hystrix.FallbackFactory类，需要自定义fallback，则实现 org.springframework.cglib.proxy.MethodInterceptor即可

6.总结

  1. 由于Feign构建过程所用到的 Targeter 是 package 访问级别的，不能使用自定义的
  2. Feign以及Feign.Builder是 publilc，给了我们扩展的空间。

7.参考资料

  1. feign-hystrix-10.1.0.jar和spring-cloud-openfeign-core-2.1.1.RELEASE.jar
  2. spring-cloud-alibaba-sentinel-0.9.0.RELEASE.jar中的 sentinelFeign 实现
  3. Spring Cloud Alibaba Sentinel 整合 Feign 的设计实现

转载于:https://blog.51cto.com/14355901/2399829

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/275070.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

angelica类似_亲爱的当归（Angelica）是第一个让我哭泣的VR体验

angelica类似_亲爱的当归（Angelica）是第一个让我哭泣的VR体验

angelica类似It was a night just like any other night. I finished work for the day and closed my laptop. I had dinner and after an hour, I put on my Oculus Quest headset in order to begin my VR workout.就像其他任何夜晚一样&#xff0c; 这 是一个夜晚。 我完成…
阅读更多...
面试官：请手写一个带取消功能的延迟函数，axios 取消功能的原理是什么

面试官：请手写一个带取消功能的延迟函数，axios 取消功能的原理是什么

大家好&#xff0c;我是若川。最近组织了源码共读活动&#xff0c;感兴趣的可以点此加我微信 ruochuan12 参与&#xff0c;每周大家一起学习200行左右的源码&#xff0c;共同进步。同时极力推荐订阅我写的《学习源码整体架构系列》 包含20余篇源码文章。本文仓库 https://githu…
阅读更多...
关于base64编码的原理及实现

关于base64编码的原理及实现

我们的图片大部分都是可以转换成base64编码的data&#xff1a;image。 这个在将canvas保存为img的时候尤其有用。虽然除ie外&#xff0c;大部分现代浏览器都已经支持原生的基于base64的encode和decode&#xff0c;例如btoa和atob。&#xff08;将canvas画布保存成img并强制改变…
阅读更多...
Django web开发系列（五）模板

Django web开发系列（五）模板

一 前言在上一节了解到视图函数处理后&#xff0c;会将结果渲染到创建的html页面&#xff0c;但html如何接收并显示视图函数返回的动态数据呢&#xff1f;最常用的做法就是使用模板(Template)&#xff0c;本节将简单介绍一下模板的作用和用法。 可以这样简单的理解模板的概念&a…
阅读更多...
facebook 面试_如何为您的Facebook产品设计面试做准备

facebook 面试_如何为您的Facebook产品设计面试做准备

facebook 面试重点 (Top highlight)Last month, I joined Facebook to work on Instagram DMs and as a way to pay it forward, I 上个月&#xff0c;我加入了Facebook&#xff0c;从事Instagram DM的工作&#xff0c;作为一种支付方式&#xff0c;我 offered to help anyone…
阅读更多...
8年了，开始写点东西了

8年了，开始写点东西了

大家好&#xff0c;我是若川。最近组织了源码共读活动&#xff0c;感兴趣的可以点此加我微信 ruochuan12 参与&#xff0c;每周大家一起学习200行左右的源码&#xff0c;共同进步。同时极力推荐订阅我写的《学习源码整体架构系列》 包含20余篇源码文章。今天分享一位大佬的文章…
阅读更多...
荒径 弗罗斯特_弗罗斯特庞克，颠覆性城市建设者

荒径 弗罗斯特_弗罗斯特庞克，颠覆性城市建设者

荒径 弗罗斯特Most gamers are familiar with Will Wright’s famous SimCity series. It created the city building genre and there have been many attempts over the years to ape it. But few developers have been bold enough to completely deconstruct the formula; …
阅读更多...
2012年1月份第2周51Aspx源码发布详情

2012年1月份第2周51Aspx源码发布详情

WP7手指画图应用源码 2012-01-14 [VS2010] 游戏介绍&#xff1a;Windows Phone 7手指画图应用 – FingerPaint&#xff0c;您通过此游戏可以随心画一些感兴趣的东西&#xff0c;陶冶情操。操作简单&#xff0c;页面简洁。适合新手学习参考。 WP7 Car Bloke(交通工具开销记录)源…
阅读更多...
Gitee 如何自动部署博客 Pages？推荐用这个GitHub Actions!

Gitee 如何自动部署博客 Pages？推荐用这个GitHub Actions!

大家好&#xff0c;我是若川。最近组织了源码共读活动&#xff0c;感兴趣的可以点此加我微信 ruochuan12 参与&#xff0c;每周大家一起学习200行左右的源码&#xff0c;共同进步。同时极力推荐订阅我写的《学习源码整体架构系列》 包含20余篇源码文章。前段时间我把自己的博客…
阅读更多...
Java io流学习总结(三)

Java io流学习总结(三)

转载于&#xff1a;https://www.cnblogs.com/ll409546297/p/7197911.html java.io几种读写文件的方式 一、Java把这些不同来源和目标的数据都统一抽象为数据流。 Java语言的输入输出功能是十分强大而灵活的。 在Java类库中&#xff0c;IO部分的内容是很庞大的&#xff0c;因为它…
阅读更多...
现在流行的画原型图工具_原型资源图：8种流行原型工具的综合指南

现在流行的画原型图工具_原型资源图：8种流行原型工具的综合指南

现在流行的画原型图工具Although tools are not the most important things to learn as a UX designer, inevitably you need to use it in order to achieve your more important goals, to solve user’s problems. This article covers today’s 8 popular UX prototyping …
阅读更多...
持续5个月，200+笔记，3千多人参与，邀请你来学源码~

持续5个月，200+笔记，3千多人参与，邀请你来学源码~

注意&#xff1a;本文点击文末阅读原文可查看文中所有链接。我正在参加掘金年度人气作者投票活动&#xff0c;大家有空可以加微信群帮忙投票&#xff0c;感谢大家&#xff01;想起今天还没发文&#xff0c;就开放下微信群二维码&#xff0c;大家扫码进群读源码和帮忙投票吧。群…
阅读更多...
自己动手开发调试器 01

自己动手开发调试器 01

背景: 在做XXX编译器检证时经常需要区分是代码端错误&#xff0c;还是编译器端错误&#xff0c;因此对代码进行调试是必不可少的。但是狗日的甲方并没有提供对应的调试器XXXDB&#xff0c;而用GDB调试XXX生成的可执行程序很不稳定&#xff0c;经常出现异常&#xff0c;干脆…
阅读更多...
02如何抓住重点，系统高效地学习数据结构与算法？

02如何抓住重点，系统高效地学习数据结构与算法？

以下内容总结自极客时间王争大佬的《数据结构与算法之美》课程&#xff0c;本文章仅供个人学习总结。 什么是数据结构?什么是算法? 从广义上讲&#xff0c;数据结构就是指一组数据的存储结构。算法就是操作数据的一组方法。 类比图书馆的书籍&#xff0c;我们如果想找一本书可…
阅读更多...
第2年，倒数第3天，1.5万票，感动！

第2年，倒数第3天，1.5万票，感动！

1源码共读大家好&#xff0c;我是若川。众所周知。从8月份开始&#xff0c;我组织了源码共读活动&#xff0c;至今已经有5个月了&#xff0c;每周一期&#xff0c;进行到了第18期。每周坚持写源码解读文章&#xff0c;每天坚持答疑解惑&#xff0c;帮助了很多人学会看源码&…
阅读更多...
启发式搜索给神经网络_神经科学如何支持UX启发式

启发式搜索给神经网络_神经科学如何支持UX启发式

启发式搜索给神经网络重点 (Top highlight)Interaction and UX designers have long known and used heuristics to guide the creation of a user-friendly interface. We know empirically that these principles work, and they make “common sense”. These heuristics th…
阅读更多...
Django实战（1）：需求分析和设计

Django实战（1）：需求分析和设计

Depot是《Agile Web Development with Rails》中的一个购物车应用。 该书中用多次迭代的方法&#xff0c;逐步实现购物车应用&#xff0c;使很多人走上了rails开发的道路。 遗憾的是Django世界中好像没有类似的指引&#xff0c;也许是因为pythoner 不需要具体的例子。 但是如果…
阅读更多...
使用 apiDoc 为你的Node.js API 生成文档

使用 apiDoc 为你的Node.js API 生成文档

翻译&#xff1a; 疯狂的技术宅 原文&#xff1a;jonathas.com/documenting… 未经许可&#xff0c;禁止转载&#xff01; 当你为其他开发人员&#xff08;前端&#xff0c;桌面&#xff0c;移动等&#xff09;开发 API 时&#xff0c;需要生成一份风格良好的文档&#xff0c;以…
阅读更多...
海浪 shader_海浪下的发现

海浪 shader_海浪下的发现

海浪 shaderI’ve been playing Subnautica for over 25 hours now, and likely have at least that many more to go. The game puts you in the shoes of a crew member on the Aurora, a spaceship that suffers a catastrophic incident and plummets to the largely ocean…
阅读更多...
最后一天，特邀小姐姐配音拉票，今日可投28票

最后一天，特邀小姐姐配音拉票，今日可投28票

1源码共读大家好&#xff0c;我是若川。最后一天&#xff0c;特邀小姐姐配音拉票&#xff0c;超级好听。众所周知。从8月份开始&#xff0c;我组织了源码共读活动&#xff0c;至今已经有5个月了&#xff0c;每周一期&#xff0c;进行到了第18期。每周坚持写源码解读文章&#x…
阅读更多...
最新文章

Copyright @ 2022~2023