HttpClient (Bropen Toolkit 4.8.1 API)

bropen.toolkit.utils.network.HttpClient

HttpClient 工具类

参考自 http://www.aichengxu.com/view/2337969

https单向认证，会自动去除域名校验；而双向认证需要在执行execute之前需要设置证书调用setJks方法。

关于Session保持有两种实现方式：

获取响应后的 ResponseWrap CookieStore设置到新的请求 CookieStore
在新的请求里重用上一次请求的 HttpClient 的实例，推荐使用这种，因为效率高，如 def http = HttpClient.get(url1) .... http.post(url2) 或者 http = HttpClient.post(url2, http) .... http.shutdown()

示例1：String url = "http://www.baidu.com/s"
 def http = HttpClient.get(url)
 http.addParameter("wd", "java 核心技术")
 http.addHeader("User-Agent", "Mozilla/5.0 (Windows NT 6.1 WOW64 rv:39.0) Gecko/20100101 Firefox/39.0")
 //http.setProxy("10.10.12.62", 3128) //设置代理
 def response = http.execute() //执行请求
 println response.getString()  //输出内容
 response.transferTo("d:/baidu-search-java.html") //输出到文件
 http.shutdown()

示例2，代理模式：String url = "http://www.baidu.com/"
 HttpClient.request(url, request).execute().render(response).shutdown()

示例3，POST 一段 JSON、并且接收返回的 JSON 数据：HttpClient.post (url)
   //.setContentType(HttpClient.ContentType.APPLICATION_JSON)
   //.setParameter(StringUtils.toJson([x: 1, y: 2], Map))
   .setParameterJson(StringUtils.toJson([x: 1, y: 2], Map))
   .execute().getJson(Map)

示例4，POST 参数 + 附件（注意中文）、并且接收返回的 JSON 数据：HttpClient.post (url)
   .addParameter("yyyyy", "yyyyyyyyyyyyy对对对")
   .addParameter("zzzz在", "啧啧啧123")
   .addFiles("xxxx", [new File("/dev/shm/ramdisk/添加亲友关系.txt")])
   .addParameter("zhh", "啧啧啧123")
   .execute().getJson(Map)

后台代码示例：println request.getContentType()
 println request.JSON
 println params

 println params.xxxx.originalFilename // 可以取到一个附件，多个附件用下面的方式
 MultipartHttpServletRequest mrequest = ServletUtils.getMultipartRequest(request)
 if (mrequest != null) {
  for (String field in mrequest.getFileMap().keySet()) {
   for (MultipartFile f in mrequest.getFiles(field)) {
    println f.originalFilename + " --- " + f.name + " --- " + f.contentType
   \
  \}\
 \}\
}

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`HttpClient.ContentType`	// * 把Json转换成List // * @return // Parameters: `clazz //` - *
`static class`	`HttpClient.ResponseWrap`	响应结果

Field Summary

Fields
Modifiers	Name	Description
`Closure`	`delete`	复用当前客户端，创建一个新的 delete 请求
`Closure`	`get`	复用当前客户端，创建一个新的 get 请求
`Closure`	`post`	复用当前客户端，创建一个新的 post 请求
`Closure`	`put`	复用当前客户端，创建一个新的 put 请求
`Closure`	`request`	复用当前客户端，并根据当前浏览器的 http 请求，创建一个新的请求

Methods Summary

