Android OkHttp封装库
来源:互联网 发布:linux下怎样输入中文 编辑:程序博客网 时间:2024/05/17 08:47
转载请标明出处:
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的用户,可以选择添加:
- 1
或者
- 1
Eclipse
自行copy源码。
二、基本用法
目前基本的用法格式为:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
通过链式去根据自己的需要添加各种参数,最后调用execute(callback)进行执行,传入callback则代表是异步。如果单纯的execute()则代表同步的方法调用。
可以看到,取消了之前一堆的get重载方法,参数也可以进行灵活的选择了。
下面简单看一下,全部的用法:
(1)GET请求
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
(2)POST请求
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
(3)Post String
- 1
- 2
- 3
- 4
- 5
- 6
将string作为请求体传入到服务端,例如json字符串。
(4)Post File
- 1
- 2
- 3
- 4
- 5
- 6
将file作为请求体传入到服务端.
(5)基于POST的文件上传(类似web上的表单)
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
(6)下载文件
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
(7)显示图片
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
哈,目前来看,清晰多了。
三、对于上传下载的回调
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
对于传入的callback有个inProgress方法,需要拿到进度直接复写该方法即可。
四、对于自动解析为实体类
目前去除了Gson的依赖,提供了自定义Callback的方式,让用户自己去解析返回的数据,目前提供了StringCallback
,FileCallback
,BitmapCallback
分别用于返回string,文件下载,加载图片。
当然如果你希望解析为对象,你可以:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
自己使用自己喜欢的Json解析库完成即可。
解析成List<User>
,则如下:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
五、对于https单向认证
非常简单,拿到xxx.cert的证书。
然后调用
- 1
- 2
- 3
建议使用方式,例如我的证书放在assets目录:
- 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网站为权威机构颁发的证书,不需要以上设置。自签名的证书才需要。
六、配置
(1)全局配置
可以在Application中,通过:
- 1
- 2
然后调用client的各种set方法。
例如:
- 1
(2)为单个请求设置超时
比如涉及到文件的需要设置读写等待时间多一点。
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
调用build()之后,可以随即设置各种timeOut.
(3)取消单个请求
- 1
- 2
- 3
(4)根据tag取消请求
目前对于支持的方法都添加了最后一个参数Object tag
,取消则通过OkHttpUtils.cancelTag(tag)
执行。
例如:在Activity中,当Activity销毁取消请求:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
比如,当前Activity页面所有的请求以Activity对象作为tag,可以在onDestory里面统一取消。
七、浅谈封装
其实整个封装的过程比较简单,这里简单描述下,对于okhttp一个请求的流程大致是这样的:
- 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
- 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 OkHttp封装库
- Android okHttp封装库(1) -- okhttp-utils
- Android okHttp封装库(2) -- okhttp-OkGo
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- Android 一个改善的okHttp封装库
- JS——变量类型和计算
- 文章标题
- php生成器 需要5.5的php版本
- 如何保证线程执行的顺序
- 快速排序
- Android OkHttp封装库
- [js高手之路] es6系列教程
- 微信小程序入坑那些事情-POst 请求
- Webpack3.x入门篇——webpack.config配置
- Objective-C Runtime(四)Method Swizzling
- nginx,apache,MySQL,PHP查看编译参数
- 前端框架模式的变迁
- 学生管理系统(六)---设置窗体
- ios 重复执行方法