org.dromara.hutool.http.client

Class ClientConfig

java.lang.Object

org.dromara.hutool.http.client.ClientConfig

Direct Known Subclasses:

ApacheHttpClientConfig, OkHttpClientConfig

public class ClientConfig
extends Object

Http客户端配置

Author:

looly

Constructor Summary

Constructors

Constructor and Description
ClientConfig() 构造

Method Summary

Modifier and Type	Method and Description
ClientConfig	enableSSLVerify() 打开SSL验证，即使用引擎默认的SSL验证方式
int	getConnectionTimeout() 获取连接超时，单位：毫秒
ProxyInfo	getProxy() 获取代理
int	getReadTimeout() 获取读取超时，单位：毫秒
SSLInfo	getSslInfo() 获取SSLInfo
boolean	isDisableCache() 是否禁用缓存
boolean	isUseCookieManager() 是否使用引擎默认的Cookie管理器，默认为true 默认情况下每个客户端维护一个自己的Cookie管理器，这个管理器用于在多次请求中记录并自动附带Cookie信息 如请求登录后，服务器返回Set-Cookie信息，Cookie管理器记录之，后续请求会自动带上这个Cookie信息，从而实现会话保持。
static ClientConfig	of() 创建新的 ClientConfig
ClientConfig	setConnectionTimeout(int connectionTimeout) 设置连接超时，单位：毫秒
void	setDisableCache(boolean disableCache) 设置是否禁用缓存
ClientConfig	setHttpProxy(String host, int port) 设置Http代理
ClientConfig	setProxy(ProxyInfo proxy) 设置代理
ClientConfig	setReadTimeout(int readTimeout) 设置读取超时，单位：毫秒
ClientConfig	setSSLInfo(SSLInfo sslInfo) 设置SSLInfo 只针对HTTPS请求，如果不设置，使用默认的SSLInfo.TRUST_ANY
ClientConfig	setTimeout(int milliseconds) 设置超时，单位：毫秒 超时包括： 1.
ClientConfig	setUseCookieManager(boolean useCookieManager) 是否使用引擎默认的Cookie管理器，默认为true 默认情况下每个客户端维护一个自己的Cookie管理器，这个管理器用于在多次请求中记录并自动附带Cookie信息 如请求登录后，服务器返回Set-Cookie信息，Cookie管理器记录之，后续请求会自动带上这个Cookie信息，从而实现会话保持。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientConfig

public ClientConfig()

构造

Method Detail

of

public static ClientConfig of()

创建新的 ClientConfig

Returns:

ClientConfig

setTimeout

public ClientConfig setTimeout(int milliseconds)

设置超时，单位：毫秒
超时包括：

 1. 连接超时
 2. 读取响应超时
 

Parameters:

milliseconds - 超时毫秒数

Returns:

this

See Also:

setConnectionTimeout(int), setReadTimeout(int)

getConnectionTimeout

public int getConnectionTimeout()

获取连接超时，单位：毫秒

Returns:

连接超时，单位：毫秒

setConnectionTimeout

public ClientConfig setConnectionTimeout(int connectionTimeout)

设置连接超时，单位：毫秒

Parameters:

connectionTimeout - 超时毫秒数

Returns:

this

getReadTimeout

public int getReadTimeout()

获取读取超时，单位：毫秒

Returns:

读取超时，单位：毫秒

setReadTimeout

public ClientConfig setReadTimeout(int readTimeout)

设置读取超时，单位：毫秒

Parameters:

readTimeout - 读取超时，单位：毫秒

Returns:

this

getSslInfo

public SSLInfo getSslInfo()

获取SSLInfo

Returns:

SSLInfo

setSSLInfo

public ClientConfig setSSLInfo(SSLInfo sslInfo)

设置SSLInfo
只针对HTTPS请求，如果不设置，使用默认的SSLInfo.TRUST_ANY

Parameters:

sslInfo - SSLInfo

Returns:

this

enableSSLVerify

public ClientConfig enableSSLVerify()

打开SSL验证，即使用引擎默认的SSL验证方式

Returns:

this

isDisableCache

public boolean isDisableCache()

是否禁用缓存

Returns:

是否禁用缓存

setDisableCache

public void setDisableCache(boolean disableCache)

设置是否禁用缓存

Parameters:

disableCache - 是否禁用缓存

getProxy

public ProxyInfo getProxy()

获取代理

Returns:

代理

setHttpProxy

public ClientConfig setHttpProxy(String host,
                                 int port)

设置Http代理

Parameters:

host - 代理 主机

port - 代理 端口

Returns:

this

setProxy

public ClientConfig setProxy(ProxyInfo proxy)

设置代理

Parameters:

proxy - 代理 ProxyInfo

Returns:

this

isUseCookieManager

public boolean isUseCookieManager()

是否使用引擎默认的Cookie管理器，默认为true
默认情况下每个客户端维护一个自己的Cookie管理器，这个管理器用于在多次请求中记录并自动附带Cookie信息
如请求登录后，服务器返回Set-Cookie信息，Cookie管理器记录之，后续请求会自动带上这个Cookie信息，从而实现会话保持。

Returns:

是否使用引擎默认的Cookie管理器

setUseCookieManager

public ClientConfig setUseCookieManager(boolean useCookieManager)

是否使用引擎默认的Cookie管理器，默认为true
默认情况下每个客户端维护一个自己的Cookie管理器，这个管理器用于在多次请求中记录并自动附带Cookie信息
如请求登录后，服务器返回Set-Cookie信息，Cookie管理器记录之，后续请求会自动带上这个Cookie信息，从而实现会话保持。

Parameters:

useCookieManager - 是否使用引擎默认的Cookie管理器

Returns:

this