Methods
Type	Name and description
`HttpClient`	`addCookie(org.apache.http.cookie.Cookie... cookies)` 添加 Cookie
`HttpClient`	`addCookies(Map<String, String> cookies)` 添加 Cookie
`HttpClient`	`addFiles(String name, Map<String, Object> files)` 添加附件，并设置 ContentType 为 multipart/form-data,charset=UTF-8
`HttpClient`	`addFiles(String name, List<java.io.File> files)` 添加附件，并设置 ContentType 为 multipart/form-data,charset=UTF-8
`HttpClient`	`addHeader(String name, String value)` 添加 Header
`HttpClient`	`addHeaders(Map<String, String> headers)` 添加 Header
`HttpClient`	`addParameter(String name, String value)` // * 创建post请求 // * @return // Parameters: `uri` - 请求地址 // *
`HttpClient`	`addParameters(Map<String, Object> parameters)` 添加参数
`boolean`	`containsHeader(String name)` 是否存在指定 name 的 Header
`static HttpClient`	`delete(String url, HttpClient other = null)` 创建 delete 请求
`HttpClient.ResponseWrap`	`execute()` 执行请求
`Thread`	`execute(Closure done, Closure failed = null)` 异步执行请求
`T`	`execute(org.apache.http.client.ResponseHandler<? extends T> responseHandler)` 执行请求
`static HttpClient`	`get(String url, HttpClient other = null)` 创建 get 请求
`org.apache.http.Header[]`	`getAllHeaders()` 获取所有 Header
`org.apache.http.ProtocolVersion`	`getProtocolVersion()` 获取协议版本信息
`java.net.URI`	`getURI()` 获取请求 Url
`org.apache.http.HeaderIterator`	`headerIterator()` 获取 Header 的迭代器
`HttpClient`	`maxRedirects(int maxRedirects)` 设置重定向的次数
`static HttpClient`	`post(String url, HttpClient other = null)` 创建 post 请求
`static HttpClient`	`put(String url, HttpClient other = null)` 创建 put 请求
`HttpClient`	`removeHeader(String name, String value)` // * 移除指定的Header // * @param header //
`HttpClient`	`removeHeaders(String name)` 移除指定 name 的 Header 列表
`static HttpClient`	`request(String url, javax.servlet.http.HttpServletRequest req, HttpClient other = null)` 根据当前浏览器的 http 请求，创建相应类型的请求
`HttpClient`	`setCircularRedirectsAllowed(boolean circularRedirectsAllowed)` 设置是否允许服务端循环重定向
`HttpClient`	`setConnectTimeout(int connectTimeout)` 设置和服务器建立连接的超时时间，单位:ms
`HttpClient`	`setConnectionRequestTimeout(int connectionRequestTimeout)` 设置从连接池获取连接的超时时间，单位:ms
`HttpClient`	`setContentEncoding(String encoding)` 设置内容编码
`HttpClient`	`setContentType(String mimeType, java.nio.charset.Charset charset)` 设置 ContentType
`HttpClient`	`setContentType(String contentType)` 设置 ContentType
`HttpClient`	`setContentType(org.apache.http.entity.ContentType contentType)` 设置 ContentType
`HttpClient`	`setCookieStore(java.net.CookieStore cookieStore)` 设置一个 CookieStore
`HttpClient`	`setHeaders(Map<String, String> headers)` 设置 Header，会覆盖所有之前的 Header
`HttpClient`	`setHeaders(org.apache.http.Header[] headers)`
`HttpClient`	`setJKS(String jksFilePath, String password)` 设置双向认证的JKS
`HttpClient`	`setJKS(java.io.File jksFile, String password)` 设置双向认证的JKS
`HttpClient`	`setJKS(java.io.InputStream instream, String password)` 设置双向认证的JKS, 不会关闭InputStream
`HttpClient`	`setJKS(java.security.KeyStore keyStore)` 设置双向认证的JKS
`HttpClient`	`setParameter(java.io.File file)` 设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
`HttpClient`	`setParameter(byte[] binary)` 设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
`HttpClient`	`setParameter(java.io.Serializable serializable)` 设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
`HttpClient`	`setParameter(java.io.InputStream stream)` // * 设置参数为Json对象 // * @return // Parameters: `parameter` - 参数对象 // *
`HttpClient`	`setParameter(java.io.PipedOutputStream pipedOutputStream, Closure inputThread = null)` 设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
`HttpClient`	`setParameter(String text)` 设置请求参数，会清空并覆盖之前的参数
`HttpClient`	`setParameterJson(String json)` 设置 json 格式的请求参数、并设置 ContentType 为 "application/json,charset=UTF-8"，会清空并覆盖之前的参数
`HttpClient`	`setParameterXml(String xml)` 设置 xml 格式的请求参数、并设置 ContentType 为 "application/xml,charset=UTF-8"，会清空并覆盖之前的参数
`HttpClient`	`setParameters(Map<String, Object> parameters)` // * 添加参数 // * @return // Parameters: `parameters //` - *
`HttpClient`	`setProxy(String hostname, int port)` 设置网络代理
`HttpClient`	`setProxy(String hostname, int port, String schema)` 设置网络代理
`HttpClient`	`setProxy(java.net.InetAddress address)` 设置网络代理
`HttpClient`	`setProxy(org.apache.http.HttpHost host)` 设置网络代理
`HttpClient`	`setRedirectsEnabled(boolean redirectsEnabled)` 设置是否启用调转
`HttpClient`	`setRequest(javax.servlet.http.HttpServletRequest req)` 根据当前浏览器的 http 请求，会覆盖之前的 headers、cookies 和 request body（仅支持post/put），类似于代理。
`HttpClient`	`setSocketTimeout(int socketTimeout)` 设置从服务器获取返回数据的超时时间，单位:ms
`HttpClient`	`setTimeout(Integer socketTimeout, Integer connectTimeout = null, Integer connectionRequestTimeout = null)` 设置超时时间（毫秒）
`HttpClient`	`setURI(java.net.URI uri)` 设置请求 Url
`HttpClient`	`setURI(String uri)` 设置请求 Url
`void`	`shutdown()` 关闭连接

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`Object#wait(long, int), Object#wait(long), Object#wait(), Object#equals(Object), Object#toString(), Object#hashCode(), Object#getClass(), Object#notify(), Object#notifyAll()`

