该项目参考了如下项目:java
在此特别感谢上述做者,喜欢原做的能够去使用原项目。同时欢迎你们下载体验本项目,若是使用过程当中遇到什么问题,欢迎反馈。android
- 为了方便你们使用,更加通俗的理解http的网络协议,建议作网络请求的时候,对每一个请求抓包后查看请求信息和响应信息。
- 若是是 Windows 操做系统,可使用
Fiddler
对手机的请求进行抓包查看。- 若是是 Mac OS 操做系统,可使用
Charles
对手机的请求进行抓包查看。- 具体的下载地址和抓包配置方法,我这就不提供了,请自行百度或谷歌。
对于Eclipse不能运行项目的,提供了apk供直接运行git
本项目Demo的网络请求是我本身的服务器,有时候可能不稳定,网速比较慢时请耐心等待。。github
compile 'com.lzy.net:okhttputils:1.8.0' //能够单独使用,不须要依赖下方的扩展包 compile 'com.lzy.net:okhttpserver:1.0.2' //扩展了下载管理和上传管理,根据须要添加 或者 compile 'com.lzy.net:okhttputils:+' //版本号使用 + 能够自动引用最新版 compile 'com.lzy.net:okhttpserver:+' //版本号使用 + 能够自动引用最新版
/jar
目录下的: okhttputils-1.8.0.jar okhttpserver-1.0.2.jar
okhttpserver
,须要在清单文件中额外注册一个服务 <service android:name="com.lzy.okhttpserver.download.DownloadService"/>
okhttputils
的jar,没有使用okhttpserver
的jar,那么不须要注册上面的服务okhttputils
使用的okhttp
的版本是最新的 3.4.1 版本,和之前的 2.x 的版本可能会存在冲突。okhttpserver
是对okhttputils
的扩展,统一了下载管理和上传管理,对项目有须要作统一下载的能够考虑使用该扩展,不须要的能够直接使用okhttputils
便可。javaBean
必须实现Serializable
接口,否者会报NotSerializableException
。cacheKey
,默认是用url带参数的全路径名为cacheKey
。OkHttpUtils.init(this);
。/storage/emulated/0/download
,下载路径和下载数量均可以在代码中配置Post
, Put
, Delete
, Options
这四种请求,不支持Get
, Head
通常在 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", "这里支持中文参数"); //-----------------------------------------------------------------------------------// //必须调用初始化 OkHttpUtils.init(this); //如下设置的全部参数是全局参数,一样的参数能够在请求的时候再设置一遍,那么对于该请求来说,请求中的参数会覆盖全局参数 //好处是全局参数统一,特定请求能够特别定制参数 try { //如下都不是必须的,根据须要自行选择,通常来讲只须要 debug,缓存相关,cookie相关的 就能够了 OkHttpUtils.getInstance() //打开该调试开关,控制台会使用 红色error 级别打印log,并非错误,是为了显眼,不须要就不要加入该行 .debug("OkHttpUtils") //若是使用默认的 60秒,如下三行也不须要传 .setConnectTimeout(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的链接超时时间 .setReadTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的读取超时时间 .setWriteTimeOut(OkHttpUtils.DEFAULT_MILLISECONDS) //全局的写入超时时间 //能够全局统一设置缓存模式,默认就是Default,能够不传,具体其余模式看 github 介绍 https://github.com/jeasonlzy0216/ .setCacheMode(CacheMode.DEFAULT) //能够全局统一设置缓存时间,默认永不过时,具体使用方法看 github 介绍 .setCacheTime(CacheEntity.CACHE_NEVER_EXPIRE) //若是不想让框架管理cookie,如下不须要 // .setCookieStore(new MemoryCookieStore()) //cookie使用内存缓存(app退出后,cookie消失) .setCookieStore(new PersistentCookieStore()) //cookie持久化存储,若是cookie不过时,则一直有效 //能够设置https的证书,如下几种方案根据须要本身设置,不须要不用设置 // .setCertificates() //方法一:信任全部证书 // .setCertificates(getAssets().open("srca.cer")) //方法二:也能够本身设置https证书 // .setCertificates(getAssets().open("aaaa.bks"), "123456", getAssets().open("srca.cer"))//方法三:传入bks证书,密码,和cer证书,支持双向加密 //能够添加全局拦截器,不会用的千万不要传,错误写法直接致使任何回调不执行 // .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(); } }
callback
回调默认只须要复写onSuccess
,并不表明全部的回调都只走这一个,实际开发中,错误回调并无成功回调使用频繁,因此callback
的失败回调onError
并无声明为抽象的,若是有须要,请自行复写,不要再问我为何回调没有执行啊,既然onSuccess
没有执行,那么必定是出错了回调了onError
callback一共有如下 10 个回调,除onSuccess
必须实现之外,其他都可以按需实现,每一个方法参数详细说明,请看下面第6点:json
网络请求成功 onBefore -> parseNetworkResponse -> onSuccess -> onAfter
网络请求失败 onBefore -> parseNetworkFail -> onError -> onAfter缓存
网络请求成功,服务端返回非304 onBefore -> parseNetworkResponse -> onSuccess -> onAfter
网络请求成功服务端返回304 onBefore -> onCacheSuccess -> onAfter
网络请求失败 onBefore -> parseNetworkFail -> onError -> onAfter服务器
网络请求成功,不读取缓存 onBefore -> parseNetworkResponse -> onSuccess -> onAfter
网络请求失败,读取缓存成功 onBefore -> parseNetworkFail -> onError -> onCacheSuccess -> onAfter
网络请求失败,读取缓存失败 onBefore -> parseNetworkFail -> onError -> onCacheError -> onAfter微信
已经有缓存,不请求网络 onBefore -> onCacheSuccess -> onAfter
没有缓存请求网络成功 onBefore -> onCacheError -> parseNetworkResponse -> onSuccess -> onAfter
没有缓存请求网络失败 onBefore -> onCacheError -> parseNetworkFail -> onError -> onAftercookie
无缓存时,网络请求成功 onBefore -> onCacheError -> parseNetworkResponse -> onSuccess -> onAfter
无缓存时,网络请求失败 onBefore -> onCacheError -> parseNetworkFail -> onError -> onAfter
有缓存时,网络请求成功 onBefore -> onCacheSuccess -> parseNetworkResponse -> onSuccess -> onAfter
有缓存时,网络请求失败 onBefore -> onCacheSuccess -> parseNetworkFail -> onError -> onAfter
OkHttpUtils.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 即为所须要的结果 } });
OkHttpUtils.get(Urls.URL_IMAGE)// .tag(this)// .execute(new BitmapCallback() { @Override public void onSuccess(Bitmap bitmap, Call call, Response response) { // bitmap 即为返回的图片数据 } });
OkHttpUtils.get(Urls.URL_DOWNLOAD)// .tag(this)// .execute(new FileCallback("file.jpg") { //文件下载时,须要指定下载的文件目录和文件名 @Override public void onSuccess(File file, Call call, Response response) { // file 即为文件数据,文件保存在指定目录 } @Override public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) { //这里回调下载进度(该回调在主线程,能够直接更新ui) } });
通常此种用法用于与服务器约定的数据格式,当使用该方法时,params中的参数设置是无效的,全部参数均须要经过须要上传的文本中指定,此外,额外指定的header参数仍然保持有效。
OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)// .tag(this)// .upString("这是要上传的长文本数据!")// .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) } });
该方法与postString没有本质区别,只是数据格式是json,通常来讲,须要本身建立一个实体bean或者一个map,把须要的参数设置进去,而后经过三方的Gson或者fastjson转换成json字符串,最后直接使用该方法提交到服务器。
HashMap<String, String> params = new HashMap<>(); params.put("key1", "value1"); params.put("key2", "这里是须要提交的json格式数据"); params.put("key3", "也可使用三方工具将对象转成json字符串"); params.put("key4", "其实你怎么高兴怎么写都行"); JSONObject jsonObject = new JSONObject(params); OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)// .tag(this)// .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) } });
OkHttpUtils.get("https://kyfw.12306.cn/otn")// .tag(this)// .headers("Connection", "close") //若是对于部分自签名的https访问不成功,须要加上该控制头 .headers("header1", "headerValue1")// .params("param1", "paramValue1")// // .setCertificates() //方法一:信任全部证书 // .setCertificates(getAssets().open("srca.cer")) //方法二:也能够设置https证书 //方法三:传入bks证书,密码,和cer证书,支持双向加密 // .setCertificates(getAssets().open("aaaa.bks"), "123456", getAssets().open("srca.cer")) .execute(new HttpsCallBack(this));
如下代码包含了如下内容:
setCertificates
方法便可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,建议每一个不一样功能的请求设置一个 .cacheTime(5000) // 缓存的过时时间,单位毫秒 .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 //这里给出的泛型为 ServerModel,同时传递一个泛型的 class对象,便可自动将数据结果转成对象返回 .execute(new DialogCallback<ServerModel>(this, ServerModel.class) { @Override public void onBefore(BaseRequest request) { // UI线程 请求网络以前调用 // 能够显示对话框,添加/修改/移除 请求参数 } @Override public ServerModel parseNetworkResponse(Response response) throws Exception{ // 子线程,能够作耗时操做 // 根据传递进来的 response 对象,把数据解析成须要的 ServerModel 类型并返回 // 能够根据本身的须要,抛出异常,在onError中处理 return null; } @Override public void parseNetworkFail(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 线程,文件下载过程当中回调 //参数含义同 上传相同 } });
每一个请求前都设置了一个参数tag
,取消则经过OkHttpUtils.cancel(tag)
执行。 例如:在Activity中,当Activity销毁取消请求,能够在onDestory里面统一取消。
@Override
protected void onDestroy() { super.onDestroy(); //根据 Tag 取消请求 OkHttpUtils.getInstance().cancelTag(this); }
execute方法不传入callback即为同步的请求,返回Response
对象,须要本身解析
Response response = OkHttpUtils.get("http://www.baidu.com")// .tag(this)// .headers("aaa", "111")// .params("bbb", "222") .execute();
添加header和param的方法各有三个地方,在提交的时候,他们是有顺序的,若是对提交顺序有须要的话,请注意这里
OkHttpUtils.getInstance().addCommonHeaders()
,OkHttpUtils.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"); OkHttpUtils.getInstance() .addCommonHeaders(headers) //设置全局公共头 .addCommonParams(params); //设置全局公共参数
callback
的onBefore
方法中添加 public abstract class CommonCallback<T> extends AbsCallback<T> { @Override public void onBefore(BaseRequest request) { super.onBefore(request); request.headers("HKCCC", "HVCCC")// .headers("HKDDD", "HVDDD")// .params("PKCCC", "PVCCC")// .params("PKDDD", "PVDDD")// } }
OkHttpUtils.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
目前内部提供的包含AbsCallback
, StringCallBack
,BitmapCallback
,FileCallBack
,能够根据本身的需求去自定义Callback
AbsCallback
: 全部回调的父类,抽象类StringCallBack
:若是返回值类型是纯文本数据,便可使用该回调BitmapCallback
:若是请求的是图片数据,则可使用该回调FileCallBack
:若是要作文件下载,则必须使用该回调,内部封装了关于文件下载进度回调的方法Callback
的继承使用,详细请看 Demo 源码中callback
包下的代码。由于不一样的项目需求,可能对数据格式进行了不一样的封装,因而在 Demo 中的进行了详细的代码示例,如下是详细介绍:
JsonCallback
:继承自AbsCallback
,通常来讲,服务器返回的响应码都包含 code,msg,data 三部分,在此根据本身的业务须要完成相应的逻辑判断,并对数据进行解析,可使用 Gson
或者 fastjson
,将解析的对象返回。DialogCallback
:继承自JsonCallback
,对须要在网络请求的时候显示对话框,使用该回调。StringDialogCallback
:继承自EncryptCallback
,若是网络返回的数据只是纯文本,使用该回调BitmapDialogCallback
:继承自BitmapCallback
,若是网络返回的是Bitmap对象,使用该回调DownloadFileCallBack
:继承自FileCallback
,若是须要作文件下载,使用该回调以上基本是包含了大部分的业务逻辑,具体状况请参照demo示例,根据业务需求修改!
javaBean
对象实现Serializable
接口,否者会报NotSerializableException
。由于缓存的原理是将对象序列化后直接写入 数据库中,若是不实现Serializable
接口,会致使对象没法序列化,进而没法写入到数据库中,也就达不到缓存的效果。
对于DEFAULT
缓存模式,超时时间是无效的,由于该模式是彻底遵循标准的http协议的,缓存时间是依靠服务端响应头来控制,因此客户端的cacheTime参数无效
目前提供了五种CacheMode
缓存模式,每种缓存模式均可以指定对应的CacheTime
,不一样的模式会有不一样的方法回调顺序,详细请看上面第二部分的callback执行顺序
NO_CACHE
: 不使用缓存,该模式下,cacheKey
,cacheTime
参数均无效DEFAULT
: 按照HTTP协议的默认缓存规则,例若有304响应头时缓存。REQUEST_FAILED_READ_CACHE
:先请求网络,若是请求网络失败,则读取缓存,若是读取缓存失败,本次请求失败。IF_NONE_CACHE_REQUEST
:若是缓存不存在才请求网络,不然使用缓存。FIRST_CACHE_THEN_REQUEST
:先使用缓存,无论是否存在,仍然请求网络。cacheKey
,建议针对不一样须要缓存的页面设置不一样的cacheKey
,若是相同,会致使数据覆盖。 #okhttputils
-dontwarn com.lzy.okhttputils.** -keep class com.lzy.okhttputils.**{*;} #okhttpserver -dontwarn com.lzy.okhttpserver.** -keep class com.lzy.okhttpserver.**{*;} #okhttp -dontwarn okhttp3.** -keep class okhttp3.**{*;} #okio -dontwarn okio.** -keep class okio.**{*;}