BaseRequest

abstract class BaseRequest

Functions

addDownloadListener

fun addDownloadListener(progressListener: ProgressListener)

下载监听器

addHeader

fun addHeader(name: String, value: String)

添加请求头如果已存在相同name的请求头会添加而不会覆盖, 因为请求头本身存在多个值

addQuery

fun addQuery(name: String, value: Boolean?)

添加Url上的Query参数

fun addQuery(name: String, value: Number?)

添加Url上的Query参数

fun addQuery(name: String, value: String?, encoded: Boolean = false)

添加Url上的Query参数

buildRequest

open fun buildRequest(): Request

构建请求对象Request

enqueue

fun enqueue(block: Callback): Call

队列请求.

execute

inline fun <R> execute(): R

执行同步请求

fun <R> execute(type: Type): R

执行同步请求本方法仅为兼容Java使用存在

headers

fun headers(): Headers.Builder

全部请求头

param

abstract fun param(name: String, value: Boolean?)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

abstract fun param(name: String, value: Number?)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

abstract fun param(name: String, value: String?)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

abstract fun param(name: String, value: String?, encoded: Boolean)

基础类型表单参数如果当前请求为Url请求则为Query参数如果当前请求为表单请求则为表单参数如果当前为Multipart包含流/文件的请求则为multipart参数

removeHeader

fun removeHeader(name: String)

删除请求头

setCacheControl

fun setCacheControl(cacheControl: CacheControl)

设置Http缓存协议头的缓存控制

setCacheKey

fun setCacheKey(key: String)

自定义强制缓存使用的Key, 本方法对于Http缓存协议无效

setCacheMode

fun setCacheMode(mode: CacheMode)

设置缓存模式缓存模式将无视Http缓存协议进行强制读取/写入缓存

setCacheValidTime

fun setCacheValidTime(duration: Long, unit: TimeUnit = TimeUnit.MILLISECONDS)

强制缓存有效期注意即使缓存有效期很长也无法阻止LRU最近最少使用算法清除超出缓存最大限制标准Http缓存协议遵守协议本身的有效期, 当前方法配置无效

setClient

fun setClient(block: OkHttpClient.Builder.() -> Unit)

修改当前Request的OkHttpClient配置, 不会影响全局默认的OkHttpClient

setDownloadDir

fun setDownloadDir(name: File)

下载保存的目录, 也支持包含文件名称的完整路径, 如果使用完整路径则无视setDownloadFileName设置

fun setDownloadDir(name: String)

下载保存的目录, 也支持包含文件名称的完整路径, 如果使用完整路径则无视setDownloadFileName设置

setDownloadFileName

fun setDownloadFileName(name: String)

下载文件名如果setDownloadDir函数使用完整路径(包含文件名的参数)作为参数则将无视本函数设置如果不调用本函数则默认是读取服务器返回的文件名

setDownloadFileNameConflict

fun setDownloadFileNameConflict(enabled: Boolean = true)

下载文件路径存在同名文件时是创建新文件(添加序号)还是覆盖重命名规则是: $文件名_($序号).

setDownloadFileNameDecode

fun setDownloadFileNameDecode(enabled: Boolean = true)

文件名称是否使用URL解码例如下载的文件名如果是中文, 服务器传输给你的会是被URL编码的字符串.

setDownloadMd5Verify

fun setDownloadMd5Verify(enabled: Boolean = true)

下载文件MD5校验如果服务器响应头Content-MD5值和指定路径已经存在的文件MD5相同, 则跳过下载直接返回该File

setDownloadTempFile

fun setDownloadTempFile(enabled: Boolean = true)

下载是否使用临时文件避免下载失败后覆盖同名文件或者无法判别是否已下载完整, 仅在下载完整以后才会显示为原有文件名临时文件命名规则: 文件名 + .downloading 下载文件名: install.apk, 临时文件名: install.apk.

setExtra

fun setExtra(name: String, tag: Any?)

设置额外信息

setGroup

fun setGroup(group: Any?)

请求分组 Group和Id在使用场景上有所区别, 预期上Group允许重复赋值给多个请求, Id仅允许赋值给一个请求, 但实际上都允许重复赋值在作用域中发起请求时会默认使用协程错误处理器作为Group: setGroup(coroutineContext[CoroutineExceptionHandler]) 如果你覆盖Group会导致协程结束不会自动取消请求

setHeader

fun setHeader(name: String, value: String)

设置请求头, 会覆盖请求头而不像addHeader是添加

setHeaders

fun setHeaders(headers: Headers)

批量设置请求头

setId

fun setId(id: Any?)

请求ID Group和Id在使用场景上有所区别, 预期上Group允许重复赋值给多个请求, Id仅允许赋值给一个请求, 但实际上都允许重复赋值在作用域中发起请求时会默认使用协程错误处理器作为Group: setGroup(coroutineContext[CoroutineExceptionHandler]) 如果你覆盖Group会导致协程结束不会自动取消请求

setKType

inline fun <T> setKType()

为请求附着KType信息 KType属于Kotlin特有的Type, 某些Kotlin框架可能会使用到, 例如 kotlin.

setPath

fun setPath(path: String?)

解析配置Path, 支持识别query参数和绝对路径

setQuery

fun setQuery(name: String, value: Boolean?)

设置Url上的Query参数

fun setQuery(name: String, value: Number?)

设置Url上的Query参数

fun setQuery(name: String, value: String?, encoded: Boolean = false)

设置Url上的Query参数

setUrl

open fun setUrl(url: URL)

设置Url

open fun setUrl(url: String)

设置一个Url字符串, 其参数不会和你初始化时设置的主域名NetConfig.host进行拼接一般情况下我建议使用更为聪明的setPath

open fun setUrl(url: HttpUrl)

设置Url

tag

fun tag(tag: Any?)

使用Any::class作为键名添加标签使用Request.

fun <T> tag(type: Class<in T>, tag: T?)

使用type作为key添加标签使用Request.

tagOf

inline fun <T> tagOf(tag: T?)

添加tag 使用Request.

toResult

inline fun <R> toResult(): Result<R>

执行同步请求

Properties

converter

open var converter: NetConverter

当前请求的数据转换器

httpUrl

open var httpUrl: HttpUrl.Builder

请求的Url构造器

method

open var method: Method

请求的方法

okHttpClient

open var okHttpClient: OkHttpClient

请求客户端

okHttpRequest

open var okHttpRequest: Request.Builder

请求对象构造器

Inheritors

BodyRequest

UrlRequest