- Field Detail
  - public Closure delete
    
    复用当前客户端，创建一个新的 delete 请求
    Parameters:
    url - 请求地址
  - public Closure get
    
    复用当前客户端，创建一个新的 get 请求
    Parameters:
    url - 请求地址
  - public Closure post
    
    复用当前客户端，创建一个新的 post 请求
    Parameters:
    url - 请求地址
  - public Closure put
    
    复用当前客户端，创建一个新的 put 请求
    Parameters:
    url - 请求地址
  - public Closure request
    
    复用当前客户端，并根据当前浏览器的 http 请求，创建一个新的请求
    Parameters:
    url - 请求地址
- Method Detail
  - HttpClient addCookie(org.apache.http.cookie.Cookie... cookies)
    
    添加 Cookie
    Parameters:
    cookie
  - HttpClient addCookies(Map<String, String> cookies)
    
    添加 Cookie
  - HttpClient addFiles(String name, Map<String, Object> files)
    
    添加附件，并设置 ContentType 为 multipart/form-data,charset=UTF-8
    只支持 post、put 操作，并且会清空之前设置的非键值对形式的参数（如 file、stream、text、serializable 等）。
    
    Parameters:
    name - 附件域的名称
    files - 键为文件名、值为文件路径/文件对象/InputStream/byte[] 的多个文件
  - HttpClient addFiles(String name, List<java.io.File> files)
    
    添加附件，并设置 ContentType 为 multipart/form-data,charset=UTF-8
    只支持 post、put 操作，并且会清空之前设置的非键值对的参数（如 file、stream、text、serializable 等）。
    
    Parameters:
    name - 附件域的名称
    files - 文件列表
  - HttpClient addHeader(String name, String value)
    
    添加 Header
    Parameters:
    name
    value
  - HttpClient addHeaders(Map<String, String> headers)
    
    添加 Header
    Parameters:
    headers
  - HttpClient addParameter(String name, String value)
    
    // * 创建post请求 // *
    Returns:
    //
    Parameters:
    uri - 请求地址 // *
  - HttpClient addParameters(Map<String, Object> parameters)
    
    添加参数
    Parameters:
    parameters
  - boolean containsHeader(String name)
    
    是否存在指定 name 的 Header
    Parameters:
    name
  - static HttpClient delete(String url, HttpClient other = null)
    
    创建 delete 请求
    Returns:
    Parameters:
    url - 请求地址
  - HttpClient.ResponseWrap execute()
    
    执行请求
  - Thread execute(Closure done, Closure failed = null)
    
    异步执行请求
    Parameters:
    done - 执行成功的回调闭包，可接收一个 ResponseWrap 参数
    failed - 实现失败的回调闭包，可接收一个 IOException 参数
  - T execute(org.apache.http.client.ResponseHandler<? extends T> responseHandler)
    
    执行请求
    Parameters:
    responseHandler
  - static HttpClient get(String url, HttpClient other = null)
    
    创建 get 请求
    Returns:
    Parameters:
    url - 请求地址
  - org.apache.http.Header[] getAllHeaders()
    
    获取所有 Header
  - org.apache.http.ProtocolVersion getProtocolVersion()
    
    获取协议版本信息
  - java.net.URI getURI()
    
    获取请求 Url
  - org.apache.http.HeaderIterator headerIterator()
    
    获取 Header 的迭代器
  - HttpClient maxRedirects(int maxRedirects)
    
    设置重定向的次数
    Parameters:
    maxRedirects
  - static HttpClient post(String url, HttpClient other = null)
    
    创建 post 请求
    Returns:
    Parameters:
    url - 请求地址
  - static HttpClient put(String url, HttpClient other = null)
    
    创建 put 请求
    Returns:
    Parameters:
    url - 请求地址
  - HttpClient removeHeader(String name, String value)
    
    // * 移除指定的Header // *
    Parameters:
    header //
  - HttpClient removeHeaders(String name)
    
    移除指定 name 的 Header 列表
    Parameters:
    name
  - static HttpClient request(String url, javax.servlet.http.HttpServletRequest req, HttpClient other = null)
    
    根据当前浏览器的 http 请求，创建相应类型的请求
    Returns:
    Parameters:
    url - 请求地址
    req
  - HttpClient setCircularRedirectsAllowed(boolean circularRedirectsAllowed)
    
    设置是否允许服务端循环重定向
    Parameters:
    circularRedirectsAllowed
  - HttpClient setConnectTimeout(int connectTimeout)
    
    设置和服务器建立连接的超时时间，单位:ms
    Parameters:
    connectTimeout
  - HttpClient setConnectionRequestTimeout(int connectionRequestTimeout)
    
    设置从连接池获取连接的超时时间，单位:ms
    Parameters:
    connectionRequestTimeout
  - HttpClient setContentEncoding(String encoding)
    
    设置内容编码
    只支持未添加过附件的 post、put 操作。
    
    Parameters:
    encoding
  - HttpClient setContentType(String mimeType, java.nio.charset.Charset charset)
    
    设置 ContentType
    只支持未添加过附件的 post、put 操作。
    
    Parameters:
    mimeType
    charset - 内容编码
  - HttpClient setContentType(String contentType)
    
    设置 ContentType
    只支持未添加过附件的 post、put 操作。
    
    Parameters:
    contentType - 包含 mimeType 和 charset（可选）的字符串，如 “application/x-www-form-urlencoded,charset=UTF-8”
  - HttpClient setContentType(org.apache.http.entity.ContentType contentType)
    
    设置 ContentType
    只支持未添加过附件的 post、put 操作。
    
    Parameters:
    contentType - 如 org.apache.http.entity.ContentType.APPLICATION_JSON
  - HttpClient setCookieStore(java.net.CookieStore cookieStore)
    
    设置一个 CookieStore
    Returns:
    Parameters:
    cookieStore
  - HttpClient setHeaders(Map<String, String> headers)
    
    设置 Header，会覆盖所有之前的 Header
    Parameters:
    headers
  - HttpClient setHeaders(org.apache.http.Header[] headers)
  - HttpClient setJKS(String jksFilePath, String password)
    
    设置双向认证的JKS
    Parameters:
    jksFilePath - jks文件路径
    password - 密码
  - HttpClient setJKS(java.io.File jksFile, String password)
    
    设置双向认证的JKS
    Parameters:
    jksFile - jks文件
    password - 密码
  - HttpClient setJKS(java.io.InputStream instream, String password)
    
    设置双向认证的JKS, 不会关闭InputStream
    Parameters:
    instream - jks流
    password - 密码
  - HttpClient setJKS(java.security.KeyStore keyStore)
    
    设置双向认证的JKS
    Parameters:
    keyStore - jks
  - HttpClient setParameter(java.io.File file)
    
    设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
    只支持未添加过附件的 post、put 操作，并且不等于附件上传，而是将文件内容设置为请求体。
    
    Parameters:
    file
  - HttpClient setParameter(byte[] binary)
    
    设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
    只支持未添加过附件的 post、put 操作。
    
    Parameters:
    binary
  - HttpClient setParameter(java.io.Serializable serializable)
    
    设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
    只支持未添加过附件的 post、put 操作。
    
    Parameters:
    serializable
  - HttpClient setParameter(java.io.InputStream stream)
    
    // * 设置参数为Json对象 // *
    Returns:
    //
    Parameters:
    parameter - 参数对象 // *
  - HttpClient setParameter(java.io.PipedOutputStream pipedOutputStream, Closure inputThread = null)
    
    设置请求参数，会清空并覆盖之前的参数、并设置 ContentType 为 application/octet-stream
    只支持未添加过附件的 post、put 操作。
