spring-cloud-square源码速读(spring-cloud-square-okhttp篇)

欢迎访问我的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的时候,为何输入服务名就能访问到对应的服务
  • 以上就是这次阅读源码的主方向,在陷入细节时,这个主方向会及时将我拉回来,继续朝既定目标前进

下载源码

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第1张图片

  • 下载完毕后解压,用IDEA打开源码,得到的项目结构如下:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第2张图片

  • 今天,咱们的目标就是上图的spring-cloud-square-okhttp子工程,读它源码,学它精髓!

提前小结

  • 总所周知,欣宸文笔水平在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源码速读(spring-cloud-square-okhttp篇)_第3张图片

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

知识点补充(OkHttpClient.Builder.addInterceptor)

  • 首先要补充一个重要知识点:OkHttpClient.Builder.addInterceptor方法的作用是什么?
  • 看源码很简单,就是将interceptor放入集合interceptors中:
    public Builder addInterceptor(Interceptor interceptor) {
      if (interceptor == null) throw new IllegalArgumentException("interceptor == null");
      interceptors.add(interceptor);
      return this;
    }
  • builder是为实例化OkHttpClient服务的,去看OkHttpClient的构造方法,发现interceptors被复制过来了:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第4张图片

  • 在使用OkHttpClient访问网络的时候,会执行下图红框中的getResponseWithInterceptorChain:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第5张图片

  • 然后就是经典的链式处理了,所有的interceptor都会被执行,下图展示了如何构造和启动链式处理:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第6张图片

  • 进入proceed内部,可见每次执行proceed方法,都会取出一个interceptor,调用其intercept方法:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第7张图片

  • 以spring-cloud-square框架的OkHttpLoadBalancerInterceptor为例,下图红框中的方法极为重要,这行代码执行后,会回到上一幅图中的proceed方法,继续处理下一个interceptor:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第8张图片

  • 至此可以小结了:OkHttpClient.Builder.addInterceptor方法的作用,是传入一个Interceptor实现类,在OkHttpClient执行网络请求的时候,该Interceptor的intercept方法会被执行,请记住这个小结,后面有大用处!

spring-cloud-square-okhttp

  • spring-cloud-square提供了三种具体的实现,第一种是spring-cloud-loadbalancer + spring-cloud-square-okhttp的组合,而spring-cloud-loadbalancer是另一个项目不在此文中展开,因此,咱们最先看的就是spring-cloud-square-okhttp的源码了
  • 打开项目如下图,我只能感慨两个字:就这?

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第9张图片

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

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第10张图片

  • 看看additional-spring-configuration-metadata.json的内容,如下,定义了属性okhttp.loadbalancer.enabled的默认值为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被实例化了

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第11张图片

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

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第12张图片

  • 回忆《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;

@Configuration
class 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远程访问可以用这个地址了,没错,就是如此:

spring-cloud-square源码速读(spring-cloud-square-okhttp篇)_第13张图片

收获

  • 其实整个源码的核心就是给OkHttpClient塞进去一个Interceptor,这个Interceptor可以将服务名替换成IP和地址,功能仅此而已,但是收获是否会止步于此呢?这是个主观问题,各人的收获都不一样吧,我这最大的收获有以下两点:
  1. OkHttpClient的链式处理很精彩,Interceptor.intercept中强制要求执行chain.proceed方法,让我想起了装饰者模式中的叠加处理逻辑
  2. 如何用spring.factories + AutoConfig + BeanPostProcessor + SpringCloud LoadBalance协同作战,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

你可能感兴趣的:(云计算)