github地址:https://github.com/jeasonlzy/okhttp-OkGo
官方文档:https://github.com/jeasonlzy/okhttp-OkGo/wiki
1.导包
compile 'com.lzy.net:okgo:2.1.4' //可以单独使用,不需要依赖下方的扩展包
compile 'com.lzy.net:okrx:0.1.2' //RxJava扩展支持,根据需要添加
compile 'com.lzy.net:okserver:1.1.3' //下载管理和上传管理扩展,根据需要添加
或者
compile 'com.lzy.net:okgo:+' //版本号使用 + 可以自动引用最新版
compile 'com.lzy.net:okrx:+' //版本号使用 + 可以自动引用最新版
compile 'com.lzy.net:okserver:+' //版本号使用 + 可以自动引用最新版
2.使用注意事项
okgo使用的okhttp的版本是最新的 3.4.1 版本,和以前的 2.x 的版本可能会存在冲突。
okrx是基于RxJava和RxAndroid的扩展,如果不需要可以不必引入
okserver是对okgo的扩展,统一了下载管理和上传管理,对项目有需要做统一下载的可以考虑使用该扩展,不需要的可以直接使用okgo即可。
对于缓存模式使用,需要与返回对象相关的所有javaBean必须实现Serializable接口,否者会报NotSerializableException。
使用缓存时,如果不指定cacheKey,默认是用url带参数的全路径名为cacheKey。
使用该网络框架时,必须要在 Application 中做初始化OkGo.init(this);。
3.OkGo目前支持
一般的 get,post,put,delete,head,options请求
基于Post的大文本数据上传
多文件和多参数统一的表单上传
支持一个key上传一个文件,也可以一个Key上传多个文件
大文件下载和下载进度回调
大文件上传和上传进度回调
支持cookie的内存存储和持久化存储,支持传递自定义cookie
支持304缓存协议,扩展四种本地缓存模式,并且支持缓存时间控制
支持301、302重定向
支持自定义超时自动重连次数
支持链式调用
支持可信证书和自签名证书的https的访问,支持双向认证
支持根据Tag取消请求
支持自定义泛型Callback,自动根据泛型返回对象
4.OkRx扩展功能
完美结合RxJava
比Retrofit更简单方便
网络请求和RxJava调用,一条链点到底
支持Json数据的自动解析转换
OkGo包含的所有请求功能,OkRx全部支持
5.OkServer扩展功能
该功能并没有在文档中写出,详细使用方法请自行看demo中的代码,有详细的注释,不在文档中赘述。
5.1 统一的文件下载管理(DownloadManager):
结合OkGo的request进行网络请求,支持与OkGo保持相同的全局公共参数,同时支持请求传递参数
支持断点下载,支持突然断网,强杀进程后,断点依然有效
支持 下载 暂停 等待 停止 出错 完成 六种下载状态
所有下载任务按照taskKey区分,切记不同的任务必须使用不一样的key,否者断点会发生覆盖
相同的下载url地址如果使用不一样的taskKey,也会认为是两个下载任务
默认同时下载数量为3个,默认下载路径/storage/emulated/0/download,下载路径和下载数量都可以在代码中配置
下载文件名可以自己定义,也可以不传,框架自动解析响应头或者url地址获得文件名,如果都没获取到,使用default作为文件名
下载管理使用了服务提高线程优先级,避免后台下载时被系统回收
5.2 统一的文件上传管理(UploadManager)
结合OkGo的request进行网络请求,支持与OkGo保持相同的全局公共参数,同时支持请求传递参数
上传只能使用Post,Put,Delete,Options这四种请求,不支持Get,Head
该上传管理为简单管理,不支持断点续传或分片上传,只是简单的将所有上传任务使用线程池进行了统一管理
默认同时上传数量为1个,该数列可以在代码中配置修改
一、全局配置
一般在 Aplication,或者基类中,只需要调用一次即可,可以配置调试开关,全局的超时时间,公共的请求头和请求参数等信息
不要忘记了在清单文件中注册 Aplication
@Override
public void onCreate() {
super.onCreate();
//---------这里给出的是示例代码,告诉你可以这么传,实际使用的时候,根据需要传,不需要就不传-------------//
HttpHeaders headers = new HttpHeaders();
headers.put("commonHeaderKey1", "commonHeaderValue1"); //header不支持中文
headers.put("commonHeaderKey2", "commonHeaderValue2");
HttpParams params = new HttpParams();
params.put("commonParamsKey1", "commonParamsValue1"); //param支持中文,直接传,不要自己编码
params.put("commonParamsKey2", "这里支持中文参数");
//-----------------------------------------------------------------------------------//
//必须调用初始化
OkGo.init(this);
//以下设置的所有参数是全局参数,同样的参数可以在请求的时候再设置一遍,那么对于该请求来讲,请求中的参数会覆盖全局参数
//好处是全局参数统一,特定请求可以特别定制参数
try {
//以下都不是必须的,根据需要自行选择,一般来说只需要 debug,缓存相关,cookie相关的 就可以了
OkGo.getInstance()
// 打开该调试开关,打印级别INFO,并不是异常,是为了显眼,不需要就不要加入该行
// 最后的true表示是否打印okgo的内部异常,一般打开方便调试错误
.debug("OkGo", Level.INFO, true)
//如果使用默认的 60秒,以下三行也不需要传
.setConnectTimeout(OkGo.DEFAULT_MILLISECONDS) //全局的连接超时时间
.setReadTimeOut(OkGo.DEFAULT_MILLISECONDS) //全局的读取超时时间
.setWriteTimeOut(OkGo.DEFAULT_MILLISECONDS) //全局的写入超时时间
//可以全局统一设置缓存模式,默认是不使用缓存,可以不传,具体其他模式看 github 介绍 https://github.com/jeasonlzy/
.setCacheMode(CacheMode.NO_CACHE)
//可以全局统一设置缓存时间,默认永不过期,具体使用方法看 github 介绍
.setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE)
//可以全局统一设置超时重连次数,默认为三次,那么最差的情况会请求4次(一次原始请求,三次重连请求),不需要可以设置为0
.setRetryCount(3)
//如果不想让框架管理cookie(或者叫session的保持),以下不需要
// .setCookieStore(new MemoryCookieStore()) //cookie使用内存缓存(app退出后,cookie消失)
.setCookieStore(new PersistentCookieStore()) //cookie持久化存储,如果cookie不过期,则一直有效
//可以设置https的证书,以下几种方案根据需要自己设置
.setCertificates() //方法一:信任所有证书,不安全有风险
// .setCertificates(new SafeTrustManager()) //方法二:自定义信任规则,校验服务端证书
// .setCertificates(getAssets().open("srca.cer")) //方法三:使用预埋证书,校验服务端证书(自签名证书)
// //方法四:使用bks证书和密码管理客户端证书(双向认证),使用预埋证书,校验服务端证书(自签名证书)
// .setCertificates(getAssets().open("xxx.bks"), "123456", getAssets().open("yyy.cer"))//
//配置https的域名匹配规则,详细看demo的初始化介绍,不需要就不要加入,使用不当会导致https握手失败
// .setHostnameVerifier(new SafeHostnameVerifier())
//可以添加全局拦截器,不需要就不要加入,错误写法直接导致任何回调不执行
// .addInterceptor(new Interceptor() {
// @Override
// public Response intercept(Chain chain) throws IOException {
// return chain.proceed(chain.request());
// }
// })
//这两行同上,不需要就不要加入
.addCommonHeaders(headers) //设置全局公共头
.addCommonParams(params); //设置全局公共参数
} catch (Exception e) {
e.printStackTrace();
}
}
二、普通请求
0.写在开始的话,callback回调默认只需要复写onSuccess,并不代表所有的回调都只走这一个,实际开发中,错误回调并没有成功回调使用频繁,所以callback的失败回调onError并没有声明为抽象的,如果有需要,请自行复写,不要再问我为什么回调没有执行啊,既然onSuccess没有执行,那么一定是出错了回调了onError
callback一共有以下 10 个回调,除onSuccess必须实现以外,其余均可以按需实现,每个方法参数详细说明,请看下面第6点:
convertSuccess():解析网络返回的数据回调
parseError():解析网络失败的数据回调
onBefore():网络请求真正执行前回调
onSuccess():网络请求成功的回调
onCacheSuccess():缓存读取成功的回调
onError():网络请求失败的回调
onCacheError():网络缓存读取失败的回调
onAfter():网络请求结束的回调,无论成功失败一定会执行
upProgress():上传进度的回调
downloadProgress():下载进度的回调
Callback回调具有如下顺序,虽然顺序写的很复杂,但是理解后,是很简单,并且合情合理的
1).无缓存模式 CacheMode.NO_CACHE
网络请求成功 onBefore -> convertSuccess -> onSuccess -> onAfter
网络请求失败 onBefore -> parseError -> onError -> onAfter
2).默认缓存模式,遵循304头 CacheMode.DEFAULT
网络请求成功,服务端返回非304 onBefore -> convertSuccess -> onSuccess -> onAfter
网络请求成功服务端返回304 onBefore -> onCacheSuccess -> onAfter
网络请求失败 onBefore -> parseError -> onError -> onAfter
3).请求网络失败后读取缓存 CacheMode.REQUEST_FAILED_READ_CACHE
网络请求成功,不读取缓存 onBefore -> convertSuccess -> onSuccess -> onAfter
网络请求失败,读取缓存成功 onBefore -> parseError -> onError -> onCacheSuccess -> onAfter
网络请求失败,读取缓存失败 onBefore -> parseError -> onError -> onCacheError -> onAfter
4).如果缓存不存在才请求网络,否则使用缓存 CacheMode.IF_NONE_CACHE_REQUEST
已经有缓存,不请求网络 onBefore -> onCacheSuccess -> onAfter
没有缓存请求网络成功 onBefore -> onCacheError -> convertSuccess -> onSuccess -> onAfter
没有缓存请求网络失败 onBefore -> onCacheError -> parseError -> onError -> onAfter
5).先使用缓存,不管是否存在,仍然请求网络 CacheMode.FIRST_CACHE_THEN_REQUEST
无缓存时,网络请求成功 onBefore -> onCacheError -> convertSuccess -> onSuccess -> onAfter
无缓存时,网络请求失败 onBefore -> onCacheError -> parseError -> onError -> onAfter
有缓存时,网络请求成功 onBefore -> onCacheSuccess -> convertSuccess -> onSuccess -> onAfter
有缓存时,网络请求失败 onBefore -> onCacheSuccess -> parseError -> onError -> onAfter
1.基本的网络请求
OkGo.get(Urls.URL_METHOD) // 请求方式和请求url
.tag(this) // 请求的 tag, 主要用于取消对应的请求
.cacheKey("cacheKey") // 设置当前请求的缓存key,建议每个不同功能的请求设置一个
.cacheMode(CacheMode.DEFAULT) // 缓存模式,详细请看缓存介绍
.execute(new StringCallback() {
@Override
public void onSuccess(String s, Call call, Response response) {
// s 即为所需要的结果
}
});
2.请求 Bitmap 对象
OkGo.get(Urls.URL_IMAGE)//
.tag(this)//
.execute(new BitmapCallback() {
@Override
public void onSuccess(Bitmap bitmap, Call call, Response response) {
// bitmap 即为返回的图片数据
}
});
3.请求 文件下载
FileCallback具有三个重载的构造方法,分别是
FileCallback():空参构造
FileCallback(String destFileName):可以额外指定文件下载完成后的文件名
FileCallback(String destFileDir, String destFileName):可以额外指定文件的下载目录和下载完成后的文件名
文件目录如果不指定,默认下载的目录为sdcard/download/,文件名如果不指定,则按照以下规则命名:
1.首先检查用户是否传入了文件名,如果传入,将以用户传入的文件名命名
2.如果没有传入,那么将会检查服务端返回的响应头是否含有Content-Disposition=attachment;filename=FileName.txt该种形式的响应头,如果有,则按照该响应头中指定的文件名命名文件,如FileName.txt
3.如果上述响应头不存在,则检查下载的文件url,例如:http://image.baidu.com/abc.jpg,那么将会自动以abc.jpg命名文件
4.如果url也把文件名解析不出来,那么最终将以nofilename命名文件
OkGo.get(Urls.URL_DOWNLOAD)//
.tag(this)//
.execute(new FileCallback() { //文件下载时,可以指定下载的文件目录和文件名
@Override
public void onSuccess(File file, Call call, Response response) {
// file 即为文件数据,文件保存在指定目录
}
@Override
public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
//这里回调下载进度(该回调在主线程,可以直接更新ui)
}
});
4.普通Post,直接上传String类型的文本
一般此种用法用于与服务器约定的数据格式,当使用该方法时,params中的参数设置是无效的,所有参数均需要通过需要上传的文本中指定,此外,额外指定的header参数仍然保持有效。
默认会携带以下请求头
Content-Type: text/plain;charset=utf-8
如果你对请求头有自己的要求,可以使用这个重载的形式,传入自定义的content-type
upString(“这是要上传的长文本数据!”, MediaType.parse(“application/xml”)) // 比如上传xml数据,这里就可以自己指定请求头
OkGo.post(Urls.URL_TEXT_UPLOAD)//
.tag(this)//
// .params("param1", "paramValue1")// 这里不要使用params,upString 与 params 是互斥的,只有 upString 的数据会被上传
.upString("这是要上传的长文本数据!")//
// .upString("这是要上传的长文本数据!", MediaType.parse("application/xml")) // 比如上传xml数据,这里就可以自己指定请求头
.execute(new StringCallback() {
@Override
public void onSuccess(String s, Call call, Response response) {
//上传成功
}
@Override
public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
//这里回调上传进度(该回调在主线程,可以直接更新ui)
}
});
5.普通Post,直接上传Json类型的文本
该方法与postString没有本质区别,只是数据格式是json,一般来说,需要自己创建一个实体bean或者一个map,把需要的参数设置进去,然后通过三方的Gson或者fastjson转换成json字符串,最后直接使用该方法提交到服务器。
默认会携带以下请求头,请不要手动修改,okgo也不支持自己修改
Content-Type: application/json;charset=utf-8
HashMap params = new HashMap<>();
params.put("key1", "value1");
params.put("key2", "这里是需要提交的json格式数据");
params.put("key3", "也可以使用三方工具将对象转成json字符串");
params.put("key4", "其实你怎么高兴怎么写都行");
JSONObject jsonObject = new JSONObject(params);
OkGo.post(Urls.URL_TEXT_UPLOAD)//
.tag(this)//
// .params("param1", "paramValue1")// 这里不要使用params,upJson 与 params 是互斥的,只有 upJson 的数据会被上传
.upJson(jsonObject.toString())//
.execute(new StringCallback() {
@Override
public void onSuccess(String s, Call call, Response response) {
//上传成功
}
@Override
public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
//这里回调上传进度(该回调在主线程,可以直接更新ui)
}
});
6.上传图片或者文件
上传文件支持文件与参数一起同时上传,也支持一个key上传多个文件,以下方式可以任选
特别要注意的是
1).很多人会说需要在上传文件到时候,要把Content-Type修改掉,变成multipart/form-data,就像下面这样的。其实在使用OkGo的时候,只要你添加了文件,这里的的Content-Type不需要你手动设置,OkGo自动添加该请求头,同时,OkGo也不允许你修改该请求头。
Content-Type: multipart/form-data; boundary=f6b76bad-0345-4337-b7d8-b362cb1f9949
2).如果没有文件,那么OkGo将自动使用以下请求头,同样OkGo也不允许你修改该请求头。
Content-Type: application/x-www-form-urlencoded
3).如果你的服务器希望你在没有文件的时候依然使用multipart/form-data请求,那么可以使用.isMultipart(true)这个方法强制修改,一般来说是不需要强制的。
OkGo.post(URL_FORM_UPLOAD)//
.tag(this)//
.isMultipart(true) // 强制使用 multipart/form-data 表单上传(只是演示,不需要的话不要设置。默认就是false)
.params("param1", "paramValue1") // 这里可以上传参数
.params("file1", new File("filepath1")) // 可以添加文件上传
.params("file2", new File("filepath2")) // 支持多文件同时添加上传
.addFileParams("key", List files) // 这里支持一个key传多个文件
.execute(new StringCallback() {
@Override
public void onSuccess(String s, Call call, Response response) {
//上传成功
}
@Override
public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
//这里回调上传进度(该回调在主线程,可以直接更新ui)
}
});
7.https请求,需要在初始化的时候配置以下代码
OkGo.getInstance()
...
//可以设置https的证书,以下几种方案根据需要自己设置
.setCertificates() //方法一:信任所有证书,不安全有风险
// .setCertificates(new SafeTrustManager()) //方法二:自定义信任规则,校验服务端证书
// .setCertificates(getAssets().open("srca.cer")) //方法三:使用预埋证书,校验服务端证书(自签名证书)
//方法四:使用bks证书和密码管理客户端证书(双向认证),使用预埋证书,校验服务端证书(自签名证书)
// .setCertificates(getAssets().open("xxx.bks"), "123456", getAssets().open("yyy.cer"))//
//配置https的域名匹配规则,详细看demo的初始化介绍,不需要就不要加入,使用不当会导致https握手失败
// .setHostnameVerifier(new SafeHostnameVerifier())
...
8.请求功能的所有配置讲解
以下代码包含了以下内容:
一次普通请求所有能配置的参数,真实使用时不需要配置这么多,按自己的需要选择性的使用即可
params添加参数的时候,最后一个isReplace为可选参数,默认为true,即代表相同key的时候,后添加的会覆盖先前添加的
多文件和多参数的表单上传,同时支持进度监听
为单个请求设置超时,比如涉及到文件的需要设置读写等待时间多一点。
OkGo.post(Urls.URL_METHOD) // 请求方式和请求url, get请求不需要拼接参数,支持get,post,put,delete,head,options请求
.tag(this) // 请求的 tag, 主要用于取消对应的请求
.isMultipart(true) // 强制使用 multipart/form-data 表单上传(只是演示,不需要的话不要设置。默认就是false)
.connTimeOut(10000) // 设置当前请求的连接超时时间
.readTimeOut(10000) // 设置当前请求的读取超时时间
.writeTimeOut(10000) // 设置当前请求的写入超时时间
.cacheKey("cacheKey") // 设置当前请求的缓存key,建议每个不同功能的请求设置一个
.cacheTime(5000) // 缓存的过期时间,单位毫秒
.cacheMode(CacheMode.FIRST_CACHE_THEN_REQUEST) // 缓存模式,详细请看第四部分,缓存介绍
.addInterceptor(interceptor) // 添加自定义拦截器
.headers("header1", "headerValue1") // 添加请求头参数
.headers("header2", "headerValue2") // 支持多请求头参数同时添加
.params("param1", "paramValue1") // 添加请求参数
.params("param2", "paramValue2") // 支持多请求参数同时添加
.params("file1", new File("filepath1")) // 可以添加文件上传
.params("file2", new File("filepath2")) // 支持多文件同时添加上传
.addUrlParams("key", List values) // 这里支持一个key传多个参数
.addFileParams("key", List files) // 这里支持一个key传多个文件
.addFileWrapperParams("key", List fileWrappers)//这里支持一个key传多个文件
//这里给出的泛型为 ServerModel,同时传递一个泛型的 class对象,即可自动将数据结果转成对象返回
.execute(new DialogCallback(this) {
@Override
public void onBefore(BaseRequest request) {
// UI线程 请求网络之前调用
// 可以显示对话框,添加/修改/移除 请求参数
}
@Override
public ServerModel convertSuccess(Response response) throws Exception{
// 子线程,可以做耗时操作
// 根据传递进来的 response 对象,把数据解析成需要的 ServerModel 类型并返回
// 可以根据自己的需要,抛出异常,在onError中处理
return null;
}
@Override
public void parseError(Call call, IOException e) {
// 子线程,可以做耗时操作
// 用于网络错误时在子线程中执行数据耗时操作,子类可以根据自己的需要重写此方法
}
@Override
public void onSuccess(ServerModel serverModel, Call call, Response response) {
// UI 线程,请求成功后回调
// ServerModel 返回泛型约定的实体类型参数
// call 本次网络的请求信息,如果需要查看请求头或请求参数可以从此对象获取
// response 本次网络访问的结果对象,包含了响应头,响应码等
}
@Override
public void onCacheSuccess(ServerModel serverModel, Call call) {
// UI 线程,缓存读取成功后回调
// serverModel 返回泛型约定的实体类型参数
// call 本次网络的请求信息
}
@Override
public void onError(Call call, Response response, Exception e) {
// UI 线程,请求失败后回调
// call 本次网络的请求对象,可以根据该对象拿到 request
// response 本次网络访问的结果对象,包含了响应头,响应码等
// e 本次网络访问的异常信息,如果服务器内部发生了错误,响应码为 404,或大于等于500
}
@Override
public void onCacheError(Call call, Exception e) {
// UI 线程,读取缓存失败后回调
// call 本次网络的请求对象,可以根据该对象拿到 request
// e 本次网络访问的异常信息,如果服务器内部发生了错误,响应码为 404,或大于等于500
}
@Override
public void onAfter(ServerModel serverModel, Exception e) {
// UI 线程,请求结束后回调,无论网络请求成功还是失败,都会调用,可以用于关闭显示对话框
// ServerModel 返回泛型约定的实体类型参数,如果网络请求失败,该对象为?null
// e 本次网络访问的异常信息,如果服务器内部发生了错误,响应码为 404,或大于等于500
}
@Override
public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
// UI 线程,文件上传过程中回调,只有请求方式包含请求体才回调(GET,HEAD不会回调)
// currentSize 当前上传的大小(单位字节)
// totalSize ? 需要上传的总大小(单位字节)
// progress 当前上传的进度,范围?0.0f ~ 1.0f
// networkSpeed 当前上传的网速(单位秒)
}
@Override
public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
// UI 线程,文件下载过程中回调
//参数含义同?上传相同
}
});
9.取消请求
每个请求前都设置了一个参数tag,取消则通过OkGo.cancel(tag)执行。 例如:在Activity中,当Activity销毁取消请求,可以在onDestory里面统一取消。
@Override
protected void onDestroy() {
super.onDestroy();
//根据 Tag 取消请求
OkGo.getInstance().cancelTag(this);
//取消所有请求
OkGo.getInstance().cancelAll();
}
10.同步的请求
execute方法不传入callback即为同步的请求,返回Response对象,需要自己解析
Response response = OkGo.get("http://www.baidu.com")//
.tag(this)//
.headers("aaa", "111")//
.params("bbb", "222")
.execute();
11.参数的顺序
添加header和param的方法各有三个地方,在提交的时候,他们是有顺序的,如果对提交顺序有需要的话,请注意这里
第一个地方,全局初始化时,使用OkGo.getInstance().addCommonHeaders(),OkGo.getInstance().addCommonParams()添加
HttpHeaders headers = new HttpHeaders();
headers.put("HKAAA", "HVAAA");
headers.put("HKBBB", "HVBBB");
HttpParams params = new HttpParams();
params.put("PKAAA", "PVAAA");
params.put("PKBBB", "PVBBB");
OkGo.getInstance()
.addCommonHeaders(headers) //设置全局公共头
.addCommonParams(params); //设置全局公共参数
第二个地方,callback的onBefore方法中添加
public abstract class CommonCallback extends AbsCallback {
@Override
public void onBefore(BaseRequest request) {
super.onBefore(request);
request.headers("HKCCC", "HVCCC")//
.headers("HKDDD", "HVDDD")//
.params("PKCCC", "PVCCC")//
.params("PKDDD", "PVDDD")//
}
}
第三个地方,执行网络请求的时候添加
OkGo.get(Urls.URL_METHOD)//
.tag(this)//
.headers("HKEEE", "HVEEE")//
.headers("HKFFF", "HVFFF")//
.params("PKEEE", "PVEEE")//
.params("PKFFF", "PVFFF")//
.execute(new MethodCallBack<>(this, ServerModel.class));
那么,最终执行请求的参数的添加顺序为
Header顺序: HKAAA -> HKBBB -> HKEEE -> HKFFF -> HKCCC -> HKDDD
Params顺序: PKAAA -> PKBBB -> PKEEE -> PKFFF -> PKCCC -> PKDDD
总结一句话就是,全局添加的在最开始,callback添加的在最后,请求添加的在中间
原文链接 http://www.cocoachina.com/articles/56660