OkGo 网络请求框架介绍与使用说明

前言

本文摘自 OkGo,一个专注于让网络请求更简单的框架,与 RxJava 完美结合,比 Retrofit 更简单易用。

项目地址:https://github.com/jeasonlzy

使用

Android Studio 用户

一般来说,只需要添加第一个 okgo 的核心包即可,其余的三个库根据自己的需要选择添加。

//必须使用
compile 'com.lzy.net:okgo:3.0.4'

//以下三个选择添加,okrx和okrx2不能同时使用
compile 'com.lzy.net:okrx:1.0.2'
compile 'com.lzy.net:okrx2:2.0.2'  
compile 'com.lzy.net:okserver:2.0.5'

//或者
compile 'com.lzy.net:okgo:+'        //版本号使用 + 可以自动引用最新版
compile 'com.lzy.net:okrx:+'        //版本号使用 + 可以自动引用最新版
compile 'com.lzy.net:okserver:+'    //版本号使用 + 可以自动引用最新版

注意事项

OkGo主要功能

  • 基本的 get、post、put、delete、head、options、trace、patch 八种请求;

  • 支持 upString,upJson,upBytes,upFile 等 up 类方法上传特定数据;

  • 支持一个 key 上传一个文件,也可以一个 key 上传多个文件,也可以多文件和多参数一起上传;

  • 大文件下载和下载进度回调;

  • 大文件上传和上传进度回调;

  • 支持 cookie 的自动管理,并可自定义 cookie 管理策略;

  • 支持缓存模式,不仅支持 http 缓存协议,也支持自定义缓存策略;

  • 支持重定向;

  • 支持自定义超时自动重连次数;

  • 支持链式调用;

  • 支持 https 访问,支持双向认证;

  • 支持根据 tag 取消请求,也可全部取消;

  • 支持自定义 Callback,自动解析网络数据;

请求

1. 请求所有配置

无论做什么请求,第一行的泛型一定要加!

注意以下几点:

  • 这里演示的是一次普通请求所有能配置的参数,真实使用时不需要配置这么多,按自己的需要,选择性的使用即可;
  • 第一行的泛型一定要特别注意,这个表示你请求网络的数据类型是什么,必须指定,否则无法解析网络数据;
  • .post(url):
    这个表示当前请求是 post 请求,当然一共支持
    GET,HEAD,OPTIONS,POST,PUT,DELETE,PATCH, TRACE 这 8 种请求方式,你只需要改改这个方法名就行了,很方便;
  • .params():
    添加参数的时候,最后一个 isReplace 为可选参数,默认为 true,即代表相同 key 的时候,后添加的会覆盖先前添加的;
  • .tag(this):
    请求的 tag,用于标识当前的请求,方便后续取消对应的请求,如果你不需要取消请求,也可以不用设置;
  • .isMultipart():
    该方法表示是否强制使用 multipart/form-data 表单上传,因为该框架在有文件的时候,无论你是否设置这个参数,默认都是
    multipart/form-data 格式上传,但是如果参数中不包含文件,默认使用 application/x-www-form-urlencoded 格式上传,如果你的服务器要求无论是否有文件,都要使用表单上传,那么可以用这个参数设置为 true;
  • .isSpliceUrl():
    该方法表示是否强制将 params 的参数拼接到 url 后面,默认 false 不拼接。一般来说,post、put 等有请求体的方法应该把参数都放在请求体中,不应该放在 url 上,但是有的服务端可能不太规范,url 和请求体都需要传递参数,那么这时候就使用该参数,它会将你所有使用 .params() 方法传递的参数,自动拼接在 url 后面;
  • .retryCount():
    该方法是配置超时重连次数,也可以在全局初始化的时候设置,默认使用全局的配置,即为 3 次,你也可以在这里为你的这个请求特殊配置一个,并不会影响全局其他请求的超时重连次数;
  • .params():
    该方法传递键值对参数,格式也是 http 协议中的格式,详细参考上面的 http 协议连接;
  • .addUrlParams() .addFileParams() .addFileWrapperParams():
    这里是支持一个 key 传递多个文本参数,也支持一个 key 传递多个文件参数,详细也看上面的 http 协议连接;

