HttpTask (OkHttps 2.0.0.RC API)

java.lang.Object
- com.ejlchina.okhttps.HttpTask<C>

所有已实现的接口:

Cancelable

直接已知子类:

AsyncHttpTask, SyncHttpTask, WebSocketTask
```
public abstract class HttpTask<C extends HttpTask<?>>
extends java.lang.Object
implements Cancelable
```
Created by 周旭（Troy.Zhou） on 2020/3/11.

字段概要

字段
限定符和类型	字段和说明
`protected HttpClient`	`httpClient`
`protected boolean`	`nextOnIO`
`protected boolean`	`nothrow`
`protected boolean`	`skipPreproc`
`protected boolean`	`skipSerialPreproc`

构造器概要

构造器
构造器和说明

HttpTask(HttpClient httpClient, java.lang.String url)

构造器
构造器和说明
`HttpTask(HttpClient httpClient, java.lang.String url)`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`C`	`addBodyPara(java.util.Map<java.lang.String,?> params)` Body参数：放在Body里的参数
`C`	`addBodyPara(java.lang.String name, java.lang.Object value)` Body参数：放在Body里的参数
`C`	`addBodyParam(java.util.Map<java.lang.String,?> params)` 已过时。
`C`	`addBodyParam(java.lang.String name, java.lang.Object value)` 已过时。
`C`	`addFilePara(java.lang.String name, java.io.File file)` 添加文件参数
`C`	`addFilePara(java.lang.String name, java.lang.String filePath)` 添加文件参数
`C`	`addFilePara(java.lang.String name, java.lang.String type, byte[] content)` 添加文件参数
`C`	`addFilePara(java.lang.String name, java.lang.String type, java.lang.String fileName, byte[] content)` 添加文件参数
`C`	`addFileParam(java.lang.String name, java.io.File file)` 已过时。
`C`	`addFileParam(java.lang.String name, java.lang.String filePath)` 已过时。
`C`	`addFileParam(java.lang.String name, java.lang.String type, byte[] content)` 已过时。
`C`	`addFileParam(java.lang.String name, java.lang.String type, java.io.InputStream inputStream)` 已过时。
`C`	`addFileParam(java.lang.String name, java.lang.String type, java.lang.String fileName, byte[] content)` 已过时。
`C`	`addFileParam(java.lang.String name, java.lang.String type, java.lang.String fileName, java.io.InputStream input)` 已过时。
`C`	`addHeader(java.util.Map<java.lang.String,java.lang.String> headers)` 添加请求头
`C`	`addHeader(java.lang.String name, java.lang.String value)` 添加请求头
`C`	`addJsonParam(java.util.Map<java.lang.String,?> params)` 已过时。
`C`	`addJsonParam(java.lang.String name, java.lang.Object value)` 已过时。
`C`	`addPathPara(java.util.Map<java.lang.String,?> params)` 路径参数：替换URL里的{name}
`C`	`addPathPara(java.lang.String name, java.lang.Object value)` 路径参数：替换URL里的{name}
`C`	`addPathParam(java.util.Map<java.lang.String,?> params)` 已过时。
`C`	`addPathParam(java.lang.String name, java.lang.Object value)` 已过时。
`C`	`addUrlPara(java.util.Map<java.lang.String,?> params)` URL参数：拼接在URL后的参数
`C`	`addUrlPara(java.lang.String name, java.lang.Object value)` URL参数：拼接在URL后的参数
`C`	`addUrlParam(java.util.Map<java.lang.String,?> params)` 已过时。
`C`	`addUrlParam(java.lang.String name, java.lang.Object value)` 已过时。
`protected void`	`assertNotConflict(boolean isGetRequest)`
`C`	`bind(java.lang.Object object)` 绑定一个对象
`C`	`bodyType(java.lang.String type)`
`boolean`	`cancel()` 取消
`C`	`charset(java.nio.charset.Charset charset)`
`java.nio.charset.Charset`	`charset(okhttp3.Response response)`
`java.lang.String`	`getBodyType()`
`java.lang.Object`	`getBound()` 获得被绑定的对象
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` 获取请求任务的头信息
`java.lang.String`	`getTag()` 获取请求任务的标签
`java.lang.String`	`getUrl()` 获取请求任务的URL地址
`boolean`	`isTagged(java.lang.String tag)` 标签匹配判断任务标签与指定的标签是否匹配（包含指定的标签）
`C`	`nextOnIO()` 下一个回调在IO线程执行
`C`	`nothrow()` 设置在发生异常时不向上抛出，设置后：异步请求可以在异常回调内捕获异常，同步请求在返回结果中找到该异常
`protected okhttp3.Call`	`prepareCall(java.lang.String method)`
`protected okhttp3.Request`	`prepareRequest(java.lang.String method)`
`protected void`	`registeTagTask(Cancelable canceler)`
`protected void`	`removeTagTask()`
`C`	`setBodyPara(java.lang.Object body)` 设置 json 请求体
`C`	`setOnProcess(OnCallback<Process> onProcess)` 设置报文体发送进度回调
`C`	`setRange(long rangeStart)` 设置Range头信息表示接收报文体时跳过的字节数，用于断点续传
`C`	`setRange(long rangeStart, long rangeEnd)` 设置Range头信息设置接收报文体时接收的范围，用于分块下载
`C`	`setRequestJson(java.lang.Object body)` 已过时。
`C`	`setRequestJson(java.lang.Object body, java.lang.String dateFormat)` 已过时。
`C`	`setStepBytes(long stepBytes)` 设置进度回调的步进字节，默认 8K（8192）表示每接收 stepBytes 个字节，执行一次进度回调
`C`	`setStepRate(double stepRate)` 设置进度回调的步进比例表示每接收 stepRate 比例，执行一次进度回调
`C`	`setTag(java.lang.String tag)` 已过时。
`C`	`skipPreproc()` 指定该请求跳过任何预处理器（包括串行和并行）
`C`	`skipSerialPreproc()` 指定该请求跳过任何串行预处理器
`C`	`tag(java.lang.String tag)`
`protected boolean`	`timeoutAwait(java.util.concurrent.CountDownLatch latch)`
`protected HttpResult`	`timeoutResult()`
`protected HttpResult.State`	`toState(java.io.IOException e, boolean sync)`

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

- 字段详细资料
  - httpClient
```
protected HttpClient httpClient
```
  - nothrow
```
protected boolean nothrow
```
  - nextOnIO
```
protected boolean nextOnIO
```
  - skipPreproc
```
protected boolean skipPreproc
```
  - skipSerialPreproc
```
protected boolean skipSerialPreproc
```
- 构造器详细资料
  - HttpTask
```
public HttpTask(HttpClient httpClient,
                java.lang.String url)
