模块 okhttps
程序包 com.ejlchina.okhttps

接口 HTTP.Builder

  • 所有已知实现类:
    OkHttpBuilderImpl
    封闭接口:
    HTTP
    public static interface HTTP.Builder
    HTTP 构建器 自 v3.3.0 开始接口化，在以后版本中将逐步与 okhttp3 解耦

    • 方法详细资料

      • config

        HTTP.Builder config​(HTTP.OkConfig config)
        自 v3.2.0 后可以多次调用 配置 OkHttpClient
        参数:
        config - 配置器
        返回:
        Builder

      • baseUrl

        HTTP.Builder baseUrl​(String baseUrl)
        设置 baseUrl
        参数:
        baseUrl - 全局URL前缀
        返回:
        Builder

      • mediaTypes

        HTTP.Builder mediaTypes​(Map<String,​String> mediaTypes)
        配置媒体类型
        参数:
        mediaTypes - 媒体类型
        返回:
        Builder

      • mediaTypes

        HTTP.Builder mediaTypes​(String key,
                        String value)
        配置媒体类型
        参数:
        key - 媒体类型KEY
        value - 媒体类型VALUE
        返回:
        Builder

      • contentTypes

        HTTP.Builder contentTypes​(List<String> contentTypes)
        配置支持的报文体类型
        参数:
        contentTypes - 报文体类型列表
        返回:
        Builder

      • contentTypes

        HTTP.Builder contentTypes​(String contentType)
        配置支持的报文体类型
        参数:
        contentType - 报文体类型
        返回:
        Builder

      • contentTypes

        String[] contentTypes()

      • callbackExecutor

        HTTP.Builder callbackExecutor​(Executor executor)
        设置回调执行器，例如实现切换线程功能，只对异步请求有效
        参数:
        executor - 回调执行器
        返回:
        Builder

      • taskScheduler

        HTTP.Builder taskScheduler​(Scheduler scheduler)
        配置 任务调度器，可用的调度由 WHttpTask.heatbeat(int, int) 指定的心跳任务 若不配置，则生成一个 线程容量为 1 的 ScheduledThreadPoolExecutor 调度器
        参数:
        scheduler - 调度器
        返回:
        Builder
        从以下版本开始:
        v2.3.0

      • addPreprocessor

        HTTP.Builder addPreprocessor​(Preprocessor preprocessor)
        添加可并行处理请求任务的预处理器
        参数:
        preprocessor - 预处理器
        返回:
        Builder

      • addSerialPreprocessor

        HTTP.Builder addSerialPreprocessor​(Preprocessor preprocessor)
        添加串行预处理器
        参数:
        preprocessor - 预处理器
        返回:
        Builder

      • clearPreprocessors

        HTTP.Builder clearPreprocessors()
        清空预处理器（包括串行预处理器）
        返回:
        Builder
        从以下版本开始:
        v2.5.0

      • preprocTimeoutTimes

        HTTP.Builder preprocTimeoutTimes​(int times)
        最大预处理时间（倍数，相当普通请求的超时时间）
        参数:
        times - 普通超时时间的倍数，默认为 10
        返回:
        Builder

      • preprocTimeoutTimes

        int preprocTimeoutTimes()

      • downloadListener

        HTTP.Builder downloadListener​(DownListener listener)
        设置下载监听器
        参数:
        listener - 监听器
        返回:
        Builder

      • addMsgConvertor

        HTTP.Builder addMsgConvertor​(MsgConvertor msgConvertor)
        参数:
        msgConvertor - JSON 服务
        返回:
        Builder
        从以下版本开始:
        v2.0.0 添加消息转换器

      • clearMsgConvertors

        HTTP.Builder clearMsgConvertors()
        清空消息转换器
        返回:
        Builder
        从以下版本开始:
        v2.5.0

      • charset

        HTTP.Builder charset​(Charset charset)
        参数:
        charset - 编码
        返回:
        Builder
        从以下版本开始:
        v2.0.0 设置默认编码格式

      • bodyType

        HTTP.Builder bodyType​(String bodyType)
        参数:
        bodyType - 请求体类型
        返回:
        Builder
        从以下版本开始:
        v2.0.0 设置默认请求体类型

      • build

        HTTP build()
        构建 HTTP 实例
        返回:
        HTTP