AbsHttpRequest (easy-okhttp 1.1.0 API)

java.lang.Object
- com.mzlion.easyokhttp.request.AbsHttpRequest<Req>

所有已实现的接口:

HttpRequest<Req>

直接已知子类:

BinaryBodyPostRequest, GetRequest, PostRequest, TextBodyRequest
```
public abstract class AbsHttpRequest<Req extends HttpRequest<Req>>
extends Object
implements HttpRequest<Req>
```
2016-04-16 HttpRequest的抽象实现，实现了大部分方法.

作者:

mzlion on 2016-04-16

字段概要

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

protected org.slf4j.Logger logger

protected String url

字段
限定符和类型	字段和说明
`protected org.slf4j.Logger`	`logger`
`protected String`	`url`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`<E> E`	`asBean(Class<E> targetClass)` 将响应结果转为JavaBean对象
`<E> E`	`asBean(com.mzlion.core.json.TypeRef<E> typeRef)` 将响应结果转为JavaBean对象用法如下：Map<String,String> data = httpResponse.asBean(new TypeRef<Map<String,String>>);
`byte[]`	`asByteData()` 将响应结果转为字节数组
`void`	`asFile(File saveFile)` 将响应结果输出到文件中
`void`	`asStream(OutputStream out)` 将响应结果输出到输出流,并不会主动关闭输出流`out`
`String`	`asString()` 将响应结果转为字符串
`Req`	`connectTimeout(int connectTimeout)` 为构建本次HttpRequest设置单独连接超时时间。
`Req`	`connectTimeout(int connectTimeout, TimeUnit timeUnit)` 为构建本次HttpRequest设置单独连接超时时间。
`Req`	`customSSL(InputStream... certificates)` 为构建本次HttpRequest设置单独SSL证书
`Req`	`customSSL(InputStream pfxStream, char[] pfxPwd, InputStream... certificates)` SSL双向认证
`Req`	`customSSL(InputStream pfxStream, char[] pfxPwd, X509TrustManager trustManager)` SSL双向认证
`Req`	`customSSL(X509TrustManager trustManager)` 为构建本次HttpRequest设置SSL单向认证
`HttpResponse`	`execute()` 执行HTTP请求,获取响应结果
`<T> void`	`execute(Callback<T> callback)` 异步执行请求
`protected abstract okhttp3.Request`	`generateRequest(okhttp3.RequestBody requestBody)` 根据不同的请求方式，将RequestBody转换成Request对象
`protected abstract okhttp3.RequestBody`	`generateRequestBody()` 获取RequestBody对象
`Req`	`header(String name, String value)` 添加请求头信息
`Req`	`queryString(Map<String,String> parameters)` 为url地址设置请求参数，即url?
`Req`	`queryString(String name, Number value)` 为url地址设置请求参数，即url?
`Req`	`queryString(String name, String value)` 为url地址设置请求参数，即url?
`Req`	`queryString(String name, String value, boolean replace)` 为url地址设置请求参数，即url?
`Req`	`readTimeout(int readTimeout)` 为构建本次HttpRequest设置单独读取流超时。
`Req`	`readTimeout(int readTimeout, TimeUnit timeUnit)` 为构建本次HttpRequest设置单独读取流超时。
`Req`	`removeHeader(String name)` 从请求头中移除键值
`Req`	`url(String url)` 设置请求地址
`Req`	`writeTimeout(int writeTimeout)` 为构建本次HttpRequest设置单独写入流超时。
`Req`	`writeTimeout(int writeTimeout, TimeUnit timeUnit)` 为构建本次HttpRequest设置单独写入流超时。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - logger
```
protected org.slf4j.Logger logger
```
  - url
```
protected String url
```
- 方法详细资料
  - url
```
public Req url(String url)
```
    设置请求地址
    
    指定者:
    
    url 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    url - 请求地址
    
    返回:
    
    返回当前类Req的对象自己
  - queryString
