OkGO

• 基本的get、post、put、delete、head、options、trace、patch八种请求
• 支持upString，upJson，upBytes，upFile等up类方法上传特定数据
• 支持一个key上传一个文件，也可以一个key上传多个文件，也可以多文件和多参数一起上传
• 大文件下载和下载进度回调
• 大文件上传和上传进度回调
• 支持cookie的自动管理，并可自定义cookie管理策略
• 支持缓存模式，不仅支持http缓存协议，也支持自定义缓存策略
• 支持重定向
• 支持自定义超时自动重连次数
• 支持链式调用
• 支持https访问，支持双向认证
• 支持根据tag取消请求，也可全部取消
• 支持自定义Callback，自动解析网络数据
• //导入依赖

•   implementation 'com.lzy.net:okgo:3.0.4'  okgo依赖

• 这里演示的是一次普通请求所有能配置的参数，真实使用时不需要配置这么多，按自己的需要选择性的使用即可
• 第一行的泛型一定要特别注意，这个表示你请求网络的数据类型是什么，必须指定，否则无法解析网络数据。
• .post(url)：这个表示当前请求是post请求，当然一共支持GET，HEAD，OPTIONS，POST，PUT，DELETE, PATCH, TRACE这8种请求方式，你只需要改改这个方法名就行了，很方便。

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

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

• .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次，你也可以在这里为你的这个请求特殊配置一个，并不会影响全局其他请求的超时重连次数。
• .cacheKey() .cacheTime() .cacheMode()：这三个是缓存相关的配置，详细请看缓存介绍
• .headers()：该方法是传递服务端需要的请求头，如果你不知道什么是请求头，看wiki首页关于网络抓包中的http协议链接。
• .params()：该方法传递键值对参数，格式也是http协议中的格式，详细参考上面的http协议连接。
• .addUrlParams() .addFileParams() .addFileWrapperParams()：这里是支持一个key传递多个文本参数，也支持一个key传递多个文件参数，详细也看上面的http协议连接。

•  

  • 

  • .Response对象介绍

  • 
• 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()获取该值。

• 另外，该对象还有以下几个方法：

• code()：http协议的响应状态码，如果数据来自网络，无论成功失败，该值都为真实的响应码，如果数据来自缓存，该值一直为-1。
• message()：http协议对响应状态码的描述信息，如果数据来自网络，无论成功失败，该值都为真实的描述信息，如果数据来自缓存，该值一直为null。
• headers()：服务端返回的响应头信息，如果数据来自网络，无论成功失败，该值都为真实的头信息，如果数据来自缓存，该值一直为null。
• isSuccessful()：本次请求是否成功，判断依据是是否发生了异常。

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

  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上传多个文件，以下方式可以任选

  特别要注意的是

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

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

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

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

  3). 如果你的服务器希望你在没有文件的时候依然使用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.参数的顺序

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

• 第一个地方，全局初始化时添加 

• 第二个地方，Callback的onStart()方法中添加 

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

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

  Header顺序: HKAAA -> HKBBB -> HKEEE -> HKFFF -> HKCCC -> HKDDD
  Params顺序: PKAAA -> PKBBB -> PKEEE -> PKFFF -> PKCCC -> PKDDD

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

  如果你觉得好，对你有过帮助，请给我一点打赏鼓励吧，一分也是爱呀！