欢送拜访我的GitHub

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，波及Java、Docker、Kubernetes、DevOPS等；

前文回顾

  • 本篇是欣宸《spring-cloud-square原创》系列的第三篇，咱们疾速回顾一下后面两篇：
  1. 《五分钟搞懂spring-cloud-square》：说分明了spring-cloud-square是什么
  2. 《spring-cloud-square开发实战(三种类型全笼罩)》：说分明了spring-cloud-square怎么用
  • 接下来，为了深刻理解spring-cloud-square，我打算读它的源码，爱学习的您有没有趣味一起呢？

浏览源码的动机

  • 先说一下为什么要去看spring-cloud-square源码
  • spring是java开源我的项目的榜样，它的源码具备很高的品质和参考价值
  • 和其余spring我的项目相比，spring-cloud-square的源码少得可怜，花起码的工夫浏览spring我的项目的源码，这事儿我挺有趣味
  • 主动拆卸、拦截器、业务接口主动实现，这些技术都呈现在spring-cloud-square我的项目中，看懂了学会了，对本人的我的项目有很高的参考价值

把握外围方向

  • 在spring-cloud-square这种集成了多个库的我的项目中，波及的源码是很多的，很容易陷入一个又一个代码的细节中（不停的开展波及的类和源码），因而，这里先确定本次源码剖析的外围方向：
  • okhttp源码，只看要害局部，其余一律跳过
  • 只想晓得在应用spring-cloud-square-okhttp.jar的时候，为何输出服务名就能拜访到对应的服务
  • 以上就是这次浏览源码的主方向，在陷入细节时，这个主方向会及时将我拉回来，持续朝既定目标后退

下载源码

  • 下载地址是：https://github.com/spring-clo...，我选则了下图红框中的release版下载：

  • 下载结束后解压，用IDEA关上源码，失去的我的项目构造如下：

  • 明天，咱们的指标就是上图的<font color="blue">spring-cloud-square-okhttp</font>子工程，读它源码，学它精华！

提前小结

  • 总所周知，欣宸文笔程度在CSDN垫底，还喜爱废话，导致很多读者都看不下去，因而这里提前做个小结，将本篇精髓间接奉上，如果您工夫无限，或者罗唆没趣味深刻理解，能够看完小结后间接来到，也不算毫无播种.....
  • 将整个工程源码串起来小结：
  1. spring-cloud-square-okhttp.jar的使用者是个java利用，该利用要写代码实例化OkHttpClient.Builder对象
  2. spring.factories中配置的OkHttpLoadBalancerAutoConfiguration，会被spring框架扫到并实例化
  3. OkHttpLoadBalancerAutoConfiguration中实例化了OkHttpLoadBalancerInterceptor，并将LoadBalancerClient实例传给它
  4. OkHttpLoadBalancerAutoConfiguration中实例化了OkHttpClientBuilderCustomizer接口的实现，这外面是个lambda表达式，性能是将所有Interceptor传给lambda表达式对应的builder
  5. OkHttpLoadBalancerAutoConfiguration中实例化了OkHttpBuilderBeanPostProcessor，当步骤1中的OkHttpClient.Builder对象被实例化后，OkHttpBuilderBeanPostProcessor会调用OkHttpClient.Builder的addInterceptor对象，将OkHttpLoadBalancerInterceptor传给OkHttpClient.Builder
  6. 业务代码近程拜访的时候，用OkHttpClient.Builder创立OkHttpClient对象，此时的OkHttpClient就失去了OkHttpLoadBalancerInterceptor，在近程拜访时，业务代码传入的URL中是近程服务的名字，然而OkHttpLoadBalancerInterceptor会借助LoadBalancerClient将近程服务的名字替换成对应的IP和端口，而后再执行真正的网络申请
  • 据说一图胜千言，欣宸二把刀的作图技术切实不敢恭维，但还是保持把重要步骤用图表达出来了，如下所示，心愿您能将就着看：

  • 接下来，如果您还想深入研究和理解spring-cloud-square，就随欣宸一起畅游它的源码世界吧

知识点补充（OkHttpClient.Builder.addInterceptor）

  • 首先要补充一个重要知识点：OkHttpClient.Builder.addInterceptor办法的作用是什么？
  • 看源码很简略，就是将interceptor放入汇合<font color="blue">interceptors</font>中：
    public Builder addInterceptor(Interceptor interceptor) {      if (interceptor == null) throw new IllegalArgumentException("interceptor == null");      interceptors.add(interceptor);      return this;    }
  • builder是为实例化OkHttpClient服务的，去看OkHttpClient的构造方法，发现interceptors被复制过去了：

  • 在应用OkHttpClient拜访网络的时候，会执行下图红框中的getResponseWithInterceptorChain：

  • 而后就是经典的链式解决了，所有的interceptor都会被执行，下图展现了如何结构和启动链式解决：

  • 进入proceed外部，可见每次执行proceed办法，都会取出一个interceptor，调用其intercept办法：

  • 以spring-cloud-square框架的OkHttpLoadBalancerInterceptor为例，下图红框中的办法<font color="red">极为重要</font>，这行代码执行后，会回到上一幅图中的proceed办法，持续解决下一个interceptor：

  • 至此能够小结了：OkHttpClient.Builder.addInterceptor办法的作用，是传入一个Interceptor实现类，在OkHttpClient执行网络申请的时候，该Interceptor的intercept办法会被执行，请记住这个小结，前面有大用处！