```
public Req queryString(String name,
                       Number value)
```
    为url地址设置请求参数，即url?username=admin pwd=123
    
    指定者:
    
    queryString 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    name - 参数名
    
    value - 参数值
    
    返回:
    
    返回当前类Req的对象自己
  - queryString
```
public Req queryString(String name,
                       String value)
```
    为url地址设置请求参数，即url?username=admin pwd=123
    
    指定者:
    
    queryString 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    name - 参数名
    
    value - 参数值
    
    返回:
    
    返回当前类Req的对象自己
  - queryString
```
public Req queryString(String name,
                       String value,
                       boolean replace)
```
    为url地址设置请求参数，即url?username=admin pwd=123
    
    指定者:
    
    queryString 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    name - 参数名
    
    value - 参数值
    
    replace - 值为[@code true}则替换
    
    返回:
    
    返回当前类Req的对象自己
  - queryString
```
public Req queryString(Map<String,String> parameters)
```
    为url地址设置请求参数，即url?username=admin pwd=123
    
    指定者:
    
    queryString 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    parameters - 参数对
    
    返回:
    
    返回当前类Req的对象自己
  - header
```
public Req header(String name,
                  String value)
```
    添加请求头信息
    
    指定者:
    
    header 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    name - 请求头键名
    
    value - 请求头值
    
    返回:
    
    返回当前类Req的对象自己
  - removeHeader
```
public Req removeHeader(String name)
```
    从请求头中移除键值
    
    指定者:
    
    removeHeader 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    name - 请求头键名
    
    返回:
    
    返回当前类Req的对象自己
  - connectTimeout
```
public Req connectTimeout(int connectTimeout,
                          TimeUnit timeUnit)
```
    为构建本次HttpRequest设置单独连接超时时间。调用此方法会重新创建OkHttpClient。
    
    指定者:
    
    connectTimeout 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    connectTimeout - 连接超时时间
    
    timeUnit - 超时时间单位
    
    返回:
    
    返回当前类Req的对象自己
  - connectTimeout
```
public Req connectTimeout(int connectTimeout)
```
    为构建本次HttpRequest设置单独连接超时时间。调用此方法会重新创建OkHttpClient。
    
    指定者:
    
    connectTimeout 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    connectTimeout - 连接超时时间
    
    返回:
    
    返回当前类Req的对象自己
  - readTimeout
```
public Req readTimeout(int readTimeout,
                       TimeUnit timeUnit)
```
    为构建本次HttpRequest设置单独读取流超时。
    
    指定者:
    
    readTimeout 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    readTimeout - 流读取超时时间
    
    timeUnit - 超时时间单位
    
    返回:
    
    返回当前类Req的对象自己
  - readTimeout
```
public Req readTimeout(int readTimeout)
```
    为构建本次HttpRequest设置单独读取流超时。
    
    指定者:
    
    readTimeout 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    readTimeout - 流读取超时时间
    
    返回:
    
    返回当前类Req的对象自己
  - writeTimeout
```
public Req writeTimeout(int writeTimeout,
                        TimeUnit timeUnit)
```
    为构建本次HttpRequest设置单独写入流超时。
    
    指定者:
    
    writeTimeout 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    writeTimeout - 流写入超时时间
    
    timeUnit - 超时时间单位
    
    返回:
    
    返回当前类Req的对象自己
  - writeTimeout
```
public Req writeTimeout(int writeTimeout)
```
    为构建本次HttpRequest设置单独写入流超时。
    
    指定者:
    
    writeTimeout 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    writeTimeout - 流写入超时时间
    
    返回:
    
    返回当前类Req的对象自己
  - customSSL
```
public Req customSSL(InputStream... certificates)
```
    为构建本次HttpRequest设置单独SSL证书
    
    指定者:
    
    customSSL 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    certificates - SSL证书文件
    
    返回:
    
    返回当前类Req的对象自己
  - customSSL
```
public Req customSSL(X509TrustManager trustManager)
```
    为构建本次HttpRequest设置SSL单向认证
    
    指定者:
    
    customSSL 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    trustManager - 证书管理器
    
    返回:
    
    返回当前类Req的对象自己
  - customSSL
