HttpClient (bus-all 3.6.6 API)

java.lang.Object
- org.aoju.bus.http.Client
- - org.aoju.bus.http.HttpClient

All Implemented Interfaces:

Cloneable, Call.Factory, WebSocket.Factory
```
public class HttpClient
extends Client
```
Http 辅助类

Since:

JDK 1.8+

Version:

3.6.6

Author:

Kimi Liu

Constructor Summary

Constructors
Constructor and Description
`HttpClient()` 提供返回实例的静态方法
`HttpClient(Dns dns, Proxy proxy, int connTimeout, int readTimeout, int writeTimeout, int maxRequests, int maxRequestsPerHost, int maxIdleConnections, int keepAliveDuration)` 构建一个自定义配置的 HTTP Client 类
`HttpClient(Dns dns, Proxy proxy, int connTimeout, int readTimeout, int writeTimeout, int maxRequests, int maxRequestsPerHost, int maxIdleConnections, int keepAliveDuration, SSLSocketFactory sslSocketFactory, X509TrustManager x509TrustManager, HostnameVerifier hostnameVerifier)` 构建一个自定义配置的 HTTP Client 类
`HttpClient(org.aoju.bus.http.HttpClient.X509TrustManager x509TrustManager)` 提供返回实例的静态方法
`HttpClient(int connTimeout, int readTimeout, int writeTimeout)` 构建一个自定义配置的 HTTP Client 类
`HttpClient(int connTimeout, int readTimeout, int writeTimeout, int maxRequests, int maxRequestsPerHost, int maxIdleConnections, int keepAliveDuration)` 构建一个自定义配置的 HTTP Client 类

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Map<String,List<String>>`	`decode(String params, String charset)` 将URL参数解析为Map（也可以解析Post中的键值对参数）
`static Map<String,String>`	`decodeMap(String params, String charset)` 将URL参数解析为Map（也可以解析Post中的键值对参数）
`static String`	`encode(String paramsStr, Charset charset)` 对URL参数做编码，只编码键和值提供的值可以是url附带参数，但是不能只是url
`static String`	`get(String url)` 简单的 GET 请求使用默认编码 UTF-8
`static String`	`get(String url, boolean isAsync)` 异步get请求，回调
`static String`	`get(String url, Map<String,Object> queryMap)` 带查询参数 GET 请求使用默认编码 UTF-8
`static String`	`get(String url, Map<String,Object> queryMap, Map<String,String> headerMap)` 带查询参数 GET 请求使用默认编码 UTF-8
`static String`	`get(String url, Map<String,Object> queryMap, Map<String,String> headerMap, String charset)` 带查询参数 GET 请求使用自定义编码
`static String`	`get(String url, String charset)` 简单的 GET 请求使用自定义编码
`static String`	`getParameterMap(Map<String,Object> map)` Process the Http request Map
`static String`	`normalizeParams(String paramPart, Charset charset)` 标准化参数字符串，即URL中？后的部分
`static String`	`post(String url)` form 方式 POST 请求
`static String`	`post(String url, Map<String,Object> formMap)` form 方式 POST 请求 application/x-www-form-urlencoded
`static String`	`post(String url, Map<String,Object> params, List<String> pathList)` 表单提交带文件上传
`static String`	`post(String url, Map<String,Object> queryMap, Map<String,String> headerMap)` 带查询参数 POST 请求使用自定义编码
`static String`	`post(String url, Map<String,Object> queryMap, Map<String,String> headerMap, String mediaType)` 带查询参数 POST 请求使用自定义编码
`static String`	`post(String url, Map<String,Object> queryMap, Map<String,String> headerMap, String mediaType, String charset)` 带查询参数 POST 请求使用自定义编码
`static String`	`post(String url, Map<String,Object> queryMap, String mediaType)` 带查询参数 POST 请求使用默认编码 UTF-8
`static String`	`post(String url, Map<String,Object> queryMap, String mediaType, String charset)` 带查询参数 POST 请求使用自定义编码
`static String`	`post(String url, String data, String mediaType)` 带查询参数 POST 请求使用默认编码 UTF-8
`static String`	`post(String url, String data, String mediaType, String charset)` 带查询参数 POST 请求使用自定义编码
`static String`	`toParams(Map<String,?> paramMap, Charset charset)` 将Map形式的Form表单数据转换为Url参数形式 paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）会自动url编码键和值
`static String`	`withForm(String url, Map<String,Object> form, Charset charset, boolean isEncodeParams)` 将表单数据加到URL中（用于GET表单提交）表单的键值对会被url编码，但是url中原参数不会被编码
`static String`	`withForm(String url, String queryString, Charset charset, boolean isEncode)` 将表单数据字符串加到URL中（用于GET表单提交）

Methods inherited from class org.aoju.bus.http.Client
authenticator, cache, callTimeoutMillis, certificatePinner, connectionPool, connectionSpecs, connectTimeoutMillis, cookieJar, dispatcher, dns, eventListenerFactory, followRedirects, followSslRedirects, hostnameVerifier, interceptors, networkInterceptors, newBuilder, newCall, newWebSocket, pingIntervalMillis, protocols, proxy, proxyAuthenticator, proxySelector, readTimeoutMillis, retryOnConnectionFailure, socketFactory, sslSocketFactory, writeTimeoutMillis

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

Constructor Detail

HttpClient
```
public HttpClient()
```
提供返回实例的静态方法

HttpClient
```
public HttpClient(org.aoju.bus.http.HttpClient.X509TrustManager x509TrustManager)
```
提供返回实例的静态方法

Parameters:

x509TrustManager - 信任管理器

HttpClient
```
public HttpClient(int connTimeout,
                  int readTimeout,
                  int writeTimeout)