```
- 方法详细资料
  - getUrl
```
public java.lang.String getUrl()
```
    获取请求任务的URL地址
    
    返回:
    
    URL地址
  - getTag
```
public java.lang.String getTag()
```
    获取请求任务的标签
    
    返回:
    
    标签
  - getBodyType
```
public java.lang.String getBodyType()
```
  - isTagged
```
public boolean isTagged(java.lang.String tag)
```
    标签匹配判断任务标签与指定的标签是否匹配（包含指定的标签）
    
    参数:
    
    tag - 标签
    
    返回:
    
    是否匹配
  - getHeaders
```
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    获取请求任务的头信息
    
    返回:
    
    头信息
  - getBound
```
public java.lang.Object getBound()
```
    获得被绑定的对象
    
    返回:
    
    Object
  - nothrow
```
public C nothrow()
```
    设置在发生异常时不向上抛出，设置后：异步请求可以在异常回调内捕获异常，同步请求在返回结果中找到该异常
    
    返回:
    
    HttpTask 实例
  - skipPreproc
```
public C skipPreproc()
```
    指定该请求跳过任何预处理器（包括串行和并行）
    
    返回:
    
    HttpTask 实例
  - skipSerialPreproc
```
public C skipSerialPreproc()
```
    指定该请求跳过任何串行预处理器
    
    返回:
    
    HttpTask 实例
  - setTag