```
public Req customSSL(InputStream pfxStream,
                     char[] pfxPwd,
                     InputStream... certificates)
```
    SSL双向认证
    
    指定者:
    
    customSSL 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    pfxStream - 客户端证书，支持P12的证书
    
    pfxPwd - 客户端证书密码
    
    certificates - 含有服务端公钥的证书
    
    返回:
    
    Req
  - customSSL
```
public Req customSSL(InputStream pfxStream,
                     char[] pfxPwd,
                     X509TrustManager trustManager)
```
    SSL双向认证
    
    指定者:
    
    customSSL 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    参数:
    
    pfxStream - 客户端证书，支持P12的证书
    
    pfxPwd - 客户端证书密码
    
    trustManager - 证书管理器
    
    返回:
    
    Req
  - asString
```
public String asString()
```
    将响应结果转为字符串
    
    返回:
    
    响应结果字符串
    
    抛出:
    
    HttpClientException - 如果服务器返回非200则抛出此异常
  - asBean
```
public <E> E asBean(Class<E> targetClass)
```
    将响应结果转为JavaBean对象
    
    类型参数:
    
    E - 泛型类型
    
    参数:
    
    targetClass - 目标类型
    
    返回:
    
    JavaBean对象
    
    抛出:
    
    HttpClientException - 如果服务器返回非200则抛出此异常
  - asBean
```
public <E> E asBean(com.mzlion.core.json.TypeRef<E> typeRef)
```
    将响应结果转为JavaBean对象
    用法如下：Map<String,String> data = httpResponse.asBean(new TypeRef<Map<String,String>>);
    
    类型参数:
    
    E - 泛型类型
    
    参数:
    
    typeRef - 带有泛型类的封装类
    
    返回:
    
    JavaBean对象
    
    抛出:
    
    HttpClientException - 如果服务器返回非200则抛出此异常
  - asByteData
```
public byte[] asByteData()
```
    将响应结果转为字节数组
    
    返回:
    
    字节数组
    
    抛出:
    
    HttpClientException - 如果服务器返回非200则抛出此异常
  - asFile
```
public void asFile(File saveFile)
```
    将响应结果输出到文件中
    
    参数:
    
    saveFile - 目标保存文件,非空
  - asStream
```
public void asStream(OutputStream out)
```
    将响应结果输出到输出流,并不会主动关闭输出流out
    
    参数:
    
    out - 输出流,非空
  - execute
```
public HttpResponse execute()
```
    执行HTTP请求,获取响应结果
    
    指定者:
    
    execute 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    返回:
    
    将响应结果转为具体的JavaBean
  - execute
```
public <T> void execute(Callback<T> callback)
```
    异步执行请求
    
    指定者:
    
    execute 在接口中 HttpRequest<Req extends HttpRequest<Req>>
    
    类型参数:
    
    T - 数据类型
    
    参数:
    
    callback - 回调接口
  - generateRequestBody
```
protected abstract okhttp3.RequestBody generateRequestBody()
```
    获取RequestBody对象
    
    返回:
    
    RequestBody
  - generateRequest
```
protected abstract okhttp3.Request generateRequest(okhttp3.RequestBody requestBody)
```
    根据不同的请求方式，将RequestBody转换成Request对象
    
    参数:
    
    requestBody - 请求体
    
    返回:
    
    Request
    
    另请参阅:
    
    RequestBody

类 AbsHttpRequest<Req extends HttpRequest<Req>>

字段概要

方法概要

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

字段详细资料

logger

url

方法详细资料

url

queryString

queryString

queryString

queryString

header

removeHeader

connectTimeout

connectTimeout

readTimeout

readTimeout

writeTimeout

writeTimeout

customSSL

customSSL

customSSL

customSSL

asString

asBean

asBean

asByteData

asFile

asStream

execute

execute

generateRequestBody

generateRequest