百科.dev
全部条目在线工具AI 编程趋势榜开源项目技术资讯提交条目
登录
< 返回工具列表
O

OkHttp3

> 编程语言
开源

基于 OkHttp3 封装的网络请求库 - 致力于提供最简洁、功能最全、可灵活扩展的网络操作 API

397 stars0 点赞0 次浏览
访问官网GitHub

工具介绍

基于 OkHttp3 封装的网络请求库 - 致力于提供最简洁、功能最全、可灵活扩展的网络操作 API

OkHttp3

基于OkHttp3封装的网络请求库

功能点

  • 支持Http/Https协议/自定义Https证书认证
  • 支持同步/异步请求
  • 支持异步延迟执行
  • 支持Post/Get/Put/Delete请求
  • 支持Cookie持久化,支持Gzip压缩
  • 支持协议头参数Head设置
  • 支持二进制参数、JSON、表单提交、SOAP提交
  • 支持Gson解析、Unicode自动转码、请求参数编码以及服务器响应编码设置
  • 支持四种缓存类型请求:仅网络、仅缓存、先网络再缓存、先缓存再网络
  • 支持自定义缓存存活时间与缓存清理功能
  • 当Activity/Fragment销毁时自动取消相应的所有网络请求,支持取消指定请求
  • 异步请求响应自动切换到UI线程,摒弃runOnUiThread
  • Application中自定义全局配置/增加系统默认配置
  • 支持文件和图片上传/批量上传,支持同步/异步上传,支持进度提示
  • 支持文件下载/批量下载,支持同步/异步下载,支持进度提示
  • 支持文件断点下载,独立下载的模块摒弃了数据库记录断点的过时方法
  • 完整的日志跟踪与异常处理
  • 支持请求结果拦截以及异常处理拦截
  • 支持单例客户端,提高网络请求速率
  • 完整的API示例
  • 后续优化中...

相关截图

网络请求演示

先网络再缓存演示

先缓存再网络演示

上传图片界面

断点下载文件界面

日志

  • GET-URL/POST-URL:请求地址
  • CostTime:请求耗时(单位:秒)
  • Response:响应串

项目演示DEMO

项目中已包含所有支持业务的demo,详情请下载项目参考源码。

引用方式

Maven


  com.zhousf.lib
  okhttp3
  2.9.9
  pom

Gradle

compile 'com.zhousf.lib:okhttp3:2.9.9'

若项目已包含support-annotations或出现support-annotations版本冲突请采用下面方式进行依赖:

compile ('com.zhousf.lib:okhttp3:2.9.9'){
    exclude(module: 'support-annotations')
}

若项目已包含Gson或出现Gson版本冲突请采用下面方式进行依赖:

compile ('com.zhousf.lib:okhttp3:2.9.9'){
    exclude(module:'gson')
}

ProGuard

如果你使用了ProGuard混淆,请添加如下配置:

-dontwarn okio.**

SDK版本

compileSdkVersion 23
targetSdkVersion 23
minSdkVersion 13

提交记录

  • 2016-6-29 项目提交
  • 2016-7-4
    • 项目框架调整
    • 增加Application中全局配置
    • 增加系统默认配置
    • 修复内存释放bug
  • 2016-7-19
    • 代码优化、降低耦合
    • 修复已知bug
  • 2016-8-9
    • 增加文件上传功能,支持批量上传
  • 2016-8-10
    • 增加文件下载功能,支持批量下载、断点下载
  • 2016-10-10
    • 增加请求结果拦截以及异常处理拦截
  • 2016-10-25
    • 支持Cookie持久化、协议头参数Head设置
  • 2016-12-12
    • 增加单例客户端,提高网络请求速率、取消指定请求功能
  • 2017-3-3
    • 修复上传文件入参bug(感谢Sanqi5401指正)
  • 2017-3-6
    • 在集成过程中出现了okio丢失的情况请添加 compile 'com.android.support:multidex:1.0.1' (感谢kevin提供相关解决方案)https://stackoverflow.com/questions/36649121/java-lang-noclassdeffounderror-okhttp3-okhttpclientbuilder
  • 2017-3-31
    • 增加单次批量上传文件功能:一次请求上传多个文件
  • 2017-4-21
    • 增加二进制流请求功能,DEMO中已添加动态权限申请功能
  • 2017-6-1
    • 支持PUT、DELETE请求
  • 2017-6-30
    • 支持异步延迟执行
  • 2017-9-13
    • Gson自动解析
  • 2017-9-20
    • 增加加载提示框示例
  • 2017-10-17
    • 支持自定义Https证书认证,增加实时网速浮动窗口
  • 2017-11-1
    • 增加Http动态代理示例,项目集成第三方网络库示例
  • 2018-1-4
    • 支持SOAP请求
  • 2018-1-16
    • 支持接口响应结果自定义解析Response;修复单例bug,感谢@yangjieK指正

