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

2301_78145364

于 2024-05-04 00:26:02 发布

阅读量797

点赞数 7

分类专栏：程序员文章标签： okhttp

本文链接：https://blog.csdn.net/2301_78145364/article/details/138428665

版权

程序员专栏收录该内容

175 篇文章 0 订阅

订阅专栏

本文解析了一线大厂Java面试中关于SpringCloudSquare的OkHttpInterceptor技术，介绍了其在构建网络请求时的工作原理，并详细剖析了spring-cloud-square-okhttp的源码，展示了如何通过Interceptor实现服务负载均衡。

摘要由CSDN通过智能技术生成

《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门，即可获取！

听说一图胜千言，欣宸二把刀的作图技术实在不敢恭维，但还是坚持把重要步骤用图表达出来了，如下所示，希望您能将就着看：

在这里插入图片描述

接下来，如果您还想深入研究和了解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被复制过来了：

在这里插入图片描述

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

在这里插入图片描述

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

在这里插入图片描述

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

在这里插入图片描述

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

在这里插入图片描述

至此可以小结了：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的源码了
打开项目如下图，我只能感慨两个字：就这？

在这里插入图片描述

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

在这里插入图片描述

看看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被实例化了

在这里插入图片描述

再看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;

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

在这里插入图片描述

收获

其实整个源码的核心就是给OkHttpClient塞进去一个Interceptor，这个Interceptor可以将服务名替换成IP和地址，功能仅此而已，但是收获是否会止步于此呢？这是个主观问题，各人的收获都不一样吧，我这最大的收获有以下两点：

OkHttpClient的链式处理很精彩，Interceptor.intercept中强制要求执行chain.proceed方法，让我想起了装饰者模式中的叠加处理逻辑
如何用spring.factories + AutoConfig + BeanPostProcessor + SpringCloud LoadBalance协同作战，spring-cloud-square-okhttp算是给我上了一课，尤其是OkHttpLoadBalancerAutoConfiguration中三个构造器的顺序注入，让人有种鼓掌叫好的冲动，我能写出这样简洁明快的starter吗？

至此，spring-cloud-square源码速读的spring-cloud-squarespring-cloud-square-okhttp篇已经完成了，在您学习spring的道路上，希望本文能够带给您一些参考
接下来要挑战的是spring-cloud-square的retrofit相关源码，代码量会增加很多，但是，何惧之有？欣宸原创，必不会辜负您的期待！