HttpConnection (hutool 5.8.36 API)

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

```
public class HttpConnection
extends Object
```
http连接对象，对HttpURLConnection的包装

Author:

Looly

Constructor Summary

Constructors
Constructor and Description

HttpConnection(URL url, Proxy proxy)
构造HttpConnection

Constructors
Constructor and Description
`HttpConnection(URL url, Proxy proxy)` 构造HttpConnection

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpConnection`	`connect()` 连接
`static HttpConnection`	`create(String urlStr, Proxy proxy)` 创建HttpConnection
`static HttpConnection`	`create(URL url, Proxy proxy)` 创建HttpConnection
`HttpConnection`	`disableCache()` 关闭缓存
`HttpConnection`	`disconnect()` 断开连接
`HttpConnection`	`disconnectQuietly()` 静默断开连接。
`Charset`	`getCharset()` 获取字符集编码从Http连接的头信息中获得字符集从ContentType中获取
`String`	`getCharsetName()` 获得字符集编码从Http连接的头信息中获得字符集从ContentType中获取
`InputStream`	`getErrorStream()` 当返回错误代码时，获得错误内容流
`HttpURLConnection`	`getHttpURLConnection()` 获取HttpURLConnection对象
`InputStream`	`getInputStream()` 获得输入流对象输入流对象用于读取数据
`Method`	`getMethod()` 获取请求方法,GET/POST
`OutputStream`	`getOutputStream()` 获取输出流对象输出流对象用于发送数据
`Proxy`	`getProxy()` 获得代理
`URL`	`getUrl()` 获取请求URL
`String`	`header(Header name)` 获取Http请求头
`HttpConnection`	`header(Header header, String value, boolean isOverride)` 设置请求头当请求头存在时，覆盖之
`HttpConnection`	`header(Map<String,List<String>> headerMap, boolean isOverride)` 设置请求头不覆盖原有请求头
`String`	`header(String name)` 获取Http请求头
`HttpConnection`	`header(String header, String value, boolean isOverride)` 设置请求头当请求头存在时，覆盖之
`Map<String,List<String>>`	`headers()` 获取所有Http请求头
`HttpConnection`	`initConn()` 初始化连接相关信息
`int`	`responseCode()` 获取响应码
`HttpConnection`	`setChunkedStreamingMode(int blockSize)` 采用流方式上传数据，无需本地缓存数据。
`HttpConnection`	`setConnectionAndReadTimeout(int timeout)` 设置连接和读取的超时时间
`HttpConnection`	`setConnectTimeout(int timeout)` 设置连接超时
`HttpConnection`	`setCookie(String cookie)` 设置Cookie
`HttpConnection`	`setFixedLengthStreamingMode(long contentLength)` 设置固定长度的流模式，会设置HTTP请求头中的Content-Length字段，告知服务器整个请求体的精确字节大小。
`HttpConnection`	`setHttpsInfo(HostnameVerifier hostnameVerifier, SSLSocketFactory ssf)` 设置https请求参数有些时候htts请求会出现com.sun.net.ssl.internal.www.protocol.https.HttpsURLConnectionOldImpl的实现，此为sun内部api，按照普通http请求处理
`HttpConnection`	`setInstanceFollowRedirects(boolean isInstanceFollowRedirects)` 设置自动HTTP 30X跳转
`HttpConnection`	`setMethod(Method method)` 设置请求方法
`HttpConnection`	`setReadTimeout(int timeout)` 设置读取超时
`String`	`toString()`

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

- Constructor Detail
  - HttpConnection
```
public HttpConnection(URL url,
                      Proxy proxy)
```
    构造HttpConnection
    
    Parameters:
    
    url - URL
    
    proxy - 代理
- Method Detail
  - create
```
public static HttpConnection create(String urlStr,
                                    Proxy proxy)
```
    创建HttpConnection
    
    Parameters:
    
    urlStr - URL
    
    proxy - 代理，无代理传null
    
    Returns:
    
    HttpConnection
  - create
```
public static HttpConnection create(URL url,
                                    Proxy proxy)
```
    创建HttpConnection
    
    Parameters:
    
    url - URL
    
    proxy - 代理，无代理传null
    
    Returns:
    
    HttpConnection
  - initConn
```
public HttpConnection initConn()
```
    初始化连接相关信息
    
    Returns:
    
    HttpConnection
    
    Since:
    
    4.4.1
  - getMethod
```
public Method getMethod()
```
    获取请求方法,GET/POST
    
    Returns:
    
    请求方法, GET/POST
  - setMethod
```
public HttpConnection setMethod(Method method)
```
    设置请求方法
    
    Parameters:
    
    method - 请求方法
    
    Returns:
    
    自己
  - getUrl
```
public URL getUrl()
```
    获取请求URL
    
    Returns:
    
    请求URL
  - getProxy
```
public Proxy getProxy()
```
    获得代理
    
    Returns:
    
    Proxy
  - getHttpURLConnection
```
public HttpURLConnection getHttpURLConnection()
```
    获取HttpURLConnection对象
    
    Returns:
    
    HttpURLConnection
  - header
```
public HttpConnection header(String header,
                             String value,
                             boolean isOverride)
```
    设置请求头
    当请求头存在时，覆盖之
    
    Parameters:
    
    header - 头名
    
    value - 头值
    
    isOverride - 是否覆盖旧值
    
    Returns:
    
    HttpConnection
  - header
```
public HttpConnection header(Header header,
                             String value,
                             boolean isOverride)
```
    设置请求头
    当请求头存在时，覆盖之
    
    Parameters:
    
    header - 头名
    
    value - 头值
    
    isOverride - 是否覆盖旧值
    
    Returns:
    
    HttpConnection
  - header
```
public HttpConnection header(Map<String,List<String>> headerMap,
                             boolean isOverride)