spring-cloud-square-okhttp

  • spring-cloud-square提供了三种具体的实现，第一种是<font color="blue">spring-cloud-loadbalancer + spring-cloud-square-okhttp</font>的组合，而spring-cloud-loadbalancer是另一个我的项目不在此文中开展，因而，咱们最先看的就是<font color="red">spring-cloud-square-okhttp</font>的源码了
  • 关上我的项目如下图，我只能感叹两个字：<font color="blue">就这？</font>

  • 对于配置文件additional-spring-configuration-metadata.json，在spring文档中有提到，如下图红框，负责解决注解的处理器会将additional-spring-configuration-metadata.json的内容合并到元数据文件中去：

  • 看看additional-spring-configuration-metadata.json的内容，如下，定义了属性<font color="blue">okhttp.loadbalancer.enabled</font>的默认值为true：
{    "groups": [    ],    "properties": [        {            "name": "okhttp.loadbalancer.enabled",            "type": "java.lang.Boolean",            "description": "Allows disabling OkHttp Spring Cloud LoadBalancer support.",            "defaultValue": "true"        }    ]}
  • 如果您写过自定义starter库，那么您肯定晓得，整个spring-cloud-square-okhttp我的项目应该从spring.factories文件看起，这外面会确定那些配置类要被实例化：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\org.springframework.cloud.square.okhttp.loadbalancer.OkHttpLoadBalancerAutoConfiguration
  • 可见配置类OkHttpLoadBalancerAutoConfiguration会被实例化，咱们去看看OkHttpLoadBalancerAutoConfiguration.java，如下图，通过一长串剖析失去一个论断：OkHttpBuilderBeanPostProcessor被实例化了

  • 再看OkHttpBuilderBeanPostProcessor.java，如下图，重点关注红框中的三个关键点：

  • 回顾《spring-cloud-square开发实战(三种类型全笼罩)》中的代码，咱们在应用spring-cloud-square-okhttp.jar的时候，要本人写一个配置类来实例化OkHttpClient.Builder，如下所示，因而可见：OkHttpBuilderBeanPostProcessor就是给咱们创立的OkHttpClient.Builder实例筹备的，简略的说，就是OkHttpClient.Builder在创立后，就有OkHttpBuilderBeanPostProcessor将OkHttpLoadBalancerInterceptor传递给OkHttpClient.Builder：
package com.bolingcavalry.consumer;import okhttp3.OkHttpClient;import org.springframework.cloud.client.loadbalancer.LoadBalanced;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configurationclass OkHttpClientConfig{    @Bean    @LoadBalanced    public OkHttpClient.Builder okHttpClientBuilder() {        return new OkHttpClient.Builder();    }}
  • 此刻的您有没有豁然开朗呢？原来如此啊，所谓spring-cloud-square-okhttp，其实就是要求用户本人做一个OkHttpClient.Builder实例，而后spring-cloud-square-okhttp负责将OkHttpLoadBalancerInterceptor塞给OkHttpClient.Builder实例，如此一来，咱们在应用OkHttpClient做近程调用的时候，OkHttpLoadBalancerInterceptor的intercept办法就会被执行了！
  • 最初要看的就是OkHttpLoadBalancerInterceptor了，其实聪慧的您此刻曾经猜到它的作用了，它持有了LoadBalancerClient实例，那么在拜访网络的时候，就能够将URL中的服务名抠出来，用LoadBalancerClient查到对应的服务地址，而后OkHttpClient近程拜访能够用这个地址了，没错，就是如此：

播种

  • 其实整个源码的外围就是给OkHttpClient塞进去一个Interceptor，这个Interceptor能够将服务名替换成IP和地址，性能仅此而已，然而播种是否会止步于此呢？这是个主观问题，各人的播种都不一样吧，我这最大的播种有以下两点：
  1. OkHttpClient的链式解决很精彩，Interceptor.intercept中强制要求执行chain.proceed办法，让我想起了装璜者模式中的叠加解决逻辑
  2. 如何用<font color="blue">spring.factories + AutoConfig + BeanPostProcessor + SpringCloud LoadBalance</font>协同作战，spring-cloud-square-okhttp算是给我上了一课，尤其是OkHttpLoadBalancerAutoConfiguration中三个结构器的程序注入，让人有种鼓掌叫好的激动，我能写出这样简洁明快的starter吗？
  3. 至此，spring-cloud-square源码速读的spring-cloud-squarespring-cloud-square-okhttp篇曾经实现了，在您学习spring的路线上，心愿本文可能带给您一些参考
  4. 接下来要挑战的是spring-cloud-square的retrofit相干源码，代码量会减少很多，然而，何惧之有？欣宸原创，必不会辜负您的期待！

你不孤独，欣宸原创一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 数据库+中间件系列
  6. DevOps系列

欢送关注公众号：程序员欣宸

微信搜寻「程序员欣宸」，我是欣宸，期待与您一起畅游Java世界..
https://github.com/zq2599/blog_demos