SpringCloud 之HttpClient、HttpURLConnection、OkHttpClient切换源码
-
- HttpClient、HttpURLConnection、OkHttpClient区别
- [切换HttpClient 源码分析](#切换HttpClient 源码分析)
- 总结切换HttpClient源码
- 验证切换是否成功
- [okHttpClient 切换源码分析](#okHttpClient 切换源码分析)
- [总结 okHttpClient 切换源码](#总结 okHttpClient 切换源码)
- [同时开启 okHttp 与httpClient 会发生什么?](#同时开启 okHttp 与httpClient 会发生什么?)
- 使用自定义okHttpClient
- 总结
承接上文,之前已经分析过OpenFegin 的创建、发送请求源码了,接下来,分析下底层的HttpClient、HttpURLConnection、OkHttpClient切换从源码级别来看是如何做到的。
HttpClient、HttpURLConnection、OkHttpClient区别
- HttpURLConnection:相当于原始JDBC操作,性能高,使用不方便
- HttpClient:相当于 mybatis,基于JDBC封装了很多aip
- OkHttpClient:加入了池化技术,可以复用连接
切换HttpClient 源码分析
我这里看的是 spring-cloud-starter-openfeign 2.2.9.RELEASE的源码,不同版本间的源码可能有些许差异。依赖如下
javascript
<!-- okhttp 以及 httpclient、fegin-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
<version>2.2.9.RELEASE</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
<version>10.12</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
<version>10.12</version>
</dependency>
说句题外话,如下几处 fegin 的版本号要对应一下,不然就版本冲突了
就 spring-cloud-starter-openfeign 2.2.9.RELEASE 来说,底层切换HttpClient作为网络通信框架很简单,项目中引入如下依赖,无需做任何配置,底层自动用HttpClient 去发送网络请求。接下来看源码。
javascript
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
<version>10.12</version>
</dependency>
由于上文已经 debug 过 fegin 的全流程创建源码了,这里我直接贴入口,直接找到
org.springframework.cloud.openfeign.ribbon.HttpClientFeignLoadBalancedConfiguration这个类即可。如下图
可以看到 ApacheHttpClient 的生成条件如下,当我们项目中没有进行配置 feign.httpclient.enabled 时,默认被赋予成 true。所以要使用 ApacheHttpClient 的时候,加上依赖无需做任何配置就可以了。
@ConditionalOnClass({ApacheHttpClient.class}) 的意思是项目中必须存在ApacheHttpClient的 class,也就是必须导入对应的 maven 依赖
还有一个Import 注解,里面就是注册一些Bean定义信息。
javascript
@Configuration(
proxyBeanMethods = false
)
@ConditionalOnClass({ApacheHttpClient.class})
@ConditionalOnProperty(
value = {"feign.httpclient.enabled"},
matchIfMissing = true
)
@Conditional({HttpClient5DisabledConditions.class})
@Import({HttpClientFeignConfiguration.class})
总结切换HttpClient源码
引入HttpClient 依赖后,开启HttpClient 无需配置 feign.httpclient.enabled,当我们要关闭Httpclient 时配置feign.httpclient.enabled = false。
javascript
feign:
okhttp:
enabled: true
httpclient:
enabled: false
验证切换是否成功
fegin 的创建源码上文已经分析过了,这里直接贴结果。SpringCloud 所有的请求都是由 org.springframework.cloud.openfeign.ribbon.LoadBalancerFeignClient进行发起的,具体的干活的被包装到 delegate 里面了,说实话当我看到这里的代码时候,想到了Mybatis 中的二级缓存的设计。委派模式。可以点击主页看我之前分析过的Mybatis 系列源码。通过下图可以看到当我发送一个请求的时候 delegate 是我们的 okHttpClient。说明已经切换 okHttpClient了
okHttpClient 切换源码分析
上文已经说过了所有请求都是通过 LoadBalancerFeignClient 这个入口过的。在org.springframework.cloud.openfeign.ribbon.LoadBalancerFeignClient.的构造方法这打个断点,可以很清除的看到,当前项目用到的是什么 client。接下来分析okHttpClient的创建源码
通过分析注入条件我们可以知道,要开启 okHttpClient,必须配置 feign.okhttp.enabled = true,他不像开启httpClient 一样,条件注解上有 matchIfMissing = true(默认开启)。
@ConditionalOnClass({OkHttpClient.class}) 项目中必须存在 OkHttpClient 的类,也就是说必须导入OkHttpClient的 maven 依赖
javascript
@Configuration(
proxyBeanMethods = false
)
@ConditionalOnClass({OkHttpClient.class})
@ConditionalOnProperty({"feign.okhttp.enabled"})
@Import({OkHttpFeignConfiguration.class})
总结 okHttpClient 切换源码
要开启 okHttpClient,必须配置 feign.okhttp.enabled = true,且添加对应的 maven 依赖,此时的 yaml 的配置如下
javascript
feign:
okhttp:
enabled: true
httpclient:
enabled: false
同时开启 okHttp 与httpClient 会发生什么?
可以看到 httpClient 优先级高于 okHttp,至于原因的话,我没打算看了,估计就是几个条件注解互斥导致的,毕竟我看源码的目的就是为了,更好的熟悉各项配置的生效时机,以后碰到切换不生效的时候,打个断点调试一下就好了。
使用自定义okHttpClient
项目中自己注入okHttpClient就好了
javascript
package com.xxy.system.common.config;
import okhttp3.ConnectionPool;
import okhttp3.OkHttpClient;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.cloud.commons.httpclient.OkHttpClientConnectionPoolFactory;
import org.springframework.cloud.commons.httpclient.OkHttpClientFactory;
import org.springframework.cloud.openfeign.support.FeignHttpClientProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.concurrent.TimeUnit;
@Configuration
public class FeignConfig {
@Bean
@ConditionalOnMissingBean({ConnectionPool.class})
public ConnectionPool httpClientConnectionPool(FeignHttpClientProperties httpClientProperties, OkHttpClientConnectionPoolFactory connectionPoolFactory) {
Integer maxTotalConnections = httpClientProperties.getMaxConnections();
Long timeToLive = httpClientProperties.getTimeToLive();
TimeUnit ttlUnit = httpClientProperties.getTimeToLiveUnit();
return connectionPoolFactory.create(maxTotalConnections, timeToLive, ttlUnit);
}
@Bean
public OkHttpClient client(OkHttpClientFactory httpClientFactory, ConnectionPool connectionPool, FeignHttpClientProperties httpClientProperties) {
Boolean followRedirects = httpClientProperties.isFollowRedirects();
Integer connectTimeout = httpClientProperties.getConnectionTimeout();
Boolean disableSslValidation = httpClientProperties.isDisableSslValidation();
return httpClientFactory.createBuilder(disableSslValidation)
.connectTimeout((long) connectTimeout, TimeUnit.MILLISECONDS)
.followRedirects(followRedirects)
.connectionPool(connectionPool)
.readTimeout(666, TimeUnit.SECONDS)
//.addInterceptor(new OkHttpLogInterceptor()) // 自定义请求日志拦截器
.build();
}
}
至于为什么自定义的 okHttpClient 会生效,看他的源码配置就好了org.springframework.cloud.openfeign.ribbon.OkHttpFeignLoadBalancedConfiguration。如下图,可以看到具体okHttpClient是通过构造方法入参自动注入的Bean。拿到的是IOC容器中我们自己的okHttpClient实例注入的,当我们的项目中没有显示的构造okHttpClient bean 时,里面会自动构造一个默认的okHttpClient。点到 OkHttpClient delegate = new OkHttpClient(okHttpClient); 这行代码里面看一下就好了。不多 bb。
同理注入 自定义 httpClient,项目中自己配置一个 httpClient 的 bean 即可,不多 bb
总结
个人在阅读fegin 源码的时候,打了比较多的断点,但是本文只贴关键断点源码。
关键断点
- org.springframework.cloud.openfeign.ribbon.LoadBalancerFeignClient
里面的构造器还有 execute 方法(校验配置是否生效断点) - org.springframework.cloud.openfeign.ribbon.HttpClientFeignLoadBalancedConfiguration (httpClient版本的LoadBalancerFeignClient初始化断点)
- org.springframework.cloud.openfeign.ribbon.OkHttpFeignLoadBalancedConfiguration (okHttpClient版本的LoadBalancerFeignClient初始化断点)
这里是小咸鱼的技术窝欢迎拜访