另外,每个请求都有一个 .client() 方法可以传递一个 OkHttpClient
对象,表示当前这个请求将使用外界传入的这个 OkHttpClient 对象,其他的请求还是使用全局的保持不变。那么至于这个
OkHttpClient 你想怎么配置,或者配置什么东西,那就随意了,改个超时时间,加个拦截器什么的统统都是可以的,看你心情喽。

特别注意: 如果你的当前请求使用的是你传递的 OkHttpClient
对象的话,那么当你调用 OkGo.getInstance().cancelTag(tag) 的时候,是取消不了这个请求的,因为 OkGo 只能取消使用全局配置的请求,不知道你这个请求是用你自己的 OkHttpClient 的,如果一定要取消,可以是使用 OkGo 提供的重载方法,详细看下方的取消请求的部分


2. Response对象介绍

先看Response对象内部的字段:

该对象一共有5个字段,分别表示以下意思:

  • body:当前返回的数据,T 即为数据的泛型。使用方法 body() 获取该值。如果请求成功,回调 onSuccess(),该字段为 convertResponse() 解析数据后返回的数据。如果发生异常,回调 onError(),该字段值为 null

  • throwable:如果发生异常,回调 onError(),该字段保存了当前的异常信息。如果请求成功,回调 onSuccess(),该字段为 null。使用方法 getException() 获取该值;

  • isFromCache:表示当前的数据是来自哪里,true:来自缓存,false:来自网络。使用方法 isFromCache() 获取该值;

  • rawCall:表示当前请求的真正 okhttp3.Call 对象。使用方法 getRawCall() 获取该值;

  • rawResponse:表示当前请求服务端真正返回的 okhttp3.Response 对象,注意:如果数据来自缓存,该对象为 null,如果来自网络,该对象才有值。使用方法 getRawResponse() 获取该值。

另外,Response 对象还有以下几个方法:

  • code():http 协议的响应状态码,如果数据来自网络,无论成功失败,该值都为真实的响应码,如果数据来自缓存,该值一直为 -1;

  • message():http 协议对响应状态码的描述信息,如果数据来自网络,无论成功失败,该值都为真实的描述信息,如果数据来自缓存,该值一直为 null

  • headers():服务端返回的响应头信息,如果数据来自网络,无论成功失败,该值都为真实的头信息,如果数据来自缓存,该值一直为 null

  • isSuccessful():本次请求是否成功,判断依据是:是否发生了异常。


3. 基本请求

无论做什么请求,第一行的泛型一定要加!

那么我们不可能每次请求都写上面那么一大堆,这里可以看到,一次简单的请求,这么写就够了。

4. 请求 Bitmap

如果你知道你的请求数据是图片,可以使用这样的方法 :

5. 基本文件下载

如果你要下载文件,可以这么写。

FileCallback 具有三个重载的构造方法,分别是

  • FileCallback():空参构造

  • FileCallback(String destFileName):可以额外指定文件下载完成后的文件名

  • FileCallback(String destFileDir, String destFileName):可以额外指定文件的下载目录和下载完成后的文件名

文件目录如果不指定,默认下载的目录为 sdcard/download/,文件名如果不指定,则按照以下规则命名:

  1. 首先检查用户是否传入了文件名,如果传入,将以用户传入的文件名命名
  2. 如果没有传入,那么将会检查服务端返回的响应头是否含有
    Content-Disposition=attachment;filename=FileName.txt 该种形式的响应头,如果有,则按照该响应头中指定的文件名命名文件,如 FileName.txt
  3. 如果上述响应头不存在,则检查下载的文件url,例如:
    http://image.baidu.com/abc.jpg,那么将会自动以 abc.jpg 命名文件
  4. 如果 url 也不能把文件名解析出来,那么最终将以 "unknownfile_" + System.currentTimeMillis() 命名文件

这里面有个新对象叫 Progress,关于这个对象的解释,看这里我进行了专门的讲解


6. 上传 String 类型的文本

