From b83435281dcc2f426ef20c7a43dc191a200717ba Mon Sep 17 00:00:00 2001 From: WuLang <48200100+wulangcode@users.noreply.github.com> Date: Sat, 18 Feb 2023 22:52:02 +0800 Subject: [PATCH] =?UTF-8?q?:art:=20=E6=96=B0=E5=A2=9Eokhttp=E5=AE=9E?= =?UTF-8?q?=E7=8E=B0=E6=8E=A5=E5=8F=A3=E8=AF=B7=E6=B1=82=E7=9A=84=E5=8D=95?= =?UTF-8?q?=E4=BE=8B=E6=A8=A1=E5=BC=8F=E4=BB=A3=E7=A0=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../okhttp/DefaultOkHttpClientBuilder.java | 263 ++++++++++++++++++ .../util/http/okhttp/OkHttpClientBuilder.java | 126 +++++++++ .../http/okhttp/OkHttpDnsClientBuilder.java | 257 +++++++++++++++++ .../DefaultOkHttpClientBuilderTest.java | 66 +++++ .../cp/api/impl/WxCpServiceOkHttpImpl.java | 11 +- .../api/impl/WxMaServiceOkHttpImpl.java | 11 +- .../mp/api/impl/WxMpServiceOkHttpImpl.java | 10 +- .../api/impl/WxQidianServiceOkHttpImpl.java | 12 +- 8 files changed, 733 insertions(+), 23 deletions(-) create mode 100644 weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilder.java create mode 100644 weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpClientBuilder.java create mode 100644 weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpDnsClientBuilder.java create mode 100644 weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilderTest.java diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilder.java new file mode 100644 index 000000000..5ebe0ff1f --- /dev/null +++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilder.java @@ -0,0 +1,263 @@ +package me.chanjar.weixin.common.util.http.okhttp; + +import lombok.Data; +import lombok.extern.slf4j.Slf4j; +import okhttp3.*; + +import javax.annotation.concurrent.NotThreadSafe; +import java.net.Proxy; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; + +/** + * @author wulang + **/ +@Slf4j +@Data +@NotThreadSafe +public class DefaultOkHttpClientBuilder implements OkHttpClientBuilder { + + private final AtomicBoolean prepared = new AtomicBoolean(false); + + /** + * 代理 + */ + private Proxy proxy; + + /** + * 授权 + */ + private Authenticator authenticator; + + /** + * 拦截器 + */ + private final List interceptorList = new ArrayList<>(); + + /** + * 请求调度管理 + */ + private Dispatcher dispatcher; + + /** + * 连接池 + */ + private ConnectionPool connectionPool; + + /** + * 监听网络请求过程 + */ + private EventListener.Factory eventListenerFactory; + + /** + * 是否支持失败重连 + */ + private Boolean retryOnConnectionFailure; + + /** + * 是否允许重定向操作 + */ + private Boolean followRedirects; + + /** + * 连接建立的超时时长 + */ + private Long connectTimeout; + + /** + * 连接建立的超时时间单位 + */ + private TimeUnit connectTimeUnit; + + /** + * 完整的请求过程超时时长 + */ + private Long callTimeout; + + /** + * 完整的请求过程超时时间单位 + */ + private TimeUnit callTimeUnit; + + /** + * 连接的IO读操作超时时长 + */ + private Long readTimeout; + + /** + * 连接的IO读操作超时时间单位 + */ + private TimeUnit readTimeUnit; + + /** + * 连接的IO写操作超时时长 + */ + private Long writeTimeout; + + /** + * 连接的IO写操作超时时间单位 + */ + private TimeUnit writeTimeUnit; + + /** + * ping的时间间隔 + */ + private Integer pingInterval; + + /** + * 持有client对象,仅初始化一次,避免多service实例的时候造成重复初始化的问题 + */ + private OkHttpClient okHttpClient; + + private DefaultOkHttpClientBuilder() { + + } + + public static DefaultOkHttpClientBuilder get() { + return DefaultOkHttpClientBuilder.SingletonHolder.INSTANCE; + } + + @Override + public OkHttpClient build() { + if (!prepared.get()) { + prepare(); + } + return this.okHttpClient; + } + + @Override + public OkHttpClientBuilder proxy(Proxy proxy) { + this.proxy = proxy; + return this; + } + + @Override + public OkHttpClientBuilder authenticator(Authenticator authenticator) { + this.authenticator = authenticator; + return this; + } + + @Override + public OkHttpClientBuilder addInterceptor(Interceptor interceptor) { + this.interceptorList.add(interceptor); + return this; + } + + @Override + public OkHttpClientBuilder setDispatcher(Dispatcher dispatcher) { + this.dispatcher = dispatcher; + return this; + } + + @Override + public OkHttpClientBuilder setConnectionPool(ConnectionPool connectionPool) { + this.connectionPool = connectionPool; + return this; + } + + @Override + public OkHttpClientBuilder setEventListenerFactory(EventListener.Factory eventListenerFactory) { + this.eventListenerFactory = eventListenerFactory; + return this; + } + + @Override + public OkHttpClientBuilder setRetryOnConnectionFailure(Boolean retryOnConnectionFailure) { + this.retryOnConnectionFailure = retryOnConnectionFailure; + return this; + } + + @Override + public OkHttpClientBuilder setFollowRedirects(Boolean followRedirects) { + this.followRedirects = followRedirects; + return this; + } + + @Override + public OkHttpClientBuilder connectTimeout(Long timeout, TimeUnit unit) { + this.connectTimeout = timeout; + this.connectTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder callTimeout(Long timeout, TimeUnit unit) { + this.callTimeout = timeout; + this.callTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder readTimeout(Long timeout, TimeUnit unit) { + this.readTimeout = timeout; + this.readTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder writeTimeout(Long timeout, TimeUnit unit) { + this.writeTimeout = timeout; + this.writeTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder setPingInterval(Integer pingInterval) { + this.pingInterval = pingInterval; + return this; + } + + private synchronized void prepare() { + if (prepared.get()) { + return; + } + OkHttpClient.Builder builder = new OkHttpClient.Builder(); + if (this.authenticator != null) { + builder.authenticator(this.authenticator); + } + if (this.proxy != null) { + builder.proxy(this.proxy); + } + for (Interceptor interceptor : this.interceptorList) { + builder.addInterceptor(interceptor); + } + if (this.dispatcher != null) { + builder.dispatcher(dispatcher); + } + if (this.connectionPool != null) { + builder.connectionPool(connectionPool); + } + if (this.eventListenerFactory != null) { + builder.eventListenerFactory(this.eventListenerFactory); + } + if (this.retryOnConnectionFailure != null) { + builder.setRetryOnConnectionFailure$okhttp(this.retryOnConnectionFailure); + } + if (this.followRedirects != null) { + builder.followRedirects(this.followRedirects); + } + if (this.connectTimeout != null && this.connectTimeUnit != null) { + builder.connectTimeout(this.connectTimeout, this.connectTimeUnit); + } + if (this.callTimeout != null && this.callTimeUnit != null) { + builder.callTimeout(this.callTimeout, this.callTimeUnit); + } + if (this.readTimeout != null && this.readTimeUnit != null) { + builder.readTimeout(this.readTimeout, this.readTimeUnit); + } + if (this.writeTimeout != null && this.writeTimeUnit != null) { + builder.writeTimeout(this.writeTimeout, this.writeTimeUnit); + } + if (this.pingInterval != null) { + builder.setPingInterval$okhttp(this.pingInterval); + } + this.okHttpClient = builder.build(); + prepared.set(true); + } + + private static class SingletonHolder { + private static final DefaultOkHttpClientBuilder INSTANCE = new DefaultOkHttpClientBuilder(); + } +} diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpClientBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpClientBuilder.java new file mode 100644 index 000000000..0a2586a4b --- /dev/null +++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpClientBuilder.java @@ -0,0 +1,126 @@ +package me.chanjar.weixin.common.util.http.okhttp; + +import okhttp3.*; + +import java.net.Proxy; +import java.util.concurrent.TimeUnit; + +/** + * @author wulang + **/ +public interface OkHttpClientBuilder { + /** + * 构建OkHttpClient实例. + * + * @return OkHttpClient + */ + OkHttpClient build(); + + /** + * 代理 + * + * @param proxy Proxy + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder proxy(Proxy proxy); + + /** + * 授权 + * + * @param authenticator Authenticator + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder authenticator(Authenticator authenticator); + + /** + * 拦截器 + * + * @param interceptor Interceptor + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder addInterceptor(Interceptor interceptor); + + /** + * 请求调度管理 + * + * @param dispatcher Dispatcher + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder setDispatcher(Dispatcher dispatcher); + + /** + * 连接池 + * + * @param connectionPool ConnectionPool + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder setConnectionPool(ConnectionPool connectionPool); + + /** + * 监听网络请求过程 + * + * @param eventListenerFactory EventListener + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder setEventListenerFactory(EventListener.Factory eventListenerFactory); + + /** + * 是否支持失败重连 + * + * @param retryOnConnectionFailure retryOnConnectionFailure + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder setRetryOnConnectionFailure(Boolean retryOnConnectionFailure); + + /** + * 是否允许重定向操作 + * + * @param followRedirects followRedirects + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder setFollowRedirects(Boolean followRedirects); + + /** + * 连接建立的超时时间 + * + * @param timeout 时长 + * @param unit 时间单位 + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder connectTimeout(Long timeout, TimeUnit unit); + + /** + * 完整的请求过程超时时间 + * + * @param timeout 时长 + * @param unit 时间单位 + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder callTimeout(Long timeout, TimeUnit unit); + + /** + * 连接的IO读操作超时时间 + * + * @param timeout 时长 + * @param unit 时间单位 + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder readTimeout(Long timeout, TimeUnit unit); + + /** + * 连接的IO写操作超时时间 + * + * @param timeout 时长 + * @param unit 时间单位 + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder writeTimeout(Long timeout, TimeUnit unit); + + /** + * ping的时间间隔 + * + * @param pingInterval ping的时间间隔 + * @return OkHttpClientBuilder + */ + OkHttpClientBuilder setPingInterval(Integer pingInterval); +} diff --git a/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpDnsClientBuilder.java b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpDnsClientBuilder.java new file mode 100644 index 000000000..c34674752 --- /dev/null +++ b/weixin-java-common/src/main/java/me/chanjar/weixin/common/util/http/okhttp/OkHttpDnsClientBuilder.java @@ -0,0 +1,257 @@ +package me.chanjar.weixin.common.util.http.okhttp; + +import okhttp3.*; + +import java.net.Proxy; +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.TimeUnit; + +/** + * OkHttpClient 连接管理器 多一个DNS解析. + *

大部分代码拷贝自：DefaultOkHttpClientBuilder

+ * + * @author wulang + **/ +public class OkHttpDnsClientBuilder implements OkHttpClientBuilder { + + /** + * 代理 + */ + private Proxy proxy; + + /** + * 授权 + */ + private Authenticator authenticator; + + /** + * 拦截器 + */ + private final List interceptorList = new ArrayList<>(); + + /** + * 请求调度管理 + */ + private Dispatcher dispatcher; + + /** + * 连接池 + */ + private ConnectionPool connectionPool; + + /** + * 监听网络请求过程 + */ + private EventListener.Factory eventListenerFactory; + + /** + * 是否支持失败重连 + */ + private Boolean retryOnConnectionFailure; + + /** + * 是否允许重定向操作 + */ + private Boolean followRedirects; + + /** + * 连接建立的超时时长 + */ + private Long connectTimeout; + + /** + * 连接建立的超时时间单位 + */ + private TimeUnit connectTimeUnit; + + /** + * 完整的请求过程超时时长 + */ + private Long callTimeout; + + /** + * 完整的请求过程超时时间单位 + */ + private TimeUnit callTimeUnit; + + /** + * 连接的IO读操作超时时长 + */ + private Long readTimeout; + + /** + * 连接的IO读操作超时时间单位 + */ + private TimeUnit readTimeUnit; + + /** + * 连接的IO写操作超时时长 + */ + private Long writeTimeout; + + /** + * 连接的IO写操作超时时间单位 + */ + private TimeUnit writeTimeUnit; + + /** + * ping的时间间隔 + */ + private Integer pingInterval; + + private Dns dns; + + private OkHttpClient okHttpClient; + + private OkHttpDnsClientBuilder() { + + } + + public static OkHttpDnsClientBuilder get() { + return new OkHttpDnsClientBuilder(); + } + + public Dns getDns() { + return dns; + } + + public void setDns(Dns dns) { + this.dns = dns; + } + + @Override + public OkHttpClient build() { + prepare(); + return this.okHttpClient; + } + + @Override + public OkHttpClientBuilder proxy(Proxy proxy) { + this.proxy = proxy; + return this; + } + + @Override + public OkHttpClientBuilder authenticator(Authenticator authenticator) { + this.authenticator = authenticator; + return this; + } + + @Override + public OkHttpClientBuilder addInterceptor(Interceptor interceptor) { + this.interceptorList.add(interceptor); + return this; + } + + @Override + public OkHttpClientBuilder setDispatcher(Dispatcher dispatcher) { + this.dispatcher = dispatcher; + return this; + } + + @Override + public OkHttpClientBuilder setConnectionPool(ConnectionPool connectionPool) { + this.connectionPool = connectionPool; + return this; + } + + @Override + public OkHttpClientBuilder setEventListenerFactory(EventListener.Factory eventListenerFactory) { + this.eventListenerFactory = eventListenerFactory; + return this; + } + + @Override + public OkHttpClientBuilder setRetryOnConnectionFailure(Boolean retryOnConnectionFailure) { + this.retryOnConnectionFailure = retryOnConnectionFailure; + return this; + } + + @Override + public OkHttpClientBuilder setFollowRedirects(Boolean followRedirects) { + this.followRedirects = followRedirects; + return this; + } + + @Override + public OkHttpClientBuilder connectTimeout(Long timeout, TimeUnit unit) { + this.connectTimeout = timeout; + this.connectTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder callTimeout(Long timeout, TimeUnit unit) { + this.callTimeout = timeout; + this.callTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder readTimeout(Long timeout, TimeUnit unit) { + this.readTimeout = timeout; + this.readTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder writeTimeout(Long timeout, TimeUnit unit) { + this.writeTimeout = timeout; + this.writeTimeUnit = unit; + return this; + } + + @Override + public OkHttpClientBuilder setPingInterval(Integer pingInterval) { + this.pingInterval = pingInterval; + return this; + } + + private synchronized void prepare() { + OkHttpClient.Builder builder = new OkHttpClient.Builder(); + if (this.authenticator != null) { + builder.authenticator(this.authenticator); + } + if (this.proxy != null) { + builder.proxy(this.proxy); + } + for (Interceptor interceptor : this.interceptorList) { + builder.addInterceptor(interceptor); + } + if (this.dispatcher != null) { + builder.dispatcher(dispatcher); + } + if (this.connectionPool != null) { + builder.connectionPool(connectionPool); + } + if (this.eventListenerFactory != null) { + builder.eventListenerFactory(this.eventListenerFactory); + } + if (this.retryOnConnectionFailure != null) { + builder.setRetryOnConnectionFailure$okhttp(this.retryOnConnectionFailure); + } + if (this.followRedirects != null) { + builder.followRedirects(this.followRedirects); + } + if (this.dns != null) { + builder.dns(this.dns); + } + if (this.connectTimeout != null && this.connectTimeUnit != null) { + builder.connectTimeout(this.connectTimeout, this.connectTimeUnit); + } + if (this.callTimeout != null && this.callTimeUnit != null) { + builder.callTimeout(this.callTimeout, this.callTimeUnit); + } + if (this.readTimeout != null && this.readTimeUnit != null) { + builder.readTimeout(this.readTimeout, this.readTimeUnit); + } + if (this.writeTimeout != null && this.writeTimeUnit != null) { + builder.writeTimeout(this.writeTimeout, this.writeTimeUnit); + } + if (this.pingInterval != null) { + builder.setPingInterval$okhttp(this.pingInterval); + } + this.okHttpClient = builder.build(); + } +} diff --git a/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilderTest.java b/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilderTest.java new file mode 100644 index 000000000..d742845b6 --- /dev/null +++ b/weixin-java-common/src/test/java/me/chanjar/weixin/common/util/http/okhttp/DefaultOkHttpClientBuilderTest.java @@ -0,0 +1,66 @@ +package me.chanjar.weixin.common.util.http.okhttp; + +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.Response; +import org.testng.Assert; +import org.testng.annotations.Test; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +public class DefaultOkHttpClientBuilderTest { + @Test + public void testBuild() throws Exception { + DefaultOkHttpClientBuilder builder1 = DefaultOkHttpClientBuilder.get(); + DefaultOkHttpClientBuilder builder2 = DefaultOkHttpClientBuilder.get(); + Assert.assertSame(builder1, builder2, "DefaultOkHttpClientBuilder为单例,获取到的对象应该相同"); + List threadList = new ArrayList<>(10); + for (int i = 0; i < 10; i++) { + DefaultOkHttpClientBuilderTest.TestThread thread = new DefaultOkHttpClientBuilderTest.TestThread(); + thread.start(); + threadList.add(thread); + } + for (DefaultOkHttpClientBuilderTest.TestThread testThread : threadList) { + testThread.join(); + Assert.assertNotEquals(-1, testThread.getRespState(), "请求响应code不应为-1"); + } + + for (int i = 1; i < threadList.size(); i++) { + DefaultOkHttpClientBuilderTest.TestThread thread1 = threadList.get(i - 1); + DefaultOkHttpClientBuilderTest.TestThread thread2 = threadList.get(i); + Assert.assertSame( + thread1.getClient(), + thread2.getClient(), + "DefaultOkHttpClientBuilderTest为单例,并持有了相同的OkHttpClient" + ); + } + } + + public static class TestThread extends Thread { + private OkHttpClient client; + private int respState = -1; + + @Override + public void run() { + client = DefaultOkHttpClientBuilder.get().build(); + Request request = new Request.Builder() + .url("http://www.sina.com.cn/") + .build(); + try (Response response = client.newCall(request).execute()) { + respState = response.code(); + } catch (IOException e) { + // ignore + } + } + + public OkHttpClient getClient() { + return client; + } + + public int getRespState() { + return respState; + } + } +} diff --git a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java index 733f68e24..73b933f64 100644 --- a/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java +++ b/weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpServiceOkHttpImpl.java @@ -6,6 +6,7 @@ import me.chanjar.weixin.common.enums.WxType; import me.chanjar.weixin.common.error.WxError; import me.chanjar.weixin.common.error.WxErrorException; import me.chanjar.weixin.common.util.http.HttpType; +import me.chanjar.weixin.common.util.http.okhttp.DefaultOkHttpClientBuilder; import me.chanjar.weixin.common.util.http.okhttp.OkHttpProxyInfo; import me.chanjar.weixin.cp.config.WxCpConfigStorage; import okhttp3.*; @@ -82,12 +83,8 @@ public class WxCpServiceOkHttpImpl extends BaseWxCpServiceImpl 0) { httpProxy = OkHttpProxyInfo.httpProxy(wxMpConfigStorage.getHttpProxyHost(), wxMpConfigStorage.getHttpProxyPort(), - wxMpConfigStorage.getHttpProxyUsername(), wxMpConfigStorage.getHttpProxyPassword()); - } - - OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder(); - if (httpProxy != null) { + wxMpConfigStorage.getHttpProxyUsername(), wxMpConfigStorage.getHttpProxyPassword()); + OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder(); clientBuilder.proxy(getRequestHttpProxy().getProxy()); // 设置授权 @@ -91,8 +89,10 @@ public class WxQidianServiceOkHttpImpl extends BaseWxQidianServiceImpl