OkHttpUtils

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

联系方式

演示

1.用法

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

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

	okhttputils-1.4.0.jar
	okhttpserver-0.1.4.jar

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

2.使用注意事项

3.目前支持

4.扩展功能

一、全局配置

 @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) //全局的写入超时时间
 .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类型的文本

OkHttpUtils.post(Urls.URL_TEXT_UPLOAD)//
	.tag(this)//
	.content("这是要上传的长文本数据!")//
	.mediaType(PostRequest.MEDIA_TYPE_PLAIN)//
	.execute(new StringCallback() {
	 @Override
	 public void onResponse(boolean isFromCache, String s, Request request, @Nullable Response response) {
			//上传成功
	 }
	});

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

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的证书,可变参数,可以设置多个
 .headers("header1", "headerValue1") // 添加请求头参数
 .headers("header2", "headerValue2") // 支持多请求头参数同时添加
 .params("param1", "paramValue1") // 添加请求参数
 .params("param2", "paramValue2") // 支持多请求参数同时添加
 .params("file1", new File("filepath1")) // 可以添加文件上传
 .params("file2", new File("filepath2")) // 支持多文件同时添加上传
 //这里给出的泛型为 RequestInfo,同时传递一个泛型的 class对象,即可自动将数据结果转成对象返回
 .execute(new DialogCallback<RequestInfo>(this, RequestInfo.class) {
		@Override
		public void onBefore(BaseRequest request) {
		 // UI线程 请求网络之前调用
		 // 可以显示对话框,添加/修改/移除 请求参数
		}
	
		@Override
		public RequestInfo parseNetworkResponse(Response response) {
		 // 子线程,可以做耗时操作
		 // 根据传递进来的 response 对象,把数据解析成需要的 RequestInfo 类型并返回
		 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 线程,文件下载过程中回调
		 //参数含义同 上传相同
		}
 });

6.取消请求

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

7.同步的请求

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

三、自定义CallBack使用

四、缓存的使用