一般此种用法用于与服务器约定的数据格式,当使用该方法时,params 中的参数设置是无效的,所有参数均需要通过需要上传的文本中指定,此外,额外指定的 header 参数仍然保持有效。

默认会携带以下请求头:

Content-Type: text/plain;charset=utf-8

如果你对请求头有自己的要求,可以使用这个重载的形式,传入自定义的 content-type:

// 比如上传 xml 数据,就可以自己指定请求头:
upString("这是要上传的长文本数据!",MediaType.parse("application/xml"))


7. 上传 JSON 类型的文本

该方法与 upString 没有本质区别,只是数据格式是 json,一般来说,需要自己创建一个实体 bean 或者一个 map,把需要的参数设置进去,然后通过三方的 Gson 或者 fastjson 转换成 json 对象,最后直接使用该方法提交到服务器。

默认会携带以下请求头,请不要手动修改,okgo 也不支持自己修改

Content-Type: application/json;charset=utf-8


8. 上传文件

上传文件支持文件与参数一起同时上传,也支持一个 key 上传多个文件,以下方式可以任选。

特别要注意的是:

  • 很多人会说需要在上传文件到时候,要把 Content-Type
    修改掉,变成 multipart/form-data,就像下面这样的。其实在使用 OkGo 的时候,只要你添加了文件,这里的的 Content-Type 不需要你手动设置,OkGo 自动添加该请求头,同时,OkGo 也不允许你修改该请求头。

Content-Type: multipart/form-data; boundary=f6b76bad-0345-4337-b7d8-b362cb1f9949

  • 如果没有文件,那么 OkGo 将自动使用以下请求头,同样 OkGo 也不允许你修改该请求头。

Content-Type: application/x-www-form-urlencoded

  • 如果你的服务器希望你在没有文件的时候依然使用 multipart/form-data 请求,那么可以使用 .isMultipart(true) 这个方法强制修改,一般来说是不需要强制的。

有人说他有很多文件,不知道数量,又要一个文件对应一个 key 该怎么办,其实很简单,把调用链断开,用循环添加就行了嘛。

9. 取消请求

之前讲到,我们为每个请求都设置了一个参数 tag,取消就是通过这个 tag 来取消的。通常我们在 Activity 中做网络请求,当 Activity 销毁时要取消请求,否则会发生内存泄露,那么就可以在 onDestory() 里面写如下代码:

注意以下取消的请求不要全部用,自己按需要写,我只是写出来,告诉你有这么几个方法。

10. 同步请求

同步请求有两种方式,第一种是返回原始的 Response 对象,自行解析网络数据,就像这样:

或者可以返回解析完成的对象,如果你使用过 Retrofit,那么你对这个 Call 对象一定不会陌生,这里面有个方法是 converter(),需要传递一个 Converter 接口,作用其实就是解析网络返回的数据,你也可以自定义 Converter,代码如下:

什么是同步请求?

同步:提交请求 -> 等待服务器处理 -> 处理完毕返回。这个期间客户端浏览器不能干任何事
异步:请求通过事件触发 -> 服务器处理(这时客户端仍然可以作其他事情)-> 处理完毕

同步就是你叫我去吃饭,我听到了就和你去吃饭;如果没有听到,你就不停的叫,直到我告诉你听到了,才一起去吃饭。

异步就是你叫我,然后自己去吃饭,我得到消息后可能立即走,也可能等到下班才去吃饭。


11. https 请求

https 的请求和 http 请求一模一样,只需要在初始化配置一下,详细的 https 配置方法点击这里


12. 参数的顺序

添加 headersparams 的方法各有三处,在提交的时候,他们是有顺序的,如果对提交顺序有需要的话,请注意这里:

  • 第一个地方,全局初始化时添加
  • 第二个地方,CallbackonStart() 方法中添加

  • 第三个地方,执行网络请求的时候添加

那么,最终执行请求的参数的添加顺序为:

Header 顺序: HKAAA -> HKBBB -> HKEEE -> HKFFF -> HKCCC -> HKDDD

Params 顺序: PKAAA -> PKBBB -> PKEEE -> PKFFF -> PKCCC -> PKDDD

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容