转载自:http://www.jianshu.com/p/4c17956fe3b4
OkHttpUtils一个专注于让网络请求更简单的网络请求框架,对于任何形式的网络请求只需要一行代码。
项目地址:https://github.com/jeasonlzy/okhttp-OkGo
Apk下载地址:okhttputils_v1.8.1.apk
图片选择仿微信的图片选择库,自带矩形图片裁剪和圆形图片裁剪功能,下载地址:https://github.com/jeasonlzy/ImagePicker
九宫格控件类似QQ空间,微信朋友圈,微博主页等,展示图片的九宫格控件,自动根据图片的数量确定图片大小和控件大小,使用Adapter模式设置图片,对外提供接口回调,使用接口加载图片。支持任意的图片加载框架,如 Glide,ImageLoader,Fresco,xUtils3,Picasso 等,支持点击图片全屏预览大图。
下载地址:https://github.com/jeasonlzy/NineGridView
OkHttpUtils 目前支持
一般的 get,post,put,delete,head,options请求
基于Post的大文本数据上传
多文件和多参数统一的表单上传
支持一个key上传一个文件,也可以一个Key上传多个文件
大文件下载和下载进度回调
大文件上传和上传进度回调
支持cookie的内存存储和持久化存储,支持传递自定义cookie
支持304缓存协议,扩展四种本地缓存模式,并且支持缓存时间控制
支持301、302重定向
支持链式调用
支持可信证书和自签名证书的https的访问,支持双向认证
支持根据Tag取消请求
支持自定义泛型Callback,自动根据泛型返回对象
OkHttpServer 扩展功能
统一的文件下载管理(DownloadManager):
结合OkHttpUtils 的request进行网络请求,支持与OkHttpUtils 保持相同的全局公共参数,同时支持请求传递参数
支持断点下载,支持突然断网,强杀进程后,断点依然有效
支持 下载 暂停 等待 停止 出错 完成 六种下载状态
所有下载任务按照taskKey区分,切记不同的任务必须使用不一样的key,否者断点会发生覆盖
相同的下载url地址如果使用不一样的taskKey,也会认为是两个下载任务
默认同时下载数量为3个,默认下载路径/storage/emulated/0/download,下载路径和下载数量都可以在代码中配置
下载文件名可以自己定义,也可以不传,框架自动解析响应头或者url地址获得文件名,如果都没获取到,使用default作为文件名
下载管理使用了服务提高线程优先级,避免后台下载时被系统回收
统一的文件上传管理(UploadManager):
1. 结合OkHttpUtils 的request进行网络请求,支持与OkHttpUtils 保持相同的全局公共参数,同时支持请求传递参数
2. 上传只能使用Post, Put, Delete, Options 这四种请求,不支持Get, Head
3. 该上传管理为简单管理,不支持断点续传或分片上传,只是简单的将所有上传任务使用线程池进行了统一管理
4. 默认同时上传数量为1个,该数列可以在代码中配置修改
5. 由于断点分片上传的技术需要大量的服务端代码配合,同时也会极大的增加客户端代码量,所以综合考虑,该框架不做实现。如 果确实有特殊需要,可以自己做扩展。
效果图:
项目主页
下载管理列表页
下载管理详情页
OkHttpUtils的优势
优势一:性能高,专注于简单易用的网络请求,使用主流的okhttp进行封装,对于okhttp大家都知道,在Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了,并且支持HTTP2/SPDY黑科技,支持socket自动选择最好路线,并支持自动重连,拥有自动维护的socket连接池,减少握手次数,拥有队列线程池,轻松写并发。
优势二:特有的网络缓存模式,是大多数网络框架所不具备的,说一个应用场景,老板说我们的app不仅需要在有网的情况下展示最新的网络数据,还要在没网的情况下使用缓存数据,这时候是不是项目中出现了大量的代码判断当前网络状况,根据不同的状态保存不同的数据,然后决定是否使用缓存。细想一下,这是个通用的写法,于是OkHttpUtils提供了四种缓存模式,让你不用关心缓存的实现,而专注于数据的处理。(具体缓存的使用方法请看最后第四章节)。
优势三:方便易用的扩展接口,可以添加全局的公共参数,全局拦截器,全局超时时间,更可以对单个请求定制拦截器,超时时间,请求参数修改等等,在使用上更是方便,原生支持的链式调用让你的请求更加清晰。
优势四:强大的Cookie保持策略,我们知道在客户端对cookie的获取是个不太简单的事情,特别是还要处理cookie的过期时间,持久化策略等等,OkHttpUtils帮你彻底解决Cookie的难题,默认拥有内存存储和持久化存储两种实现,cookie全程自动管理,并且提供了额外的addCookie方式,允许介入到自动管理的过程中,添加你想创建的任何cookie。
使用方法
Android Studio的用户可以选择添加:
compile 'com.lzy.net:okhttputils:1.8.1' // 可以单独使用,不需要依赖下方的扩展包 compile 'com.lzy.net:okhttpserver:1.0.3' // 扩展了下载管理和上传管理,根据需要添加 compile 'com.lzy.net:okhttputils:+' // 版本号使用 + 可以自动引用最新版 compile 'com.lzy.net:okhttpserver:+' // 版本号使用 + 可以自动引用最新版
使用注意事项
okhttputils使用的okhttp的版本是最新的 3.4.1 版本,和以前的 2.x 的版本可能会存在冲突
okhttpserver是对okhttputils的扩展,统一了下载管理和上传管理,对项目有需要做统一下载的可以考虑使用该扩展,不需要的可以直接使用okhttputils即可
对于缓存模式使用,需要与返回对象相关的所有javaBean必须实现Serializable接口,否者会报NotSerializableException
使用缓存时,如果不指定cacheKey,默认是用url带参数的全路径名为cacheKey
使用该网络框架时,必须要在 Application 中做初始化 OkHttpUtils.init(this);
全局配置
一般在 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"); // 所有的 params 都 支持 中文
params.put("commonParamsKey2", "这里支持中文参数");
// 必须调用初始化
OkHttpUtils.init(this);
// 以下都不是必须的,根据需要自行选择
OkHttpUtils.getInstance()
.debug("OkHttpUtils") // 是否打开调试
.setConnectTimeout(OkHttpUtils.DEFAULT_MILLISECONDS) // 全局的连接超时时间
.setReadTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) // 全局的读取超时时间
.setWriteTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) // 全局的写入超时时间
//.setCookieStore(new MemoryCookieStore()) // cookie使用内存缓存(app退出后,cookie消失)
//.setCookieStore(new PersistentCookieStore()) // cookie持久化存储,如果cookie不过期,则一直有效
.addCommonHeaders(headers) // 设置全局公共头
.addCommonParams(params); // 设置全局公共参数
}
普通请求
1. 基本的网络请求
OkHttpUtils.get(Urls.URL_METHOD) // 请求方式和请求url .tag(this) // 请求的 tag, 主要用于取消对应的请求 .cacheKey("cacheKey") // 设置当前请求的缓存key,建议每个不同功能的请求设置一个 .cacheMode(CacheMode.DEFAULT) // 缓存模式,详细请看缓存介绍 .execute(new JsonCallback<RequestInfo>(RequestInfo.class) { @Override public void onResponse(boolean isFromCache, RequestInfo requestInfo, Request request, @Nullable Response response) { // requestInfo 对象即为所需要的结果对象 } });
2. 请求Bitmap对象
OkHttpUtils.get(Urls.URL_IMAGE) // 设置请求方式 .tag(this) // 设置标记 .execute(new BitmapCallback() { @Override public void onResponse(boolean isFromCache, Bitmap bitmap, Request request, @Nullable Response response) { // bitmap 即为返回的图片数据 } });
3. 请求文件下载
OkHttpUtils.get(Urls.URL_DOWNLOAD) // 设置请求方式 .tag(this) // 设置标记 .execute(new FileCallback("/sdcard/temp/", "file.jpg") { // 文件下载时,需要指定下载的文件目录和文件名 @Override public void onResponse(boolean isFromCache, File file, Request request, @Nullable Response response) { // file 即为文件数据,文件保存在指定布幕 } });
4. 普通Post,直接上传String类型的文本
一般此种用法用于与服务器约定的数据格式,当使用该方法时,params中的参数设置是无效的,所有参数均需要通过需要上传的文本中指定,此外,额外指定的header参数仍然保持有效。
OkHttpUtils.post(Urls.URL_TEXT_UPLOAD) // 设置请求方式 .tag(this) // 设置标记 .postString("这是要上传的长文本数据!") // 上传长文本 .execute(new StringCallback() { @Override public void onResponse(boolean isFromCache, String s, Request request, @Nullable Response response) { // 上传成功 } });
5. 普通Post,直接上传Json类型的文本
该方法与postString没有本质区别,只是数据格式是json,一般来说,需要自己创建一个实体bean或者一个map,把需要的参数设置进去,然后通过三方的Gson或者fastjson转换成json字符串,最后直接使用该方法提交到服务器。
OkHttpUtils.post(Urls.URL_TEXT_UPLOAD) // 请求方式 .tag(this) // 设置标记 .postJson("{\"des\": \"这里面要写标准的json格式数据\"}") // 上传json .execute(new StringCallback() { @Override public void onResponse(boolean isFromCache, String s, Request request, @Nullable Response response) { // 上传成功 } });
6. 请求功能的所有配置讲解
以下代码包含了以下内容:
1. 一次普通请求所有能配置的参数,真实使用时不需要配置这么多,按自己的需要选择性的使用即可
2. 多文件和多参数的表单上传,同时支持进度监听
3. 自签名网站https的访问,调用setCertificates方法即可
4. 为单个请求设置超时,比如涉及到文件的需要设置读写等待时间多一点。
5. Cookie一般情况下只需要在初始化的时候调用setCookieStore即可实现cookie的自动管理,如果特殊业务需要,需要手动额外向服务器传递自定义的cookie,可以在每次请求的时候调用addCookie方法,该方法提供了3个重载形式,可以根据自己的需要选择使用。
OkHttpUtils.get(Urls.URL_METHOD) // 请求方式和请求url, get请求不需要拼接参数,支持get,post,put,delete,head,options请求 .tag(this) // 请求的 tag, 主要用于取消对应的请求 .connTimeOut(10000) // 设置当前请求的连接超时时间 .readTimeOut(10000) // 设置当前请求的读取超时时间 .writeTimeOut(10000) // 设置当前请求的写入超时时间 .cacheKey("cacheKey") // 设置当前请求的缓存key,建议每个不同功能的请求设置一个 .cacheMode(CacheMode.FIRST_CACHE_THEN_REQUEST) // 缓存模式,详细请看第四部分,缓存介绍 .setCertificates(getAssets().open("srca.cer")) // 自签名https的证书,可变参数,可以设置多个 .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<String> values) // 这里支持一个key传多个参数 .addFileParams("key", List<File> files) // 这里支持一个key传多个文件 .addFileWrapperParams("key", List<HttpParams.FileWrapper> fileWrappers) //这里支持一个key传多个文件 .addCookie("aaa", "bbb") // 这里可以传递自己想传的Cookie .addCookie(cookie) // 可以自己构建cookie .addCookies(cookies) // 可以一次传递批量的cookie // 这里给出的泛型为 RequestInfo,同时传递一个泛型的 class对象,即可自动将数据结果转成对象返回 .execute(new DialogCallback<RequestInfo>(this, RequestInfo.class) { @Override public void onBefore(BaseRequest request) { // UI线程 请求网络之前调用 // 可以显示对话框,添加/修改/移除 请求参数 } @Override public RequestInfo parseNetworkResponse(Response response) throws Exception{ // 子线程,可以做耗时操作 // 根据传递进来的 response 对象,把数据解析成需要的 RequestInfo 类型并返回 // 可以根据自己的需要,抛出异常,在onError中处理 return null; } @Override public void onResponse(boolean isFromCache, RequestInfo requestInfo, Request request, @Nullable Response response) { // UI 线程,请求成功后回调 // isFromCache 表示当前回调是否来自于缓存 // requestInfo 返回泛型约定的实体类型参数 // request 本次网络的请求信息,如果需要查看请求头或请求参数可以从此对象获取 // response 本次网络访问的结果对象,包含了响应头,响应码等,如果数据来自于缓存,该对象为null } @Override public void onError(boolean isFromCache, Call call, @Nullable Response response, @Nullable Exception e) { // UI 线程,请求失败后回调 // isFromCache 表示当前回调是否来自于缓存 // call 本次网络的请求对象,可以根据该对象拿到 request // response 本次网络访问的结果对象,包含了响应头,响应码等,如果网络异常 或者数据来自于缓存,该对象为null // e 本次网络访问的异常信息,如果服务器内部发生了错误,响应码为 400~599之间,该异常为 null } @Override public void onAfter(boolean isFromCache, @Nullable RequestInfo requestInfo, Call call, @Nullable Response response, @Nullable Exception e) { // UI 线程,请求结束后回调,无论网络请求成功还是失败,都会调用,可以用于关闭显示对话框 // isFromCache 表示当前回调是否来自于缓存 // requestInfo 返回泛型约定的实体类型参数,如果网络请求失败,该对象为 null // call 本次网络的请求对象,可以根据该对象拿到 request // response 本次网络访问的结果对象,包含了响应头,响应码等,如果网络异常 或者数据来自于缓存,该对象为null // e 本次网络访问的异常信息,如果服务器内部发生了错误,响应码为 400~599之间,该异常为 null } @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 线程,文件下载过程中回调 // 参数含义同 上传相同 } });
7. 取消请求
每个请求前都设置了一个参数tag,取消则通过OkHttpUtils.cancel(tag)执行。
例如:在Activity中,当Activity销毁取消请求,可以在onDestory里面统一取消@Override protected void onDestroy() { super.onDestroy(); // 根据 Tag 取消请求 OkHttpUtils.getInstance().cancelTag(this); }
8. 同步的请求
execute方法不传入callback即为同步的请求,返回Response对象,需要自己解析
Response response = OkHttpUtils.get("http://www.baidu.com") // 请求方式 .tag(this) // 设置标记 .headers("aaa", "111") // 请求头 .params("bbb", "222") // 请求参数 .execute();
自定义CallBack使用
目前内部提供的包含AbsCallback, StringCallBack ,BitmapCallback ,FileCallBack ,可以根据自己的需求去自定义Callback
AbsCallback: 所有回调的父类,抽象类
StringCallBack:如果返回值类型是纯文本数据,即可使用该回调
BitmapCallback:如果请求的是图片数据,则可以使用该回调
FileCallBack:如果要做文件下载,则必须使用该回调,内部封装了关于文件下载进度回调的方法
该网络框架的核心使用方法即为Callback的继承使用,详细请看 Demo 源码中callback包下的代码。
因为不同的项目需求,可能对数据格式进行了不同的封装,于是在 Demo 中的进行了详细的代码示例,
以下是详细介绍:
CommonCallback:继承自AbsCallback,主要作用是做全局共同请求参数的添加,同样也可以在第一步全局配置的时候设置,效果一样。
EncryptCallback:继承自CommonCallback,主要功能是做 Url 参数加密,对每个请求的参数进行编码,防止拦截数据包,篡改数据。
JsonCallback:继承自EncryptCallback,一般来说,服务器返回的响应码都包含 code,msg,data 三部分,在此根据自己的业务需要完成相应的逻辑判断,并对数据进行解析,可以使用 Gson 或者 fastjson,将解析的对象返回。
DialogCallback:继承自JsonCallback,对需要在网络请求的时候显示对话框,使用该回调。
StringDialogCallback:继承自EncryptCallback,如果网络返回的数据只是纯文本,使用该回调
BitmapDialogCallback :继承自BitmapCallback,如果网络返回的是Bitmap对象,使用该回调
DownloadFileCallBack :继承自FileCallback,如果需要做文件下载,使用该回调
以上基本是包含了大部分的业务逻辑,具体情况请参照demo示例,根据业务需求修改
缓存的使用
使用缓存前,必须让缓存的数据javaBean对象实现Serializable接口,否者会报NotSerializableException。
因为缓存的原理是将对象序列化后直接写入 数据库中,如果不实现Serializable接口,会导致对象无法序列化,进而无法写入到数据库中,也就达不到缓存的效果。
目前提供了四种CacheMode缓存模式
DEFAULT : 按照HTTP协议的默认缓存规则,例如有304响应头时缓存
REQUEST_FAILED_READ_CACHE:先请求网络,如果请求网络失败,则读取缓存,如果读取缓存失败,本次请求失败。该缓存模式的使用,会根据实际情况,导致onResponse,onError,onAfter三个方法调用不只一次,具体请在三个方法返回的参数中进行判断。
IF_NONE_CACHE_REQUEST:如果缓存不存在才请求网络,否则使用缓存。
FIRST_CACHE_THEN_REQUEST:先使用缓存,不管是否存在,仍然请求网络,如果网络顺利,会导致onResponse方法执行两次,第一次isFromCache为true,第二次 isFromCache为false。使用时根据实际情况,对 onResponse , onError , onAfter 三个方法进行具体判断。
无论对于哪种缓存模式,都可以指定一个cacheKey,建议针对不同需要缓存的页面设置不同的cacheKey,如果相同,会导致数据覆盖。