```
构建一个自定义配置的 HTTP Client 类

Parameters:

connTimeout - 连接

readTimeout - 读取

writeTimeout - 输出

HttpClient

public HttpClient(int connTimeout,
                  int readTimeout,
                  int writeTimeout,
                  int maxRequests,
                  int maxRequestsPerHost,
                  int maxIdleConnections,
                  int keepAliveDuration)

构建一个自定义配置的 HTTP Client 类

Parameters:: connTimeout - 连接; readTimeout - 读取; writeTimeout - 输出; maxRequests - 最大请求; maxRequestsPerHost - 主机最大请求; maxIdleConnections - 最大连接; keepAliveDuration - 链接时长

HttpClient

public HttpClient(Dns dns,
                  Proxy proxy,
                  int connTimeout,
                  int readTimeout,
                  int writeTimeout,
                  int maxRequests,
                  int maxRequestsPerHost,
                  int maxIdleConnections,
                  int keepAliveDuration)

构建一个自定义配置的 HTTP Client 类

Parameters:: dns - DNS 信息; proxy - 代理信息; connTimeout - 连接; readTimeout - 读取; writeTimeout - 输出; maxRequests - 最大请求; maxRequestsPerHost - 主机最大请求; maxIdleConnections - 最大连接; keepAliveDuration - 链接时长

HttpClient

public HttpClient(Dns dns,
                  Proxy proxy,
                  int connTimeout,
                  int readTimeout,
                  int writeTimeout,
                  int maxRequests,
                  int maxRequestsPerHost,
                  int maxIdleConnections,
                  int keepAliveDuration,
                  SSLSocketFactory sslSocketFactory,
                  X509TrustManager x509TrustManager,
                  HostnameVerifier hostnameVerifier)

构建一个自定义配置的 HTTP Client 类

Parameters:: dns - DNS 信息; proxy - 代理信息; connTimeout - 连接; readTimeout - 读取; writeTimeout - 输出; maxRequests - 最大请求; maxRequestsPerHost - 主机最大请求; maxIdleConnections - 最大连接; keepAliveDuration - 链接时长; sslSocketFactory - 抽象类，扩展自SocketFactory, SSLSocket的工厂; x509TrustManager - 证书信任管理器; hostnameVerifier - 主机名校验信息

Method Detail

get
```
public static String get(String url)
```
简单的 GET 请求使用默认编码 UTF-8

Parameters:

url - URL地址 String

Returns:

String

get
```
public static String get(String url,
                         String charset)
```
简单的 GET 请求使用自定义编码

Parameters:

url - URL地址 String

charset - 自定义编码 String

Returns:

String

get

public static String get(String url,
                         boolean isAsync)

异步get请求，回调

Parameters:: url - URL地址; isAsync - 是否异步
Returns:: String

get

public static String get(String url,
                         Map<String,Object> queryMap)

带查询参数 GET 请求使用默认编码 UTF-8

Parameters:: url - URL地址 String; queryMap - 查询参数 Map
Returns:: String

get

public static String get(String url,
                         Map<String,Object> queryMap,
                         Map<String,String> headerMap)

带查询参数 GET 请求使用默认编码 UTF-8

Parameters:: url - URL地址 String; queryMap - 查询参数 Map; headerMap - Header参数 Map
Returns:: String

get

public static String get(String url,
                         Map<String,Object> queryMap,
                         Map<String,String> headerMap,
                         String charset)

带查询参数 GET 请求使用自定义编码

Parameters:: url - URL地址 String; queryMap - 查询参数 Map; headerMap - Header参数 Map; charset - 自定义编码 String
Returns:: String

post
```
public static String post(String url)
```
form 方式 POST 请求

Parameters:

url - URL地址 String

Returns:

String

post
```
public static String post(String url,
                          Map<String,Object> formMap)
