org.dromara.hutool.http.client.engine.jdk

Class JdkHttpConnection

java.lang.Object

org.dromara.hutool.http.client.engine.jdk.JdkHttpConnection

All Implemented Interfaces:

Closeable, AutoCloseable, HeaderOperation<JdkHttpConnection>

public class JdkHttpConnection
extends Object
implements HeaderOperation<JdkHttpConnection>, Closeable

http连接对象，对HttpURLConnection的包装

Author:

Looly

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() 断开连接
JdkHttpConnection	closeQuietly() 静默断开连接。
JdkHttpConnection	connect() 连接
int	getCode() 获取响应码
InputStream	getErrorStream() 当返回错误代码时，获得错误内容流
HttpURLConnection	getHttpURLConnection() 获取HttpURLConnection对象
InputStream	getInputStream() 获得输入流对象 输入流对象用于读取数据
Method	getMethod() 获取请求方法,GET/POST
OutputStream	getOutputStream() 获取输出流对象 输出流对象用于发送数据
Proxy	getProxy() 获得代理
URL	getUrl() 获取请求URL
String	header(String name) 获取Http请求头
JdkHttpConnection	header(String header, String value, boolean isOverride) 设置请求头 当请求头存在时，覆盖之
Map<String,List<String>>	headers() 获取所有Http请求头
static JdkHttpConnection	of(String urlStr, Proxy proxy) 创建HttpConnection
static JdkHttpConnection	of(URL url, Proxy proxy) 创建HttpConnection
JdkHttpConnection	setChunkedStreamingMode(int blockSize) 采用流方式上传数据，无需本地缓存数据。
JdkHttpConnection	setConnectionAndReadTimeout(int timeout) 设置连接和读取的超时时间
JdkHttpConnection	setConnectTimeout(int timeout) 设置连接超时
JdkHttpConnection	setDisableCache(boolean isDisableCache) 是否禁用缓存
JdkHttpConnection	setFixedLengthStreamingMode(long contentLength) 设置固定长度的流模式，会设置HTTP请求头中的Content-Length字段，告知服务器整个请求体的精确字节大小。
JdkHttpConnection	setInstanceFollowRedirects(boolean isInstanceFollowRedirects) 设置自动HTTP 30X跳转
JdkHttpConnection	setMethod(Method method) 设置请求方法
JdkHttpConnection	setReadTimeout(int timeout) 设置读取超时
JdkHttpConnection	setSSLInfo(SSLInfo sslInfo) 设置https中SSL相关请求参数 有些时候htts请求会出现com.sun.net.ssl.internal.www.protocol.https.HttpsURLConnectionOldImpl的实现，此为sun内部api，按照普通http请求处理
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dromara.hutool.http.client.HeaderOperation

auth, basicAuth, bearerAuth, contentEncoding, contentLength, contentType, cookie, cookie, cookie, disableCookie, enableDefaultCookie, header, header, header, header, header, header, isChunked, keepAlive, proxyAuth

Constructor Detail

JdkHttpConnection

public JdkHttpConnection(URL url,
                         Proxy proxy)

构造HttpConnection

Parameters:

url - URL

proxy - 代理

Method Detail

of

public static JdkHttpConnection of(String urlStr,
                                   Proxy proxy)

创建HttpConnection

Parameters:

urlStr - URL

proxy - 代理，无代理传null

Returns:

HttpConnection

of

public static JdkHttpConnection of(URL url,
                                   Proxy proxy)

创建HttpConnection

Parameters:

url - URL

proxy - 代理，无代理传null

Returns:

HttpConnection

getMethod

public Method getMethod()

获取请求方法,GET/POST

Returns:

请求方法, GET/POST

setMethod

public JdkHttpConnection 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

setDisableCache

public JdkHttpConnection setDisableCache(boolean isDisableCache)

是否禁用缓存

Parameters:

isDisableCache - 是否禁用缓存

Returns:

this

See Also:

URLConnection.setUseCaches(boolean)

setConnectTimeout

public JdkHttpConnection setConnectTimeout(int timeout)

设置连接超时

Parameters:

timeout - 超时

Returns:

this

setReadTimeout

public JdkHttpConnection setReadTimeout(int timeout)

设置读取超时

Parameters:

timeout - 超时

Returns:

this

setConnectionAndReadTimeout

public JdkHttpConnection setConnectionAndReadTimeout(int timeout)

设置连接和读取的超时时间

Parameters:

timeout - 超时时间

Returns:

this

setSSLInfo

public JdkHttpConnection setSSLInfo(SSLInfo sslInfo)
                             throws HttpException

设置https中SSL相关请求参数
有些时候htts请求会出现com.sun.net.ssl.internal.www.protocol.https.HttpsURLConnectionOldImpl的实现，此为sun内部api，按照普通http请求处理

Parameters:

sslInfo - SSLInfo

Returns:

this

Throws:

HttpException - KeyManagementException和NoSuchAlgorithmException异常包装

Since:

6.0.0

setFixedLengthStreamingMode

public JdkHttpConnection setFixedLengthStreamingMode(long contentLength)

设置固定长度的流模式，会设置HTTP请求头中的Content-Length字段，告知服务器整个请求体的精确字节大小。
这在上传文件或大数据量时非常有用，因为它允许服务器准确地知道何时接收完所有的请求数据，而不需要依赖于连接的关闭来判断数据传输的结束。

Parameters:

contentLength - 请求体的长度。如果内容长度大于0，则启用固定长度流模式。

Returns:

this

setChunkedStreamingMode

public JdkHttpConnection setChunkedStreamingMode(int blockSize)

采用流方式上传数据，无需本地缓存数据。
HttpUrlConnection默认是将所有数据读到本地缓存，然后再发送给服务器，这样上传大文件时就会导致内存溢出。

Parameters:

blockSize - 块大小（bytes数），0或小于0表示不设置Chuncked模式

Returns:

this

setInstanceFollowRedirects

public JdkHttpConnection setInstanceFollowRedirects(boolean isInstanceFollowRedirects)

设置自动HTTP 30X跳转

Parameters:

isInstanceFollowRedirects - 是否自定跳转

Returns:

this

header

public JdkHttpConnection header(String header,
                                String value,
                                boolean isOverride)

设置请求头
当请求头存在时，覆盖之

Specified by:

header in interface HeaderOperation<JdkHttpConnection>

Parameters:

header - 头名

value - 头值

isOverride - 是否覆盖旧值

Returns:

HttpConnection

header

public String header(String name)

获取Http请求头

Specified by:

header in interface HeaderOperation<JdkHttpConnection>

Parameters:

name - Header名

Returns:

Http请求头值

headers

public Map<String,List<String>> headers()

获取所有Http请求头

Specified by:

headers in interface HeaderOperation<JdkHttpConnection>

Returns:

Http请求头Map

connect

public JdkHttpConnection connect()
                          throws IOException

连接

Returns:

this

Throws:

IOException - IO异常

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异常

getCode

public int getCode()
            throws IOException

获取响应码

Returns:

响应码

Throws:

IOException - IO异常

toString

public String toString()

Overrides:

toString in class Object

closeQuietly

public JdkHttpConnection closeQuietly()

静默断开连接。不抛出异常

Returns:

this

Since:

4.6.0

close

public void close()

断开连接

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable