HttpClient (easy-okhttp 1.1.0 API)

java.lang.Object
- java.lang.Enum<HttpClient>
- - com.mzlion.easyokhttp.HttpClient

所有已实现的接口:

Serializable, Comparable<HttpClient>
```
public enum HttpClient
extends Enum<HttpClient>
```
HttpClient是对OkHttpClient封装，提供更便捷的网络操作。
修订历史：
- 2016-05-12 项目创建
- 2016-12-28 项目改版及其优化
版本:

1.0

作者:

mzlion(https://git.oschina.net/mzllon/easy-okhttp)

枚举常量概要

枚举常量
枚举常量和说明

Instance

枚举常量
枚举常量和说明
`Instance`

字段概要

字段
限定符和类型字段和说明

static int DEFAULT_TIMEOUT

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_TIMEOUT`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`HttpClient`	`addInterceptor(okhttp3.Interceptor customInterceptor)` 添加全局拦截器
`static BinaryBodyPostRequest`	`binaryBody(String url)` 向请求体中传入二进制流
`HttpClient`	`clearDefaultHeaders(String host)` 清除默认参数
`HttpClient`	`connectTimeout(int connectTimeout)` 设置连接超时时间
`HttpClient`	`connectTimeout(int connectTimeout, TimeUnit timeUnit)` 设置连接超时时间
`HttpClient`	`customSSL(InputStream... certificates)` https单向认证
`HttpClient`	`customSSL(InputStream pfxStream, char[] pfxPwd, InputStream... certificates)` https双向认证
`HttpClient`	`customSSL(InputStream pfxStream, char[] pfxPwd, X509TrustManager trustManager)` https双向认证
`HttpClient`	`customSSL(X509TrustManager trustManager)` https单向认证,直接配置证书管理
`HttpClient`	`debugLog()` 调试模式，默认打印请求参数和响应结果
`HttpClient`	`debugLog(DebugLoggingInterceptor.Level loggingLevel)` 调试模式，自定义设置日志级别
`static GetRequest`	`get(String url)` Get请求
`CookieStore`	`getCookieStore()` 返回CookieStore实现类
`Map<String,String>`	`getDefaultHeaders(okhttp3.HttpUrl httpUrl)` 获取默认的Http Header列表
`Map<String,String>`	`getDefaultHeaders(String host)` 获取默认的Http Header列表
`okhttp3.OkHttpClient`	`getOkHttpClient()` 返回OkHttpClient对象
`okhttp3.OkHttpClient.Builder`	`getOkHttpClientBuilder()`
`static PostRequest`	`post(String url)` FORM/POST表单提交
`HttpClient`	`readTimeout(int readTimeout)` 设置流读取超时时间
`HttpClient`	`readTimeout(int readTimeout, TimeUnit timeUnit)` 设置流读取超时时间
`HttpClient`	`setCookieStore(CookieStore cookieStore)` 提供自己管理Cookie的能力
`HttpClient`	`setDefaultHeader(String host, String name, String value)` 设置默认的Http Header
`static TextBodyRequest`	`textBody(String url)` 文本POST请求体
`static HttpClient`	`valueOf(String name)` 返回带有指定名称的该类型的枚举常量。
`static HttpClient[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。
`HttpClient`	`writeTimeout(int writeTimeout)` 设置流的写入超时时间
`HttpClient`	`writeTimeout(int writeTimeout, TimeUnit timeUnit)` 设置流的写入超时时间

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 枚举常量详细资料
  - Instance
```
public static final HttpClient Instance
```
- 字段详细资料
  - DEFAULT_TIMEOUT
```
public static final int DEFAULT_TIMEOUT
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - values
```
public static HttpClient[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (HttpClient c : HttpClient.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static HttpClient valueOf(String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    NullPointerException - 如果参数为空值
  - connectTimeout
```
public HttpClient connectTimeout(int connectTimeout,
                                 TimeUnit timeUnit)
```
    设置连接超时时间
    
    参数:
    
    connectTimeout - 超时时间
    
    timeUnit - 超时时间单位
    
    返回:
    
    HttpClient
  - connectTimeout
```
public HttpClient connectTimeout(int connectTimeout)
```
    设置连接超时时间
    
    参数:
    
    connectTimeout - 超时时间,单位秒
    
    返回:
    
    HttpClient
    
    另请参阅:
    
    connectTimeout(int, TimeUnit)
  - readTimeout
```
public HttpClient readTimeout(int readTimeout,
                              TimeUnit timeUnit)
```
    设置流读取超时时间
    
    参数:
    
    readTimeout - 读取超时时间,单位毫秒
    
    timeUnit - 超时时间单位
    
    返回:
    
    HttpClient
  - readTimeout
```
public HttpClient readTimeout(int readTimeout)
```
    设置流读取超时时间
    
    参数:
    
    readTimeout - 读取超时时间,单位秒
    
    返回:
    
    HttpClient
    
    另请参阅:
    
    readTimeout(int, TimeUnit)
  - writeTimeout
```
public HttpClient writeTimeout(int writeTimeout,
                               TimeUnit timeUnit)
```
    设置流的写入超时时间
    
    参数:
    
    writeTimeout - 写入超时时间,单位是毫秒
    
    timeUnit - 超时时间单位
    
    返回:
    
    HttpClient
  - writeTimeout
```
public HttpClient writeTimeout(int writeTimeout)
```
    设置流的写入超时时间
    
    参数:
    
    writeTimeout - 写入超时时间,单位是秒
    
    返回:
    
    HttpClient
    
    另请参阅:
    
    writeTimeout(int, TimeUnit)
  - customSSL
```
public HttpClient customSSL(InputStream... certificates)
```
    https单向认证
    
    参数:
    
    certificates - 含有服务端公钥的证书
    
    返回:
    
    HttpClient
  - customSSL
```
public HttpClient customSSL(X509TrustManager trustManager)
```
    https单向认证,直接配置证书管理
    
    参数:
    
    trustManager - 证书管理器
    
    返回:
    
    HttpClient
  - customSSL
```
public HttpClient customSSL(InputStream pfxStream,
                            char[] pfxPwd,
                            InputStream... certificates)
```
    https双向认证
    
    参数:
    
    pfxStream - 客户端证书，支持P12的证书
    
    pfxPwd - 客户端证书密码
    
    certificates - 含有服务端公钥的证书
    
    返回:
    
    HttpClient
  - customSSL
```
public HttpClient customSSL(InputStream pfxStream,
                            char[] pfxPwd,
                            X509TrustManager trustManager)
```
    https双向认证
    
    参数:
    
    pfxStream - 客户端证书，支持P12的证书
    
    pfxPwd - 客户端证书密码
    
    trustManager - 证书管理器
    
    返回:
    
    HttpClient
  - setDefaultHeader
```
public HttpClient setDefaultHeader(String host,
                                   String name,
                                   String value)
```
    设置默认的Http Header
    
    参数:
    
    host - 主机名
    
    name - Header名称
    
    value - Header值
    
    返回:
    
    HttpClient
  - getDefaultHeaders
```
public Map<String,String> getDefaultHeaders(String host)
```
    获取默认的Http Header列表
    
    参数:
    
    host - 主机名
    
    返回:
    
    Header键值对列表
  - getDefaultHeaders
```
public Map<String,String> getDefaultHeaders(okhttp3.HttpUrl httpUrl)
```
    获取默认的Http Header列表
    
    参数:
    
    httpUrl - 地址信息
    
    返回:
    
    Header键值对列表
  - clearDefaultHeaders
```
public HttpClient clearDefaultHeaders(String host)
```
    清除默认参数
    
    参数:
    
    host - 主机名
    
    返回:
    
    HttpClient
  - setCookieStore
```
public HttpClient setCookieStore(CookieStore cookieStore)
```
    提供自己管理Cookie的能力
    
    参数:
    
    cookieStore - 操作Cookie的接口
    
    返回:
    
    HttpClient
  - getCookieStore
```
public CookieStore getCookieStore()
```
    返回CookieStore实现类
    
    返回:
    
    CookieStore
  - addInterceptor
```
public HttpClient addInterceptor(okhttp3.Interceptor customInterceptor)
```
    添加全局拦截器
    
    参数:
    
    customInterceptor - 拦截器接口
    
    返回:
    
    HttpClient
  - debugLog
```
public HttpClient debugLog()
```
    调试模式，默认打印请求参数和响应结果
    
    返回:
    
    HttpClient
  - debugLog
```
public HttpClient debugLog(DebugLoggingInterceptor.Level loggingLevel)
```
    调试模式，自定义设置日志级别
    
    参数:
    
    loggingLevel - 日志级别
    
    返回:
    
    HttpClient
    
    另请参阅:
    
    DebugLoggingInterceptor.Level
  - getOkHttpClient
```
public okhttp3.OkHttpClient getOkHttpClient()
```
    返回OkHttpClient对象
    
    返回:
    
    OkHttpClient
  - getOkHttpClientBuilder
```
public okhttp3.OkHttpClient.Builder getOkHttpClientBuilder()
```
  - get
```
public static GetRequest get(String url)
```
    Get请求
    
    参数:
    
    url - 请求地址
    
    返回:
    
    GetRequest
  - post
```
public static PostRequest post(String url)
```
    FORM/POST表单提交
    
    参数:
    
    url - 提交地址
    
    返回:
    
    PostRequest
  - binaryBody
```
public static BinaryBodyPostRequest binaryBody(String url)
```
    向请求体中传入二进制流
    
    参数:
    
    url - 请求地址
    
    返回:
    
    BinaryBodyPostRequest
  - textBody
```
public static TextBodyRequest textBody(String url)
```
    文本POST请求体
    
    参数:
    
    url - 请求地址
    
    返回:
    
    TextBodyRequest

枚举 HttpClient

枚举常量概要

字段概要

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

枚举常量详细资料

Instance

字段详细资料

DEFAULT_TIMEOUT

方法详细资料

values

valueOf

connectTimeout

connectTimeout

readTimeout

readTimeout

writeTimeout

writeTimeout

customSSL

customSSL

customSSL

customSSL

setDefaultHeader

getDefaultHeaders

getDefaultHeaders

clearDefaultHeaders

setCookieStore

getCookieStore

addInterceptor

debugLog

debugLog

getOkHttpClient

getOkHttpClientBuilder

get

post

binaryBody

textBody