```
    设置请求头
    不覆盖原有请求头
    
    Parameters:
    
    headerMap - 请求头
    
    isOverride - 是否覆盖
    
    Returns:
    
    this
  - header
```
public String header(String name)
```
    获取Http请求头
    
    Parameters:
    
    name - Header名
    
    Returns:
    
    Http请求头值
  - header
```
public String header(Header name)
```
    获取Http请求头
    
    Parameters:
    
    name - Header名
    
    Returns:
    
    Http请求头值
  - headers
```
public Map<String,List<String>> headers()
```
    获取所有Http请求头
    
    Returns:
    
    Http请求头Map
  - setHttpsInfo
```
public HttpConnection setHttpsInfo(HostnameVerifier hostnameVerifier,
                                   SSLSocketFactory ssf)
                            throws HttpException
```
    设置https请求参数
    有些时候htts请求会出现com.sun.net.ssl.internal.www.protocol.https.HttpsURLConnectionOldImpl的实现，此为sun内部api，按照普通http请求处理
    
    Parameters:
    
    hostnameVerifier - 域名验证器，非https传入null
    
    ssf - SSLSocketFactory，非https传入null
    
    Returns:
    
    this
    
    Throws:
    
    HttpException - KeyManagementException和NoSuchAlgorithmException异常包装
  - disableCache
```
public HttpConnection disableCache()
```
    关闭缓存
    
    Returns:
    
    this
    
    See Also:
    
    URLConnection.setUseCaches(boolean)
  - setConnectTimeout
```
public HttpConnection setConnectTimeout(int timeout)
```
    设置连接超时
    
    Parameters:
    
    timeout - 超时
    
    Returns:
    
    this
  - setReadTimeout
```
public HttpConnection setReadTimeout(int timeout)
```
    设置读取超时
    
    Parameters:
    
    timeout - 超时
    
    Returns:
    
    this
  - setConnectionAndReadTimeout
```
public HttpConnection setConnectionAndReadTimeout(int timeout)
```
    设置连接和读取的超时时间
    
    Parameters:
    
    timeout - 超时时间
    
    Returns:
    
    this
  - setCookie
```
public HttpConnection setCookie(String cookie)
```
    设置Cookie
    
    Parameters:
    
    cookie - Cookie
    
    Returns:
    
    this
  - setFixedLengthStreamingMode
```
public HttpConnection setFixedLengthStreamingMode(long contentLength)
```
    设置固定长度的流模式，会设置HTTP请求头中的Content-Length字段，告知服务器整个请求体的精确字节大小。
    这在上传文件或大数据量时非常有用，因为它允许服务器准确地知道何时接收完所有的请求数据，而不需要依赖于连接的关闭来判断数据传输的结束。
    
    Parameters:
    
    contentLength - 固定长度
    
    Returns:
    
    this
  - setChunkedStreamingMode
```
public HttpConnection setChunkedStreamingMode(int blockSize)
```
    采用流方式上传数据，无需本地缓存数据。
    HttpUrlConnection默认是将所有数据读到本地缓存，然后再发送给服务器，这样上传大文件时就会导致内存溢出。
    
    Parameters:
    
    blockSize - 块大小（bytes数），0或小于0表示不设置Chuncked模式
    
    Returns:
    
    this
  - setInstanceFollowRedirects
```
public HttpConnection setInstanceFollowRedirects(boolean isInstanceFollowRedirects)
```
    设置自动HTTP 30X跳转
    
    Parameters:
    
    isInstanceFollowRedirects - 是否自定跳转
    
    Returns:
    
    this
  - connect
```
public HttpConnection connect()
                       throws IOException
```
    连接
    
    Returns:
    
    this
    
    Throws:
    
    IOException - IO异常
  - disconnectQuietly
```
public HttpConnection disconnectQuietly()
```
    静默断开连接。不抛出异常
    
    Returns:
    
    this
    
    Since:
    
    4.6.0
  - disconnect
```
public HttpConnection disconnect()
```
    断开连接
    
    Returns:
    
    this
  - getInputStream
```
public InputStream getInputStream()
                           throws IOException
```
    获得输入流对象
    输入流对象用于读取数据
    
    Returns:
    
    输入流对象
    
    Throws:
    
    IOException - IO异常
  - getErrorStream
```
public InputStream getErrorStream()
```
    当返回错误代码时，获得错误内容流
    
    Returns:
    
    错误内容
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    获取输出流对象输出流对象用于发送数据
    
    Returns:
    
    OutputStream
    
    Throws:
    
    IOException - IO异常
  - responseCode
```
public int responseCode()
                 throws IOException
```
    获取响应码
    
    Returns:
    
    响应码
    
    Throws:
    
    IOException - IO异常
  - getCharsetName
```
public String getCharsetName()
```
    获得字符集编码
    从Http连接的头信息中获得字符集
    从ContentType中获取
    
    Returns:
    
    字符集编码
  - getCharset
```
public Charset getCharset()
```
    获取字符集编码
    从Http连接的头信息中获得字符集
    从ContentType中获取
    
    Returns:
    
    Charset编码
    
    Since:
    
    3.0.9
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class HttpConnection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpConnection

Method Detail

create

create

initConn

getMethod

setMethod

getUrl

getProxy

getHttpURLConnection

header

header

header

header

header

headers

setHttpsInfo

disableCache

setConnectTimeout

setReadTimeout

setConnectionAndReadTimeout

setCookie

setFixedLengthStreamingMode

setChunkedStreamingMode

setInstanceFollowRedirects

connect

disconnectQuietly

disconnect

getInputStream

getErrorStream

getOutputStream

responseCode

getCharsetName

getCharset

toString