```
@Deprecated
public C setTag(java.lang.String tag)
```
    已过时。
  - tag
```
public C tag(java.lang.String tag)
```
    参数:
    
    tag - 标签
    
    返回:
    
    HttpTask 实例
    
    从以下版本开始:
    
    2.2.0 为请求任务添加标签
  - charset
```
public C charset(java.nio.charset.Charset charset)
```
    参数:
    
    charset - 编码格式
    
    返回:
    
    HttpTask 实例
    
    从以下版本开始:
    
    2.0.0 设置该请求的编码格式
  - bodyType
```
public C bodyType(java.lang.String type)
```
    参数:
    
    type - 请求类型
    
    返回:
    
    HttpTask 实例
    
    从以下版本开始:
    
    2.0.0 设置请求体的类型，如：form、json、xml、protobuf 等
  - nextOnIO
```
public C nextOnIO()
```
    下一个回调在IO线程执行
    
    返回:
    
    HttpTask 实例
  - bind
```
public C bind(java.lang.Object object)
```
    绑定一个对象
    
    参数:
    
    object - 对象
    
    返回:
    
    HttpTask 实例
  - addHeader
```
public C addHeader(java.lang.String name,
                   java.lang.String value)
```
    添加请求头
    
    参数:
    
    name - 请求头名
    
    value - 请求头值
    
    返回:
    
    HttpTask 实例
  - addHeader
```
public C addHeader(java.util.Map<java.lang.String,java.lang.String> headers)
```
    添加请求头
    
    参数:
    
    headers - 请求头集合
    
    返回:
    
    HttpTask 实例
  - setRange
```
public C setRange(long rangeStart)
```
    设置Range头信息表示接收报文体时跳过的字节数，用于断点续传
    
    参数:
    
    rangeStart - 表示从 rangeStart 个字节处开始接收，通常是已经下载的字节数，即上次的断点）
    
    返回:
    
    HttpTask 实例
  - setRange
```
public C setRange(long rangeStart,
                  long rangeEnd)
```
    设置Range头信息设置接收报文体时接收的范围，用于分块下载
    
    参数:
    
    rangeStart - 表示从 rangeStart 个字节处开始接收
    
    rangeEnd - 表示接收到 rangeEnd 个字节处
    
    返回:
    
    HttpTask 实例
  - setOnProcess
```
public C setOnProcess(OnCallback<Process> onProcess)
```
    设置报文体发送进度回调
    
    参数:
    
    onProcess - 进度回调函数
    
    返回:
    
    HttpTask 实例
  - setStepBytes
```
public C setStepBytes(long stepBytes)
```
    设置进度回调的步进字节，默认 8K（8192）表示每接收 stepBytes 个字节，执行一次进度回调
    
    参数:
    
    stepBytes - 步进字节
    
    返回:
    
    HttpTask 实例
  - setStepRate
```
public C setStepRate(double stepRate)
```
    设置进度回调的步进比例表示每接收 stepRate 比例，执行一次进度回调
    
    参数:
    
    stepRate - 步进比例
    
    返回:
    
    HttpTask 实例
  - addPathParam
```
@Deprecated
public C addPathParam(java.lang.String name,
                                   java.lang.Object value)
```
    已过时。
  - addPathPara
```
public C addPathPara(java.lang.String name,
                     java.lang.Object value)
```
    路径参数：替换URL里的{name}
    
    参数:
    
    name - 参数名
    
    value - 参数值
    
    返回:
    
    HttpTask 实例
  - addPathParam
```
@Deprecated
public C addPathParam(java.util.Map<java.lang.String,?> params)
```
    已过时。
  - addPathPara
```
public C addPathPara(java.util.Map<java.lang.String,?> params)
```
    路径参数：替换URL里的{name}
    
    参数:
    
    params - 参数集合
    
    返回:
    
    HttpTask 实例
  - addUrlParam
```
@Deprecated
public C addUrlParam(java.lang.String name,
                                  java.lang.Object value)
```
    已过时。
  - addUrlPara