```
尤其需要注意的是，写入 pipedOutputStream 的操作必须再另一个线程中执行、并确保该线程执行后调用 close 关闭 pipedOutputStream，否则会导致死锁，如：
 
    PipedOutputStream os = new PipedOutputStream()
    PipedInputStream is = new PipedInputStream(os)
    httpClient.setParameter(is).setContentType(HttpClient.ContentType.APPLICATION_JSON)
    Thread.start { StringUtils.toJson(irisRequest, os) }
 其中 Trhead.start 部分可以作为闭包参数 inputThread 传进来，会自动启动一个线程。
```
    throws:
    UnsupportedOperationException
    
    Parameters:
    pipedOutputStream
  - HttpClient setParameter(String text)
    
    设置请求参数，会清空并覆盖之前的参数
    只支持未添加过附件的 post、put 操作，以及 get、delete 操作。
    
    Parameters:
    text
  - HttpClient setParameterJson(String json)
    
    设置 json 格式的请求参数、并设置 ContentType 为 "application/json,charset=UTF-8"，会清空并覆盖之前的参数
    只支持未添加过附件的 post、put 操作，以及 get、delete 操作。
  - HttpClient setParameterXml(String xml)
    
    设置 xml 格式的请求参数、并设置 ContentType 为 "application/xml,charset=UTF-8"，会清空并覆盖之前的参数
    只支持未添加过附件的 post、put 操作，以及 get、delete 操作。
  - HttpClient setParameters(Map<String, Object> parameters)
    
    // * 添加参数 // *
    Returns:
    //
    Parameters:
    parameters // - *
  - HttpClient setProxy(String hostname, int port)
    
    设置网络代理
    Parameters:
    hostname
    port
  - HttpClient setProxy(String hostname, int port, String schema)
    
    设置网络代理
    Parameters:
    hostname
    port
    schema
  - HttpClient setProxy(java.net.InetAddress address)
    
    设置网络代理
    Parameters:
    address
  - HttpClient setProxy(org.apache.http.HttpHost host)
    
    设置网络代理
    Parameters:
    host
  - HttpClient setRedirectsEnabled(boolean redirectsEnabled)
    
    设置是否启用调转
    Parameters:
    redirectsEnabled
  - HttpClient setRequest(javax.servlet.http.HttpServletRequest req)
    
    根据当前浏览器的 http 请求，会覆盖之前的 headers、cookies 和 request body（仅支持post/put），类似于代理。
  - HttpClient setSocketTimeout(int socketTimeout)
    
    设置从服务器获取返回数据的超时时间，单位:ms
    Parameters:
    socketTimeout
  - HttpClient setTimeout(Integer socketTimeout, Integer connectTimeout = null, Integer connectionRequestTimeout = null)
    
    设置超时时间（毫秒）
    Parameters:
    socketTimeout - 从服务器获取返回数据的超时时间
    connectTimeout - 和服务器建立连接的超时时间
    connectionRequestTimeout - 从连接池获取连接的超时时间
  - HttpClient setURI(java.net.URI uri)
    
    设置请求 Url
  - HttpClient setURI(String uri)
    
    设置请求 Url
  - @SuppressWarnings("deprecation") void shutdown()
    
    关闭连接

