OkHttpUtils

封装了okhttp的网络框架,支持大文件上传下载,上传进度回调,下载进度回调,表单上传(多文件和多参数一起上传),链式调用,可以自定义返回对象,支持Https和自签名证书,支持cookie自动管理,支持四种缓存模式缓存网络数据,支持301、302重定向,扩展了统一的上传管理和下载管理功能

联系方式

演示

1.用法

或者点击下载Demo okhttputils_v1.7.2.apk。

 compile 'com.lzy.net:okhttputils:1.7.2' //可以单独使用,不需要依赖下方的扩展包
	compile 'com.lzy.net:okhttpserver:1.0.1' //扩展了下载管理和上传管理,根据需要添加
	compile 'com.lzy.net:okhttputils:+' //版本号使用 + 可以自动引用最新版
	compile 'com.lzy.net:okhttpserver:+' //版本号使用 + 可以自动引用最新版

 compile project(':okhttputils')
	compile project(':okhttpserver')

	okhttputils-1.7.2.jar
	okhttpserver-1.0.1.jar

其中的图片选择是我的另一个开源项目,完全仿微信的图片选择库,自带 矩形图片裁剪 和 圆形图片裁剪 功能,有需要的可以去下载使用,附上地址:https://github.com/jeasonlzy0216/ImagePicker

2.使用注意事项

3.OkHttpUtils 目前支持

4.OkHttpServer 扩展功能

4.1 统一的文件下载管理(DownloadManager):

4.2 统一的文件上传管理(UploadManager)

一、全局配置

 @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();
 }
 }

二、普通请求

0.写在开始的话,callback回调默认只需要复写onResponse,并不代表所有的回调都只走这一个,实际开发中,错误回调并没有成功回调使用频繁,所以callback的失败回调onError并没有声明为抽象的,如果有需要,请自行复写,不要再问我为什么回调没有执行啊,既然onResponse没有执行,那么一定是出错了回调了onError

无缓存模式,请求成功调用顺序(upProgress只在有请求体的情况下回调)

无缓存模式,请求失败调用顺序

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 即为文件数据,文件保存在指定目录
	 }
	 
	 @Override
 public void downloadProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
 //这里回调下载进度(该回调在主线程,可以直接更新ui)
 }
	});

4.普通Post,直接上传String类型的文本

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) {
			//上传成功
	 }
	 
	 @Override
 public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
 //这里回调上传进度(该回调在主线程,可以直接更新ui)
 }
	});

5.普通Post,直接上传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)//
	.postJson(jsonObject.toString())//
	.execute(new StringCallback() {
	 @Override
	 public void onResponse(boolean isFromCache, String s, Request request, @Nullable Response response) {
			//上传成功
	 }
	 
	 	 
	 @Override
 public void upProgress(long currentSize, long totalSize, float progress, long networkSpeed) {
 //这里回调上传进度(该回调在主线程,可以直接更新ui)
 }
	});

6.https请求(证书可以在全局初始化的时候设置,不用每次请求设置一遍)

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));

7.请求功能的所有配置讲解

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
 //这里给出的泛型为 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 线程,文件下载过程中回调
		 //参数含义同 上传相同
		}
 });

8.取消请求

	@Override
	protected void onDestroy() {
	 super.onDestroy();
		//根据 Tag 取消请求
	 OkHttpUtils.getInstance().cancelTag(this);
	}

9.同步的请求

	Response response = OkHttpUtils.get("http://www.baidu.com")//
					 .tag(this)//
					 .headers("aaa", "111")//
					 .params("bbb", "222")
									.execute();

10.参数的顺序

 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); //设置全局公共参数

 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, RequestInfo.class));

总结一句话就是,全局添加的在最开始,callback添加的在最后,请求添加的在中间

三、自定义CallBack使用

四、缓存的使用

五、混淆

 #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.**{*;}