HttpBuilder (toolset 1.4.RELEASE API)

java.lang.Object
- net.lulihu.http.builder.HttpBuilder

直接已知子类:

HttpGetBuilder, HttpPostBuilder, HttpPostMultipartBuilder, HttpPostPayloadBuilder
```
public abstract class HttpBuilder
extends Object
```
http构建类
注意：发送完请求后如果不需要对响应结果进行处理需要调用 close()方法来关闭响应链接

字段概要

字段
限定符和类型	字段和说明
`protected okhttp3.Headers.Builder`	`headerBuilder` 请求头构建
`protected okhttp3.OkHttpClient.Builder`	`httpClientBuilder` http 请求客户端构建
`protected okhttp3.Request.Builder`	`requestBuilder` 请求对象构建
`protected okhttp3.ResponseBody`	`responseBody` 请求结果
`protected String`	`url` 请求路径

构造器概要

构造器
构造器和说明

HttpBuilder(String url)

构造器
构造器和说明
`HttpBuilder(String url)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`HttpBuilder`	`addHeader(String key, String value)` 添加请求头信息
`HttpBuilder`	`addNetInterceptor(okhttp3.Interceptor interceptor)` 添加网络层拦截器
`HttpBuilder`	`addRequestInterceptor(RequestInterceptor requestInterceptor)` 添加请求拦截器
`HttpBuilder`	`addResponseInterceptor(ResponseInterceptor responseInterceptor)` 添加响应拦截器
`InputStream`	`byteStream()` 获取字节流
`void`	`close()` 关闭响应体如果只发送请求，不对请求结果进行处理记得只send方法后执行该方法
`static HttpGetBuilder`	`get(String url)` 准备发送get请求
`<T> List<T>`	`getJsonArrayResult(Class<T> resultClass)` 获取json array 结果
`<T> T`	`getJsonObjResult(Class<T> resultClass)` 获取json obj 结果
`String`	`getResult()` 获取请求结果
`static HttpPostBuilder`	`post(String url)` 准备发送Post请求
`static HttpPostMultipartBuilder`	`postMultipart(String url)` 准备发送 post 多部分分片请求
`static HttpPostPayloadBuilder`	`postPayload(String url)` 准备发送Post Payload 有效载荷请求
`protected void`	`sendRequest()` 发送请求
`HttpBuilder`	`setConnectTimeout(long timeout, TimeUnit unit)` 设置连接超时时间
`HttpBuilder`	`setHeader(Map<String,String> header)` 设置请求头信息
`HttpBuilder`	`setReadTimeout(long timeout, TimeUnit unit)` 设置读取超时时间
`void`	`writeFile(File file)` 数据写入文件

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

- 字段详细资料
  - url
```
protected final String url
```
    请求路径
  - headerBuilder
```
protected okhttp3.Headers.Builder headerBuilder
```
    请求头构建
  - httpClientBuilder
```
protected okhttp3.OkHttpClient.Builder httpClientBuilder
```
    http 请求客户端构建
  - requestBuilder
```
protected okhttp3.Request.Builder requestBuilder
```
    请求对象构建
  - responseBody
```
protected okhttp3.ResponseBody responseBody
```
    请求结果
- 构造器详细资料
  - HttpBuilder
```
public HttpBuilder(String url)
```
- 方法详细资料
  - get
```
public static HttpGetBuilder get(String url)
```
    准备发送get请求
    
    参数:
    
    url - 请求地址
    
    返回:
    
    HttpGetBuilder
  - post
```
public static HttpPostBuilder post(String url)
```
    准备发送Post请求
    
    参数:
    
    url - 请求地址
    
    返回:
    
    HttpPostBuilder
  - postPayload
```
public static HttpPostPayloadBuilder postPayload(String url)
```
    准备发送Post Payload 有效载荷请求
    
    参数:
    
    url - 请求地址
    
    返回:
    
    HttpPostPayloadBuilder
  - postMultipart
```
public static HttpPostMultipartBuilder postMultipart(String url)
```
    准备发送 post 多部分分片请求
    
    参数:
    
    url - 请求地址
    
    返回:
    
    HttpPostMultipartBuilder
  - addNetInterceptor
```
public HttpBuilder addNetInterceptor(okhttp3.Interceptor interceptor)
```
    添加网络层拦截器
    
    参数:
    
    interceptor - 网络层拦截器
    
    返回:
    
    HttpBuilder
  - addRequestInterceptor
```
public HttpBuilder addRequestInterceptor(RequestInterceptor requestInterceptor)
```
    添加请求拦截器
    
    参数:
    
    requestInterceptor - 请求拦截器
    
    返回:
    
    HttpBuilder
  - addResponseInterceptor
```
public HttpBuilder addResponseInterceptor(ResponseInterceptor responseInterceptor)
```
    添加响应拦截器
    
    参数:
    
    responseInterceptor - 响应拦截器
    
    返回:
    
    HttpBuilder
  - setHeader
```
public HttpBuilder setHeader(Map<String,String> header)
```
    设置请求头信息
    
    参数:
    
    header - 头部信息
    
    返回:
    
    HttpBuilder
  - addHeader
```
public HttpBuilder addHeader(String key,
                             String value)
