HttpClient (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.tools.pool.PooledObject
- - org.voovan.http.client.HttpClient

All Implemented Interfaces:

Closeable, AutoCloseable, IPooledObject
```
public class HttpClient
extends PooledObject
implements Closeable
```
HTTP 请求调用

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_USER_AGENT

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_USER_AGENT`

Constructor Summary

Constructors
Constructor and Description
`HttpClient(String urlString)` 构建函数
`HttpClient(String urlString, int timeout)` 构建函数
`HttpClient(String urlString, String charset)` 构建函数
`HttpClient(String urlString, String charset, int timeout)` 构建函数

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpClient`	`addPart(Part part)` 设置POST多段请求类似 Form 的 Actiong="POST" enctype="multipart/form-data"
`void`	`asyncSend(Consumer<Response> async)` 连接并发送请求,异步获得响应
`void`	`asyncSend(String location, Consumer<Response> async)` 连接并发送请求,异步获得响应
`static String`	`buildQueryString(Map<String,Object> parameters, String charset)` 构建QueryString 将 Map 集合转换成 QueryString 字符串
`void`	`close()` 关闭 HTTP 连接
`protected void`	`finished(Response response)` 请求完成
`List<Cookie>`	`getCookies()` 获取Cookie集合
`Header`	`getHeader()` 获取请求头集合
`HttpRequest`	`getHttpRequest()`
`Map<String,Object>`	`getParameters()` 获取请求参数集合
`protected TcpSocket`	`getSocket()` 获取 Socket 连接
`HttpClient`	`initHeader()` 重新初始化 http 头
`protected void`	`initWebSocket()` 初始化 WebSocket 在 HttpFilter 中触发
`boolean`	`isConnect()` 判断是否处于连接状态
`boolean`	`isParamInUrl()` 获取参数是否封装在 URL 中, 仅在 POST 等请求中有效
`ByteBuffer`	`loadStream()` 读取流
`static HttpClient`	`newInstance(String urlString)` 静态构造方法默认字符集 UTF-8, 默认超时时间 5s
`static HttpClient`	`newInstance(String urlString, int timeout)` 静态构造方法默认超时时间 5s
`static HttpClient`	`newInstance(String urlString, String charset)` 静态构造方法默认超时时间 5s
`static HttpClient`	`newInstance(String urlString, String charset, int timeout)` 静态构造方法
`HttpClient`	`putHeader(String name, String value)` 设置请求头
`HttpClient`	`putParameters(String name, String value)` 设置请求参数
`Response`	`send()` 连接并发送请求
`int`	`send(ByteBuffer buffer)` 发送二进制数据
`Response`	`send(String location)` 连接并发送请求
`void`	`sendStream(ByteBuffer buffer)` 直接发送流
`HttpClient`	`setBodyType(Request.RequestType bodyType)` 设置报文形式
`HttpClient`	`setData(byte[] data)` 设置请求内容
`HttpClient`	`setData(String data)` 设置请求内容
`HttpClient`	`setData(String contentType, String data)` 设置请求内容
`HttpClient`	`setData(String contentType, String data, String charset)` 设置请求内容
`HttpClient`	`setJsonData(Object data)` 设置请求内容
`HttpClient`	`setJsonData(Object data, String charset)` 设置请求内容
`HttpClient`	`setMethod(String method)` 设置请求方法
`HttpClient`	`setParamInUrl(boolean paramInUrl)` 设置是否将参数封装在 URL 中, 仅在 POST 等请求中有效
`void`	`uploadFile(String name, File file)` 上传文件
`void`	`webSocket(String location, WebSocketRouter webSocketRouter)` 连接 Websocket

Methods inherited from class org.voovan.tools.pool.PooledObject
getPoolObjectId, setPoolObjectId

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

- Field Detail
  - DEFAULT_USER_AGENT
```
public static final String DEFAULT_USER_AGENT
```
- Constructor Detail
  - HttpClient
```
public HttpClient(String urlString)
```
    构建函数
    
    Parameters:
    
    urlString - 请求的 URL 地址
  - HttpClient
```
public HttpClient(String urlString,
                  int timeout)
```
    构建函数
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    timeout - 超时时间
  - HttpClient
```
public HttpClient(String urlString,
                  String charset,
                  int timeout)
```
    构建函数
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    charset - 字符集
    
    timeout - 超时时间
  - HttpClient
```
public HttpClient(String urlString,
                  String charset)
```
    构建函数
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    charset - 字符集
- Method Detail
  - isParamInUrl
```
public boolean isParamInUrl()
```
    获取参数是否封装在 URL 中, 仅在 POST 等请求中有效
    
    Returns:
    
    true:是, false: 否
  - setParamInUrl
```
public HttpClient setParamInUrl(boolean paramInUrl)
```
    设置是否将参数封装在 URL 中, 仅在 POST 等请求中有效
    
    Parameters:
    
    paramInUrl - true:是, false: 否
    
    Returns:
    
    HttpClient 对象
  - initHeader
```
public HttpClient initHeader()
```
    重新初始化 http 头
    
    Returns:
    
    HttpClient 对象
  - getSocket
```
protected TcpSocket getSocket()
```
    获取 Socket 连接
    
    Returns:
    
    Socket对象
  - getHttpRequest
```
public HttpRequest getHttpRequest()
```
  - sendStream
```
public void sendStream(ByteBuffer buffer)
```
    直接发送流
    
    Parameters:
    
    buffer - 字节缓冲对象ByteBuffer
  - loadStream
```
public ByteBuffer loadStream()
                      throws IOException
```
    读取流
    
    Returns:
    
    字节缓冲对象ByteBuffer
    
    Throws:
    
    IOException - IO异常对象
  - setMethod
```
public HttpClient setMethod(String method)
```
    设置请求方法
    
    Parameters:
    
    method - Http 请求的方法
    
    Returns:
    
    HttpClient 对象
  - setBodyType
```
public HttpClient setBodyType(Request.RequestType bodyType)
```
    设置报文形式
    
    Parameters:
    
    bodyType - Http 报文形式
    
    Returns:
    
    Request.BodyType 枚举
  - setData
```
public HttpClient setData(byte[] data)
```
    设置请求内容
    
    Parameters:
    
    data - 请求内容
    
    Returns:
    
    HttpClient 对象
  - setData
```
public HttpClient setData(String data)
```
    设置请求内容
    
    Parameters:
    
    data - 请求内容
    
    Returns:
    
    HttpClient 对象
  - setData
```
public HttpClient setData(String contentType,
                          String data)
```
    设置请求内容
    
    Parameters:
    
    contentType - ContentType 类型
    
    data - 请求内容
    
    Returns:
    
    HttpClient 对象
  - setData
```
public HttpClient setData(String contentType,
                          String data,
                          String charset)
```
    设置请求内容
    
    Parameters:
    
    contentType - ContentType 类型
    
    data - 请求内容
    
    charset - 字符集
    
    Returns:
    
    HttpClient 对象
  - setJsonData
```
public HttpClient setJsonData(Object data,
                              String charset)
```
    设置请求内容
    
    Parameters:
    
    data - 请求内容
    
    charset - 字符集
    
    Returns:
    
    HttpClient 对象
  - setJsonData
```
public HttpClient setJsonData(Object data)
```
    设置请求内容
    
    Parameters:
    
    data - 请求内容
    
    Returns:
    
    HttpClient 对象
  - getHeader
```
public Header getHeader()
```
    获取请求头集合
    
    Returns:
    
    Header 对象
  - putHeader
```
public HttpClient putHeader(String name,
                            String value)
```
    设置请求头
    
    Parameters:
    
    name - Header 名称
    
    value - Header 值
    
    Returns:
    
    HttpClient 对象
  - getCookies
```
public List<Cookie> getCookies()
```
    获取Cookie集合
    
    Returns:
    
    Cookie集合
  - getParameters
```
public Map<String,Object> getParameters()
```
    获取请求参数集合
    
    Returns:
    
    参数对象
  - putParameters
```
public HttpClient putParameters(String name,
                                String value)
```
    设置请求参数
    
    Parameters:
    
    name - 参数名
    
    value - 参数值
    
    Returns:
    
    HttpClient 对象
  - addPart
```
public HttpClient addPart(Part part)
```
    设置POST多段请求类似 Form 的 Actiong="POST" enctype="multipart/form-data"
    
    Parameters:
    
    part - POST 请求包文对象
    
    Returns:
    
    HttpClient 对象
  - uploadFile
```
public void uploadFile(String name,
                       File file)
```
    上传文件
    
    Parameters:
    
    name - 参数名
    
    file - 文件对象
  - buildQueryString
```
public static String buildQueryString(Map<String,Object> parameters,
                                      String charset)
```
    构建QueryString 将 Map 集合转换成 QueryString 字符串
    
    Parameters:
    
    parameters - 用于保存拼装请求字符串参数的 Map 对象
    
    charset - 参数的字符集
    
    Returns:
    
    请求字符串
  - send
```
public Response send(String location)
              throws SendMessageException,
                     ReadMessageException
```
    连接并发送请求
    
    Parameters:
    
    location - 请求 URL
    
    Returns:
    
    Response 对象
    
    Throws:
    
    SendMessageException - 发送异常
    
    ReadMessageException - 读取异常
  - asyncSend
```
public void asyncSend(String location,
                      Consumer<Response> async)
               throws SendMessageException,
                      ReadMessageException
```
    连接并发送请求,异步获得响应
    
    Parameters:
    
    location - 请求 URL
    
    async - 异步响应消费对象
    
    Throws:
    
    SendMessageException - 发送异常
    
    ReadMessageException - 读取异常
  - send
```
public Response send()
              throws SendMessageException,
                     ReadMessageException
```
    连接并发送请求
    
    Returns:
    
    Response 对象
    
    Throws:
    
    SendMessageException - 发送异常
    
    ReadMessageException - 读取异常
  - asyncSend
```
public void asyncSend(Consumer<Response> async)
               throws SendMessageException,
                      ReadMessageException
```
    连接并发送请求,异步获得响应
    
    Parameters:
    
    async - 异步响应消费对象
    
    Throws:
    
    SendMessageException - 发送异常
    
    ReadMessageException - 读取异常
  - send
```
public int send(ByteBuffer buffer)
         throws IOException
```
    发送二进制数据
    
    Parameters:
    
    buffer - 二进制数据
    
    Returns:
    
    发送的字节数
    
    Throws:
    
    IOException - IO 异常
  - finished
```
protected void finished(Response response)
```
    请求完成
    
    Parameters:
    
    response - 请求对象
  - webSocket
```
public void webSocket(String location,
                      WebSocketRouter webSocketRouter)
               throws SendMessageException,
                      ReadMessageException
```
    连接 Websocket
    
    Parameters:
    
    location - URL地址
    
    webSocketRouter - WebSocker的路由
    
    Throws:
    
    SendMessageException - 发送异常
    
    ReadMessageException - 读取异常
  - initWebSocket
```
protected void initWebSocket()
```
    初始化 WebSocket 在 HttpFilter 中触发
  - close
```
public void close()
```
    关闭 HTTP 连接
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - isConnect
```
public boolean isConnect()
```
    判断是否处于连接状态
    
    Returns:
    
    是否连接
  - newInstance
```
public static HttpClient newInstance(String urlString)
```
    静态构造方法默认字符集 UTF-8, 默认超时时间 5s
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    Returns:
    
    HttpClient 对象, 返回 null 则构造的 HttpClient 建立连接失败
  - newInstance
```
public static HttpClient newInstance(String urlString,
                                     int timeout)
```
    静态构造方法默认超时时间 5s
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    timeout - 超时时间
    
    Returns:
    
    HttpClient 对象, 返回 null 则构造的 HttpClient 建立连接失败
  - newInstance
```
public static HttpClient newInstance(String urlString,
                                     String charset)
```
    静态构造方法默认超时时间 5s
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    charset - 字符集
    
    Returns:
    
    HttpClient 对象, 返回 null 则构造的 HttpClient 建立连接失败
  - newInstance
```
public static HttpClient newInstance(String urlString,
                                     String charset,
                                     int timeout)
```
    静态构造方法
    
    Parameters:
    
    urlString - 请求的 URL 地址
    
    charset - 字符集
    
    timeout - 超时时间
    
    Returns:
    
    HttpClient 对象, 返回 null 则构造的 HttpClient 建立连接失败

Class HttpClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.voovan.tools.pool.PooledObject

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_USER_AGENT

Constructor Detail

HttpClient

HttpClient

HttpClient

HttpClient

Method Detail

isParamInUrl

setParamInUrl

initHeader

getSocket

getHttpRequest

sendStream

loadStream

setMethod

setBodyType

setData

setData

setData

setData

setJsonData

setJsonData

getHeader

putHeader

getCookies

getParameters

putParameters

addPart

uploadFile

buildQueryString

send

asyncSend

send

asyncSend

send

finished

webSocket

initWebSocket

close

isConnect

newInstance

newInstance

newInstance

newInstance