Summary:
Nested
Field
Constructor
Method

| Detail:
Field
Constructor
Method

BROPEN Documentation, 2020-04-21 10:53

[Groovy] Class HttpClient

Nested Class Summary

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public Closure delete

public Closure get

public Closure post

public Closure put

public Closure request

Method Detail

HttpClient addCookie(org.apache.http.cookie.Cookie... cookies)

HttpClient addCookies(Map<String, String> cookies)

HttpClient addFiles(String name, Map<String, Object> files)

HttpClient addFiles(String name, List<java.io.File> files)

HttpClient addHeader(String name, String value)

HttpClient addHeaders(Map<String, String> headers)

HttpClient addParameter(String name, String value)

HttpClient addParameters(Map<String, Object> parameters)

boolean containsHeader(String name)

static HttpClient delete(String url, HttpClient other = null)

HttpClient.ResponseWrap execute()

Thread execute(Closure done, Closure failed = null)

T execute(org.apache.http.client.ResponseHandler<? extends T> responseHandler)

static HttpClient get(String url, HttpClient other = null)

org.apache.http.Header[] getAllHeaders()

org.apache.http.ProtocolVersion getProtocolVersion()

java.net.URI getURI()

org.apache.http.HeaderIterator headerIterator()

HttpClient maxRedirects(int maxRedirects)

