Android中的okHttp
Android 一个改善的okHttp封装库
分类: 【Android 快速开发】 2015-11-09 19:52 8906人阅读 评论(43) 收藏 举报 android okhttp目录(?)[+]
转载请标明出处:
http://blog.csdn.net/lmj623565791/article/details/49734867;
本文出自:【张鸿洋的博客】
一、概述
之前写了篇Android OkHttp完全解析 是时候来了解OkHttp了,其实主要是作为okhttp的普及文章,当然里面也简单封装了工具类,没想到关注和使用的人还挺多的,由于这股热情,该工具类中的方法也是剧增,各种重载方法,以致于使用起来极不方便,实在惭愧。
于是,在这个周末,抽点时间对该工具类,进行了重新的拆解与编写,顺便完善下功能,尽可能的提升其使用起来的方便性和易扩展性。
标题的改善,也是指的是对于我之前的代码进行改善。
如果你对okhttp不了解,可以通过Android OkHttp完全解析 是时候来了解OkHttp了进行了解。
ok,那么目前,该封装库志支持:
- 一般的get请求
- 一般的post请求
- 基于Http的文件上传
- 文件下载
- 上传下载的进度回调
- 加载图片
- 支持请求回调,直接返回对象、对象集合
- 支持session的保持
- 支持自签名网站https的访问,提供方法设置下证书就行
- 支持取消某个请求
源码地址:https://github.com/hongyangAndroid/okhttp-utils
引入:
-
Android Studio
使用前,对于Android Studio的用户,可以选择添加:
compile project(':okhttputils')
- 1
主项目中无需再引用okhttp的依赖,也不需要再额外导入Gson的lib.
-
Eclipse
下载okhttputils.jar,添加到项目libs,同时需要下载okhttp.jar和gson-2.2.1.jar
二、基本用法
目前基本的用法格式为:
new OkHttpRequest.Builder() .url(url) .params(params) .headers(headers) .tag(tag) .get(callback);
- 1
- 2
- 3
- 4
- 5
- 6
通过Builder去根据自己的需要添加各种参数,最后调用get(callback)进行执行,传入callback则代表是异步。如果单纯的get()则代表同步的方法调用。
可以看到,取消了之前一堆的get重载方法,参数也可以进行灵活的选择了。
类似的,除了get方法,还有post、upload、download、displayImage。用法基本都一致。下面简单看一下。
(1)GET请求
//最基本new OkHttpRequest.Builder() .url(url) .get(callback);//扩展new OkHttpRequest.Builder() .url(url) .params(params) .headers(headers) .tag(tag) .get(callback);
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
(2)POST请求
//最基本new OkHttpRequest.Builder() .url(url) .params(params) .post(callback);//扩展new OkHttpRequest.Builder() .url(url) .params(params) .headers(headers) .tag(tag) .post(callback);
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
(3)基于POST的文件上传
//基本new OkHttpRequest.Builder() .url(url) .files(files) .upload(callback);//扩展new OkHttpRequest.Builder() .url(url) .params(params) .headers(headers) .tag(tag) .files(files) .upload(callback);
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
(4)下载文件
//基本new OkHttpRequest.Builder() .url(url) .destFileDir(destFileDir) .destFileName(destFileName) .download(callback);//扩展new OkHttpRequest.Builder() .url(url) .params(params) .headers(headers) .tag(tag) .destFileDir(destFileDir) .destFileName(destFileName) .download(callback);
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
(5)显示图片
//基本 new OkHttpRequest.Builder() .url(url) .imageview(imageView) .displayImage(callback);//扩展new OkHttpRequest.Builder() .url(url) .params(params) .headers(headers) .tag(tag) .imageview(imageView) .errorResId(errorResId) .displayImage(callback);
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
会自动根据ImageView的大小进行压缩。
哈,目前来看,清晰多了。
三、对于上传下载的回调
new ResultCallback>(){ //... @Override public void inProgress(float progress) { //use progress: 0 ~ 1 }}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
对于传入的callback有个inProgress方法,当调用upload(callback),download(callback)方法时,progress回调0~1.(UI线程)。
四、对于自动解析为实体类
//对象new ResultCallback (){ //... @Override public void onResponse(User user) { mTv.setText(user.username); }}//集合new ResultCallback>(){ //... @Override public void onResponse(List users) { mTv.setText(users.get(0).username); }}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
目前支持单个对象,或者集合,内部依赖Gson完成。
注意:泛型一定要设置,如果你不需要转化为实体对象,就写new ResultCallback
,
五、对于https单向认证
非常简单,拿到xxx.cert的证书。
然后调用
OkHttpClientManager.getInstance() .getHttpsDelegate() .setCertificates(inputstream);
- 1
- 2
- 3
- 4
建议使用方式,例如我的证书放在assets目录:
/** * Created by zhy on 15/8/25. */public class MyApplication extends Application{ @Override public void onCreate() { super.onCreate(); try { OkHttpClientManager.getInstance() .getHttpsDelegate() .setCertificates(getAssets().open("aaa.cer"), getAssets().open("server.cer")); } catch (IOException e) { e.printStackTrace(); } }}
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
即可。别忘了注册Application。
注意:如果https网站为权威机构颁发的证书,不需要以上设置。自签名的证书才需要。
六、浅谈封装
其实整个封装的过程比较简单,这里简单描述下,对于okhttp一个请求的流程大致是这样的:
//创建okHttpClient对象OkHttpClient mOkHttpClient = new OkHttpClient();//创建一个Requestfinal Request request = new Request.Builder() .url("https://github.com/hongyangAndroid") .build();//new callCall call = mOkHttpClient.newCall(request); //请求加入调度call.enqueue(new Callback(){ @Override public void onFailure(Request request, IOException e) { } @Override public void onResponse(final Response response) throws IOException { //String htmlStr = response.body().string(); }});
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
其中主要的差异,其实就是request的构建过程。
我对Request抽象了一个类:OkHttpRequest
public abstract class OkHttpRequest{ protected RequestBody requestBody; protected Request request; protected String url; protected String tag; protected Map params; protected Map headers; protected OkHttpRequest(String url, String tag, Map params, Map headers) { this.url = url; this.tag = tag; this.params = params; this.headers = headers; } protected abstract Request buildRequest(); protected abstract RequestBody buildRequestBody(); protected void prepareInvoked(ResultCallback callback) { requestBody = buildRequestBody(); requestBody = wrapRequestBody(requestBody, callback); request = buildRequest(); } protected RequestBody wrapRequestBody(RequestBody requestBody, final ResultCallback callback) { return requestBody; } public void invokeAsyn(ResultCallback callback) { prepareInvoked(callback); mOkHttpClientManager.execute(request, callback); } // other common methods }
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
一个request的构建呢,我分三个步骤:buildRequestBody
, wrapRequestBody
,buildRequest
这样的次序,当以上三个方法没有问题时,我们就拿到了request,然后执行即可。
但是对于不同的请求,requestBody以及request的构建过程是不同的,所以大家可以看到buildRequestBody
,buildRequest
为抽象的方法,也就是不同的请求类,比如OkHttpGetRequest
、OkHttpPostRequest
等需要自己去构建自己的request。
对于wrapRequestBody
方法呢,可以看到它默认基本属于空实现,主要是因为并非所有的请求类都需要复写它,只有上传的时候呢,需要回调进度,需要对requestBody进行包装,所以这个方法类似于一个钩子。
其实这个过程有点类似模板方法模式,有兴趣可以看看一个短篇介绍设计模式 模版方法模式 展现程序员的一天 .
对于更加详细的用法,可以查看github上面的readme,以及demo,目前demo包含:
对于上传文件的两个按钮,需要自己搭建服务器,其他的按钮可以直接测试。
最后,由于本人水平有限,以及时间比较仓促~~发现问题,欢迎提issue,我会抽时间解决。 have a nice day ~
源码点击下载
欢迎关注我的微博:
http://weibo.com/u/3165018720
更多相关文章
- android客户端程序访问服务器端webservice,几篇不错的文章!
- Android(安卓)Intent传递对象
- Android(安卓)CountDownTimer的使用
- android IOS在WebView 和 JS 交互对比
- Unity3D 调用Android原生方法
- Android中两种设置全屏的方法 && Android横竖屏切换
- 使用 Android(安卓)NDK 的一般方法:
- 浅谈Java中Collections.sort对List排序的两种方法
- Python list sort方法的具体使用