HttpConfig (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.http.HttpConfig

```
public class HttpConfig
extends Object
```
Http配置项

Since:

5.8.0

Author:

looly

Constructor Summary

Constructors
Constructor and Description

HttpConfig()

Constructors
Constructor and Description
`HttpConfig()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpConfig`	`addRequestInterceptor(HttpInterceptor<HttpRequest> interceptor)` 设置拦截器，用于在请求前重新编辑请求
`HttpConfig`	`addResponseInterceptor(HttpInterceptor<HttpResponse> interceptor)` 设置拦截器，用于在请求前重新编辑请求
`static HttpConfig`	`create()` 创建默认Http配置信息
`HttpConfig`	`disableCache()` 禁用缓存
`HttpConfig`	`setBlockSize(int blockSize)` 采用流方式上传数据，无需本地缓存数据。
`HttpConfig`	`setConnectionTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`HttpConfig`	`setDecodeUrl(boolean decodeUrl)` 设置是否忽略解码URL，包括URL中的Path部分和Param部分。
`HttpConfig`	`setFollowRedirectsCookie(boolean followRedirectsCookie)` 自动重定向时是否处理cookie
`HttpConfig`	`setHostnameVerifier(HostnameVerifier hostnameVerifier)` 设置域名验证器只针对HTTPS请求，如果不设置，不做验证，所有域名被信任
`HttpConfig`	`setHttpProxy(String host, int port)` 设置Http代理
`HttpConfig`	`setIgnoreEOFError(boolean ignoreEOFError)` 设置是否忽略响应读取时可能的EOF异常。
`HttpConfig`	`setInterceptorOnRedirect(boolean interceptorOnRedirect)` 重定向时是否使用拦截器
`HttpConfig`	`setMaxRedirectCount(int maxRedirectCount)` 设置最大重定向次数如果次数小于1则表示不重定向，大于等于1表示打开重定向
`HttpConfig`	`setProxy(Proxy proxy)` 设置代理
`HttpConfig`	`setReadTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`HttpConfig`	`setSSLProtocol(String protocol)` 设置HTTPS安全连接协议，只针对HTTPS请求，可以使用的协议包括：此方法调用后`setSSLSocketFactory(SSLSocketFactory)` 将被覆盖。
`HttpConfig`	`setSSLSocketFactory(SSLSocketFactory ssf)` 设置SSLSocketFactory 只针对HTTPS请求，如果不设置，使用默认的SSLSocketFactory 默认SSLSocketFactory为：SSLSocketFactoryBuilder.create().build();
`HttpConfig`	`setUseDefaultContentTypeIfNull(boolean useDefaultContentTypeIfNull)` 设置是否使用默认Content-Type，如果请求中未设置Content-Type，是否使用默认值
`HttpConfig`	`timeout(int milliseconds)` 设置超时，单位：毫秒超时包括： 1.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HttpConfig
```
public HttpConfig()
```
- Method Detail
  - create
```
public static HttpConfig create()
```
    创建默认Http配置信息
    
    Returns:
    
    HttpConfig
  - timeout
```
public HttpConfig timeout(int milliseconds)
```
    设置超时，单位：毫秒
    超时包括：
```
 1. 连接超时
 2. 读取响应超时
 
```
    Parameters:
    
    milliseconds - 超时毫秒数
    
    Returns:
    
    this
    
    See Also:
    
    setConnectionTimeout(int), setReadTimeout(int)
  - setConnectionTimeout
```
public HttpConfig setConnectionTimeout(int milliseconds)
```
    设置连接超时，单位：毫秒
    
    Parameters:
    
    milliseconds - 超时毫秒数
    
    Returns:
    
    this
  - setReadTimeout
```
public HttpConfig setReadTimeout(int milliseconds)
```
    设置连接超时，单位：毫秒
    
    Parameters:
    
    milliseconds - 超时毫秒数
    
    Returns:
    
    this
  - disableCache
```
public HttpConfig disableCache()
```
    禁用缓存
    
    Returns:
    
    this
  - setMaxRedirectCount
```
public HttpConfig setMaxRedirectCount(int maxRedirectCount)
```
    设置最大重定向次数
    如果次数小于1则表示不重定向，大于等于1表示打开重定向
    
    Parameters:
    
    maxRedirectCount - 最大重定向次数
    
    Returns:
    
    this
  - setHostnameVerifier
```
public HttpConfig setHostnameVerifier(HostnameVerifier hostnameVerifier)
```
    设置域名验证器
    只针对HTTPS请求，如果不设置，不做验证，所有域名被信任
    
    Parameters:
    
    hostnameVerifier - HostnameVerifier
    
    Returns:
    
    this
  - setHttpProxy
```
public HttpConfig setHttpProxy(String host,
                               int port)
```
    设置Http代理
    
    Parameters:
    
    host - 代理主机
    
    port - 代理端口
    
    Returns:
    
    this
  - setProxy
```
public HttpConfig setProxy(Proxy proxy)
```
    设置代理
    
    Parameters:
    
    proxy - 代理 Proxy
    
    Returns:
    
    this
  - setSSLSocketFactory
```
public HttpConfig setSSLSocketFactory(SSLSocketFactory ssf)
```
    设置SSLSocketFactory
    只针对HTTPS请求，如果不设置，使用默认的SSLSocketFactory
    默认SSLSocketFactory为：SSLSocketFactoryBuilder.create().build();
    
    Parameters:
    
    ssf - SSLScketFactory
    
    Returns:
    
    this
  - setSSLProtocol
```
public HttpConfig setSSLProtocol(String protocol)
```
    设置HTTPS安全连接协议，只针对HTTPS请求，可以使用的协议包括：
    此方法调用后setSSLSocketFactory(SSLSocketFactory) 将被覆盖。
```
 1. TLSv1.2
 2. TLSv1.1
 3. SSLv3
 ...
 
```
    Parameters:
    
    protocol - 协议
    
    Returns:
    
    this
    
    See Also:
    
    SSLUtil.createSSLContext(String), setSSLSocketFactory(SSLSocketFactory)
  - setBlockSize
```
public HttpConfig setBlockSize(int blockSize)
```
    采用流方式上传数据，无需本地缓存数据。
    HttpUrlConnection默认是将所有数据读到本地缓存，然后再发送给服务器，这样上传大文件时就会导致内存溢出。
    
    Parameters:
    
    blockSize - 块大小（bytes数），0或小于0表示不设置Chuncked模式
    
    Returns:
    
    this
  - setIgnoreEOFError
```
public HttpConfig setIgnoreEOFError(boolean ignoreEOFError)
```
    设置是否忽略响应读取时可能的EOF异常。
    在Http协议中，对于Transfer-Encoding: Chunked在正常情况下末尾会写入一个Length为0的的chunk标识完整结束。
    如果服务端未遵循这个规范或响应没有正常结束，会报EOF异常，此选项用于是否忽略这个异常。
    
    Parameters:
    
    ignoreEOFError - 是否忽略响应读取时可能的EOF异常。
    
    Returns:
    
    this
    
    Since:
    
    5.7.20
  - setDecodeUrl
```
public HttpConfig setDecodeUrl(boolean decodeUrl)
```
    设置是否忽略解码URL，包括URL中的Path部分和Param部分。
    在构建Http请求时，用户传入的URL可能有编码后和未编码的内容混合在一起，如果此参数为true，则会统一解码编码后的参数，
    按照RFC3986规范，在发送请求时，全部编码之。如果为false，则不会解码已经编码的内容，在请求时只编码需要编码的部分。
    
    Parameters:
    
    decodeUrl - 是否忽略解码URL
    
    Returns:
    
    this
  - addRequestInterceptor
```
public HttpConfig addRequestInterceptor(HttpInterceptor<HttpRequest> interceptor)
```
    设置拦截器，用于在请求前重新编辑请求
    
    Parameters:
    
    interceptor - 拦截器实现
    
    Returns:
    
    this
  - addResponseInterceptor
```
public HttpConfig addResponseInterceptor(HttpInterceptor<HttpResponse> interceptor)
```
    设置拦截器，用于在请求前重新编辑请求
    
    Parameters:
    
    interceptor - 拦截器实现
    
    Returns:
    
    this
  - setInterceptorOnRedirect
```
public HttpConfig setInterceptorOnRedirect(boolean interceptorOnRedirect)
```
    重定向时是否使用拦截器
    
    Parameters:
    
    interceptorOnRedirect - 重定向时是否使用拦截器
    
    Returns:
    
    this
  - setFollowRedirectsCookie
```
public HttpConfig setFollowRedirectsCookie(boolean followRedirectsCookie)
```
    自动重定向时是否处理cookie
    
    Parameters:
    
    followRedirectsCookie - 自动重定向时是否处理cookie
    
    Returns:
    
    this
    
    Since:
    
    5.8.15
  - setUseDefaultContentTypeIfNull
```
public HttpConfig setUseDefaultContentTypeIfNull(boolean useDefaultContentTypeIfNull)
```
    设置是否使用默认Content-Type，如果请求中未设置Content-Type，是否使用默认值
    
    Parameters:
    
    useDefaultContentTypeIfNull - 是否使用默认Content-Type
    
    Returns:
    
    this
    
    Since:
    
    5.8.33

Class HttpConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpConfig

Method Detail

create

timeout

setConnectionTimeout

setReadTimeout

disableCache

setMaxRedirectCount

setHostnameVerifier

setHttpProxy

setProxy

setSSLSocketFactory

setSSLProtocol

setBlockSize

setIgnoreEOFError

setDecodeUrl

addRequestInterceptor

addResponseInterceptor

setInterceptorOnRedirect

setFollowRedirectsCookie

setUseDefaultContentTypeIfNull