```
public C addUrlPara(java.lang.String name,
                    java.lang.Object value)
```
    URL参数：拼接在URL后的参数
    
    参数:
    
    name - 参数名
    
    value - 参数值
    
    返回:
    
    HttpTask 实例
  - addUrlParam
```
@Deprecated
public C addUrlParam(java.util.Map<java.lang.String,?> params)
```
    已过时。
  - addUrlPara
```
public C addUrlPara(java.util.Map<java.lang.String,?> params)
```
    URL参数：拼接在URL后的参数
    
    参数:
    
    params - 参数集合
    
    返回:
    
    HttpTask 实例
  - addBodyParam
```
@Deprecated
public C addBodyParam(java.lang.String name,
                                   java.lang.Object value)
```
    已过时。
  - addBodyPara
```
public C addBodyPara(java.lang.String name,
                     java.lang.Object value)
```
    Body参数：放在Body里的参数
    
    参数:
    
    name - 参数名
    
    value - 参数值
    
    返回:
    
    HttpTask 实例
  - addBodyParam
```
@Deprecated
public C addBodyParam(java.util.Map<java.lang.String,?> params)
```
    已过时。
  - addBodyPara
```
public C addBodyPara(java.util.Map<java.lang.String,?> params)
```
    Body参数：放在Body里的参数
    
    参数:
    
    params - 参数集合
    
    返回:
    
    HttpTask 实例
  - addJsonParam
```
@Deprecated
public C addJsonParam(java.lang.String name,
                                   java.lang.Object value)
```
    已过时。
    
    推荐方案：setBodyPara 与 bodyType 方法 Json参数：请求体为Json，支持多层结构
    
    参数:
    
    name - JSON键名
    
    value - JSON键值
    
    返回:
    
    HttpTask 实例
  - addJsonParam
```
@Deprecated
public C addJsonParam(java.util.Map<java.lang.String,?> params)
```
    已过时。
    
    推荐方案：setBodyPara 与 bodyType 方法 Json参数：请求体为Json，只支持单层Json 若请求json为多层结构，请使用setRequestJson方法
    
    参数:
    
    params - JSON键值集合
    
    返回:
    
    HttpTask 实例
  - setRequestJson
```
@Deprecated
public C setRequestJson(java.lang.Object body)
```
    已过时。
    
    推荐方案：setBodyPara 与 bodyType 方法设置 json 请求体
    
    参数:
    
    body - JSON字符串或 Java对象（将依据对象的get方法序列化为 json 字符串）
    
    返回:
    
    HttpTask 实例
  - setRequestJson
```
@Deprecated
public C setRequestJson(java.lang.Object body,
                                     java.lang.String dateFormat)
```
    已过时。
    
    此方法性能较低推荐方案：setBodyPara 与 bodyType 方法，日期格式在 Java Bean 上使用注解的方式指定
    
    参数:
    
    body - Json 请求体
    
    dateFormat - 日期格式
    
    返回:
    
    HttpTask 实例
  - setBodyPara
```
public C setBodyPara(java.lang.Object body)
```
    设置 json 请求体
    
    参数:
    
    body - 请求体，字节数组、字符串或 Java对象（由 MsgConvertor 来序列化）
    
    返回:
    
    HttpTask 实例
  - addFileParam
```
@Deprecated
public C addFileParam(java.lang.String name,
                                   java.lang.String filePath)
```
    已过时。
  - addFilePara
```
public C addFilePara(java.lang.String name,
                     java.lang.String filePath)
```
    添加文件参数
    
    参数:
    
    name - 参数名
    
    filePath - 文件路径
    
    返回:
    
    HttpTask 实例
  - addFileParam
```
@Deprecated
public C addFileParam(java.lang.String name,
                                   java.io.File file)
```
    已过时。
  - addFilePara
```
public C addFilePara(java.lang.String name,
                     java.io.File file)
```
    添加文件参数
    
    参数:
    
    name - 参数名
    
    file - 文件
    
    返回:
    
    HttpTask 实例
  - addFileParam