```
form 方式 POST 请求 application/x-www-form-urlencoded

Parameters:

url - URL地址 String

formMap - 查询参数 Map

Returns:

String

post

public static String post(String url,
                          String data,
                          String mediaType)

带查询参数 POST 请求使用默认编码 UTF-8

Parameters:: url - URL地址 String; data - 请求数据 String; mediaType - 类型 String
Returns:: String

post

public static String post(String url,
                          String data,
                          String mediaType,
                          String charset)

带查询参数 POST 请求使用自定义编码

Parameters:: url - URL地址 String; data - 请求数据 String; mediaType - 类型 String; charset - 自定义编码 String
Returns:: String

post

public static String post(String url,
                          Map<String,Object> queryMap,
                          String mediaType)

带查询参数 POST 请求使用默认编码 UTF-8

Parameters:: url - URL地址 String; queryMap - 请求数据 Map; mediaType - 类型 String
Returns:: String

post

public static String post(String url,
                          Map<String,Object> queryMap,
                          Map<String,String> headerMap)

带查询参数 POST 请求使用自定义编码

Parameters:: url - URL地址 String; headerMap - 头部数据 Map; queryMap - 请求数据 Map
Returns:: String

post

public static String post(String url,
                          Map<String,Object> queryMap,
                          String mediaType,
                          String charset)

带查询参数 POST 请求使用自定义编码

Parameters:: url - URL地址 String; queryMap - 请求数据 Map; mediaType - 类型 String; charset - 自定义编码 String
Returns:: String

post

public static String post(String url,
                          Map<String,Object> queryMap,
                          Map<String,String> headerMap,
                          String mediaType)

带查询参数 POST 请求使用自定义编码

Parameters:: url - URL地址 String; headerMap - 头部数据 Map; queryMap - 请求数据 Map; mediaType - 类型 String
Returns:: String

post

public static String post(String url,
                          Map<String,Object> queryMap,
                          Map<String,String> headerMap,
                          String mediaType,
                          String charset)

带查询参数 POST 请求使用自定义编码

Parameters:: url - URL地址 String; headerMap - 头部数据 Map; queryMap - 请求数据 Map; mediaType - 类型 String; charset - 自定义编码 String
Returns:: String

post

public static String post(String url,
                          Map<String,Object> params,
                          List<String> pathList)

表单提交带文件上传

Parameters:: url - 请求地址 String; params - 请求参数 Map; pathList - 上传文件 List
Returns:: String

getParameterMap
```
public static String getParameterMap(Map<String,Object> map)
```
Process the Http request Map

Parameters:

map - map

Returns:

The result is outputString。

encode
```
public static String encode(String paramsStr,
                            Charset charset)
```
对URL参数做编码，只编码键和值
提供的值可以是url附带参数，但是不能只是url
注意，此方法只能标准化整个URL，并不适合于单独编码参数值

Parameters:

paramsStr - url参数，可以包含url本身

charset - 编码

Returns:

编码后的url和参数

normalizeParams
```
public static String normalizeParams(String paramPart,
                                     Charset charset)
```
标准化参数字符串，即URL中？后的部分
注意，此方法只能标准化整个URL，并不适合于单独编码参数值

Parameters:

paramPart - 参数字符串

charset - 编码

Returns:

标准化的参数字符串

toParams
```
public static String toParams(Map<String,?> paramMap,
                              Charset charset)
```
将Map形式的Form表单数据转换为Url参数形式
paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）
会自动url编码键和值
```
 key1=v1&key2=&key3=v3
 
```
Parameters:

paramMap - 表单数据

charset - 编码

Returns:

url参数

decodeMap
```
public static Map<String,String> decodeMap(String params,
                                           String charset)
```
将URL参数解析为Map（也可以解析Post中的键值对参数）

Parameters:

params - 参数字符串（或者带参数的Path）

charset - 字符集

Returns:

参数Map

decode

public static Map<String,List<String>> decode(String params,
                                              String charset)

将URL参数解析为Map（也可以解析Post中的键值对参数）

Parameters:: params - 参数字符串（或者带参数的Path）; charset - 字符集
Returns:: 参数Map

withForm

public static String withForm(String url,
                              Map<String,Object> form,
                              Charset charset,
                              boolean isEncodeParams)

将表单数据加到URL中（用于GET表单提交）
表单的键值对会被url编码，但是url中原参数不会被编码

Parameters:: url - URL; form - 表单数据; charset - 编码; isEncodeParams - 是否对键和值做转义处理
Returns:: 合成后的URL

withForm

public static String withForm(String url,
                              String queryString,
                              Charset charset,
                              boolean isEncode)

将表单数据字符串加到URL中（用于GET表单提交）

Parameters:: url - URL; queryString - 表单数据字符串; charset - 编码; isEncode - 是否对键和值做转义处理
Returns:: 拼接后的字符串

Class HttpClient

Constructor Summary

Method Summary

Methods inherited from class org.aoju.bus.http.Client

Methods inherited from class java.lang.Object

Constructor Detail

HttpClient

HttpClient

HttpClient

HttpClient

HttpClient

HttpClient

Method Detail

get

get

get

get

get

get

post

post

post

post

post

post

post

post

post

post

getParameterMap

encode

normalizeParams

toParams

decodeMap

decode

withForm

withForm