static HttpClient post(String url, HttpClient other = null)

static HttpClient put(String url, HttpClient other = null)

HttpClient removeHeader(String name, String value)

HttpClient removeHeaders(String name)

static HttpClient request(String url, javax.servlet.http.HttpServletRequest req, HttpClient other = null)

HttpClient setCircularRedirectsAllowed(boolean circularRedirectsAllowed)

HttpClient setConnectTimeout(int connectTimeout)

HttpClient setConnectionRequestTimeout(int connectionRequestTimeout)

HttpClient setContentEncoding(String encoding)

HttpClient setContentType(String mimeType, java.nio.charset.Charset charset)

HttpClient setContentType(String contentType)

HttpClient setContentType(org.apache.http.entity.ContentType contentType)

HttpClient setCookieStore(java.net.CookieStore cookieStore)

HttpClient setHeaders(Map<String, String> headers)

HttpClient setHeaders(org.apache.http.Header[] headers)

HttpClient setJKS(String jksFilePath, String password)

HttpClient setJKS(java.io.File jksFile, String password)

HttpClient setJKS(java.io.InputStream instream, String password)

HttpClient setJKS(java.security.KeyStore keyStore)

HttpClient setParameter(java.io.File file)

HttpClient setParameter(byte[] binary)

HttpClient setParameter(java.io.Serializable serializable)

HttpClient setParameter(java.io.InputStream stream)

HttpClient setParameter(java.io.PipedOutputStream pipedOutputStream, Closure inputThread = null)

HttpClient setParameter(String text)

HttpClient setParameterJson(String json)

HttpClient setParameterXml(String xml)

HttpClient setParameters(Map<String, Object> parameters)

HttpClient setProxy(String hostname, int port)

HttpClient setProxy(String hostname, int port, String schema)

HttpClient setProxy(java.net.InetAddress address)

HttpClient setProxy(org.apache.http.HttpHost host)

HttpClient setRedirectsEnabled(boolean redirectsEnabled)

HttpClient setRequest(javax.servlet.http.HttpServletRequest req)

HttpClient setSocketTimeout(int socketTimeout)

HttpClient setTimeout(Integer socketTimeout, Integer connectTimeout = null, Integer connectionRequestTimeout = null)

HttpClient setURI(java.net.URI uri)

HttpClient setURI(String uri)

@SuppressWarnings("deprecation") void shutdown()