```
@Deprecated
public C addFileParam(java.lang.String name,
                                   java.lang.String type,
                                   java.io.InputStream inputStream)
```
    已过时。
    
    建议直接使用文件上传，使用输入流性能较差添加文件参数
    
    参数:
    
    name - 参数名
    
    type - 文件类型: 如 png、jpg、jpeg 等
    
    inputStream - 文件输入流
    
    返回:
    
    HttpTask 实例
  - addFileParam
```
@Deprecated
public C addFileParam(java.lang.String name,
                                   java.lang.String type,
                                   java.lang.String fileName,
                                   java.io.InputStream input)
```
    已过时。
    
    建议直接使用文件上传，使用输入流性能较差添加文件参数
    
    参数:
    
    name - 参数名
    
    type - 文件类型: 如 png、jpg、jpeg 等
    
    fileName - 文件名
    
    input - 文件输入流
    
    返回:
    
    HttpTask 实例
  - addFileParam
```
@Deprecated
public C addFileParam(java.lang.String name,
                                   java.lang.String type,
                                   byte[] content)
```
    已过时。
  - addFilePara
```
public C addFilePara(java.lang.String name,
                     java.lang.String type,
                     byte[] content)
```
    添加文件参数
    
    参数:
    
    name - 参数名
    
    type - 文件类型: 如 png、jpg、jpeg 等
    
    content - 文件内容
    
    返回:
    
    HttpTask 实例
  - addFileParam
```
@Deprecated
public C addFileParam(java.lang.String name,
                                   java.lang.String type,
                                   java.lang.String fileName,
                                   byte[] content)
```
    已过时。
  - addFilePara
```
public C addFilePara(java.lang.String name,
                     java.lang.String type,
                     java.lang.String fileName,
                     byte[] content)
```
    添加文件参数
    
    参数:
    
    name - 参数名
    
    type - 文件类型: 如 png、jpg、jpeg 等
    
    fileName - 文件名
    
    content - 文件内容
    
    返回:
    
    HttpTask 实例
  - cancel
```
public boolean cancel()
```
    从接口复制的说明: Cancelable
    
    取消
    
    指定者:
    
    cancel 在接口中 Cancelable
    
    返回:
    
    取消是否成功
  - registeTagTask
```
protected void registeTagTask(Cancelable canceler)
```
  - removeTagTask
```
protected void removeTagTask()
```
  - prepareCall
```
protected okhttp3.Call prepareCall(java.lang.String method)
```
  - prepareRequest
```
protected okhttp3.Request prepareRequest(java.lang.String method)
```
  - toState
```
protected HttpResult.State toState(java.io.IOException e,
                                   boolean sync)
```
  - assertNotConflict
```
protected void assertNotConflict(boolean isGetRequest)
```
  - timeoutAwait
```
protected boolean timeoutAwait(java.util.concurrent.CountDownLatch latch)
```
    参数:
    
    latch - CountDownLatch
    
    返回:
    
    是否未超时：false 表示已超时
  - timeoutResult
```
protected HttpResult timeoutResult()
```
  - charset
```
public java.nio.charset.Charset charset(okhttp3.Response response)
```

类 HttpTask<C extends HttpTask<?>>

字段概要

构造器概要

方法概要

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

字段详细资料

httpClient

nothrow

nextOnIO

skipPreproc

skipSerialPreproc

构造器详细资料

HttpTask

方法详细资料

getUrl

getTag

getBodyType

isTagged

getHeaders

getBound

nothrow

skipPreproc

skipSerialPreproc

setTag

tag

charset

bodyType

nextOnIO

bind

addHeader

addHeader

setRange

setRange

setOnProcess

setStepBytes

setStepRate

addPathParam

addPathPara

addPathParam

addPathPara

addUrlParam

addUrlPara

addUrlParam

addUrlPara

addBodyParam

addBodyPara

addBodyParam

addBodyPara

addJsonParam

addJsonParam

setRequestJson

setRequestJson

setBodyPara

addFileParam

addFilePara

addFileParam

addFilePara

addFileParam

addFileParam

addFileParam

addFilePara

addFileParam

addFilePara

cancel

registeTagTask

removeTagTask

prepareCall

prepareRequest

toState

assertNotConflict

timeoutAwait

timeoutResult

charset