权限

    
    
    
    
    
    
    
    
    

自定义全局配置

在Application中配置如下:

…

获取网络请求客户端单例示例

java
//获取单例客户端(默认)
 方法一、OkHttpUtil.getDefault(this)//绑定生命周期
            .doGetSync(HttpInfo.Builder().setUrl(url).build());
 方法二、OkHttpUtil.getDefault()//不绑定生命周期
            .doGetSync(HttpInfo.Builder().setUrl(url).build());
            

取消指定请求

建议在视图中采用OkHttpUtil.getDefault(this)的方式进行请求绑定,该方式会在Activity/Fragment销毁时自动取消当前视图下的所有请求; 请求标识类型支持Object、String、Integer、Float、Double; 请求标识务必保证唯一。

java
//*******请求时先绑定请求标识,根据该标识进行取消*******/
//方法一:
OkHttpUtil.Builder()
                .setReadTimeout(120)
                .build("请求标识")//绑定请求标识
                .doDownloadFileAsync(info);
//方法二:
OkHttpUtil.getDefault("请求标识")//绑定请求标识
            .doGetSync(info);
            
//*******取消指定请求*******/ 
OkHttpUtil.getDefault().cancelRequest("请求标识");
 

HttpInfo参数解析:

  • 键值对提交采用addParam/addParams方法
  • Json提交采用addParamJson方法
  • 表单提交采用addParamForm方法
  • 二进制字节流提交采用addParamBytes方法
  • 文件上传采用addDownloadFile方法
  • 文件下载采用addUploadFile方法
…

在Activity中同步调用示例

…

在Activity中异步调用示例

…

仅网络请求

…

仅缓存请求

…

先网络再缓存

…

先缓存再网络

…

缓存10秒失效

…

在Activity中上传图片示例

…

在Activity中单次批量上传文件示例

  • 若服务器为php,接口文件参数名称后面追加"[]"表示数组, 示例:builder.addUploadFile("uploadFile[]",path);
…

在Activity中断点下载文件示例

…

二进制流方式请求

java
HttpInfo info = new HttpInfo.Builder()
        .setUrl("http://192.168.120.154:8082/StanClaimProd-app/surveySubmit/getFileLen")
        .addParamBytes(byte)//添加二进制流
        .build();
OkHttpUtil.getDefault().doPostAsync(info, new Callback() {
    @Override
    public void onSuccess(HttpInfo info) throws IOException {
        String result = info.getRetDetail();
        resultTV.setText("请求失败:"+result);
    }

    @Override
    public void onFailure(HttpInfo info) throws IOException {
        resultTV.setText("请求成功:"+info.getRetDetail());
    }
});

请求结果统一预处理拦截器/请求链路异常信息拦截器示例

请求结果拦截器与链路异常拦截器方便项目进行网络请求业务时对信息返回的统一管理与设置

…

Cookie持久化示例

没有在Application中进行全局Cookie持久化配置时可以采用以下方式:

…

有问题反馈

在使用中有任何问题,欢迎反馈给我,可以用以下联系方式跟我交流

  • QQ: 424427633

感激

感谢以下的项目,排名不分先后

  • OkHttp
  • PersistentCookieJar

相关示例

OkHttpUtil接口

…

MainActivity

…

Issues· 23 开放

查看全部 Issues在 GitHub 打开

暂无开放 Issues,或尚未同步最近议题。

> 标签

Java

暂无评论,来聊聊你的看法吧

> 工具信息

发布日期2026年8月1日
最后更新2026年9月17日
分类编程语言
定价开源

> 相关工具

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言