```
    添加请求头信息
    
    参数:
    
    key - 键
    
    value - 值
    
    返回:
    
    HttpBuilder
  - setConnectTimeout
```
public HttpBuilder setConnectTimeout(long timeout,
                                     TimeUnit unit)
```
    设置连接超时时间
    
    参数:
    
    timeout - 超时时间
    
    unit - 时间单位
    
    返回:
    
    HttpBuilder
  - setReadTimeout
```
public HttpBuilder setReadTimeout(long timeout,
                                  TimeUnit unit)
```
    设置读取超时时间
    
    参数:
    
    timeout - 超时时间
    
    unit - 时间单位
    
    返回:
    
    HttpBuilder
  - sendRequest
```
protected final void sendRequest()
                          throws HttpRequestException
```
    发送请求
    
    抛出:
    
    HttpRequestException - 请求出现例外
  - close
```
public void close()
```
    关闭响应体
    如果只发送请求，不对请求结果进行处理记得只send方法后执行该方法
  - byteStream
```
public InputStream byteStream()
```
    获取字节流
    
    返回:
    
    字节流
  - writeFile
```
public void writeFile(File file)
               throws IOException
```
    数据写入文件
    
    参数:
    
    file - 文件不存在则创建
    
    抛出:
    
    IOException - 操作过程发生例外
  - getResult
```
public String getResult()
                 throws IOException
```
    获取请求结果
    
    返回:
    
    请求结果
    
    抛出:
    
    IOException - 响应主体转换为字符串发生例外
  - getJsonObjResult
```
public <T> T getJsonObjResult(Class<T> resultClass)
                       throws IOException
```
    获取json obj 结果
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    resultClass - 返回值封装对象
    
    返回:
    
    T
    
    抛出:
    
    IOException - 响应主体转换为字符串发生例外
  - getJsonArrayResult
```
public <T> List<T> getJsonArrayResult(Class<T> resultClass)
                               throws IOException
```
    获取json array 结果
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    resultClass - 返回值封装对象
    
    返回:
    
    List
    
    抛出:
    
    IOException - 响应主体转换为字符串发生例外

类 HttpBuilder

字段概要

构造器概要

方法概要

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

字段详细资料

url

headerBuilder

httpClientBuilder

requestBuilder

responseBody

构造器详细资料

HttpBuilder

方法详细资料

get

post

postPayload

postMultipart

addNetInterceptor

addRequestInterceptor

addResponseInterceptor

setHeader

addHeader

setConnectTimeout

setReadTimeout

sendRequest

close

byteStream

writeFile

getResult

getJsonObjResult

getJsonArrayResult