Android百大框架第五期——《强大的HTTP框架okhttp》

 金诚   2018-05-04 11:50   142 人阅读  0 条评论

前言

本文适合读者:对网络应用感兴趣的读者

okhttp定义:一款java平台、android平台的网络请求框架。

okhttp性质:一款不依赖android平台的java网络请求库,可以应用于android项目,也可以应用于JSE、JEE项目

okhttp与其他网络请求框架的区别:还在调研中。

okhttp的优点:不依赖Android平台。

okhttp的缺点:还在调研中。

自学okhttp的思路:
- 从远程仓库检索项目,项目仓库地址 点击这里
- 项目目录结构
- 查看测试用例:项目根目录\okhttp-tests\src\test\java\okhttp3
- 查看Get\Post用法:项目根目录\samples

入门之旅

添加okhttp依赖库

在app/build.gradle中增加依赖

如果需要查看网络日志,还需增加依赖

并且在Manifest.xml文件中配置网路权限:

发布的APK包由于Android 6.0 新的权限机制可能需要动态申请网络权限,此处需注意。

选择请求源

比如我们想查看远程服务器上的某个文件内容

使用Get请求查看远程服务器文件

如果你要写的是Java程序,而不是Android程序的话,我们可以这么写:

注: 上述代码仅在Java应用程序中有效。

Android应用程序有着独立与普通Java应用程序的运行机制。Android 代码若想运行 网络相关的请求,需要放在子线程中:

比如这样

在Android程序中创建了子线程去发起网络请求,接着我们在Android Stduio 的Log日志里,可以看到远程服务端的README.md文件了。

在这个示例中我们会看到三个对象:OkhttpClient、Request、Response

熟悉计算机网络的朋友,一定知道,与服务器建立通讯,首先要从客户端发起请求,那么Request是必不可少的对象;服务器返回的数据被Okhttp封装在Response中,为了解析服务器响应的数据,我们必须关注Response对象。

至于OkhttpClient,我们一定需要它吗,答案是肯定的,我们如果想探寻Okhttp框架的能力,据为己用,必须遵循Okhttp框架的规则——从核心入口进入。OkhttpClient就是那个核心类。

创建Request对象需要借助Request的Builder类;

创建Response对象需要借助Okhttpclient的执行函数,获得返回值。

小结:
1. Java应用于Android应用不同,时刻考虑是否需要子线程;
2. Okhttpclient用来发情请求、获得服务端响应数据;
3. Request用来组装Htpp请求参数。

选择一个提交源

这是某个服务器的提交接口,通过向这个接口输入特定格式的数据,以测试Http Post请求

向服务器提交数据

Okhttp Post请求示例如下,下面这段示例的功能是向服务器提交一段Json

我们可以在Android studio 的logcat里看到服务端返回的数据:

点击这个链接,可以看到我们刚才提交的数据,已经被服务端接收并且显示到Web页面上了。

我们可以看出,与之前Get请求相比,Post请求新增了两个个对象:RequestBody、MediaType。
1. RequestBody用来设定参数和参数的编码
2. MediaType用来定义参数的编码类型

为何要用RequestBody?
因为我们需要向服务端发送参数。参数是类似key-value这样的语法声明。

为何要对参数编码?Okhttp中常见的编码类型有哪些?

      1. 对参数编码,是为了遵循Http请求体的编码格式
      2. 对参数编码,是为了遵循与服务端一直的解码格式
      3. 对参数编码,可以为参数设置字符集,避免服务端解析乱码

    </ol start="1.">

Okhttp的RequestBody对象常见的编码类型:

更多MediaType的知识,属于因特网技术的知识,详情可以点击这里查看

RequestBody和它的子类

RequestBody是抽象类,在Okhttp框架中,RequestBody有两个子类实现:FormBody、MultipartBody,同时我们可以继承RequestBody自定义子类

RequestBody提供的关键功能

函数 功能(组装指定格式的数据)
public static RequestBody create(final @Nullable MediaType contentType, final byte[] content) { 组装字节数据
public static RequestBody create(final @Nullable MediaType contentType, final File file) 组装文件
public static RequestBody create(@Nullable MediaType contentType, String content) 组装字符串

RequestBody的用法:

从RequestBody内部的函数,可以看出它能够组装字符串、字节数组、文件。

RequestBody类是一个abstract类型的抽象类,因此,我们可以使用匿名内部类的形式创建Request的子类实例化对象

FormBody也提供了一些功能,这些功能放在内部类Builder类中:

函数 功能
FormBody.Builder(String string) 设定字符编码
FormBody.Builder().add(String name, String value) 组装参数
FormBody.Builder().build() 创建FormBody对象

FormBody的用法:

MultipartBody也提供了一些功能,这些功能放在内部类Builder类和Part类中:

函数名 功能
MultipartBody.Builder(String string) 设置字符编码格式
MultipartBody.Builder().addPart(@Nullable Headers headers, RequestBody body) 组装请求头
MultipartBody.Builder().addFormDataPart(String name, String value) 以表单格式组装字符串
MultipartBody.Builder().addFormDataPart(String name, @Nullable String filename, RequestBody body) 以表单格式组装 RequestBody
MultipartBody.Builder().addPart(@Nullable Headers headers, RequestBody body) 普通方式组装RequestBody
MultipartBody.Builder().addPart(RequestBody body) 普通方式组装RequestBody
MultipartBody.Builder().build() 创建MultipartBody对象

MultipartBody的用法:

除了掌握对RequestBody、FormBody、MultipartBody用法外,还需留意RequestBody的参数打印方式,用Buffer打印RequestBody

进行表单提交

表单提交是一种客户端与服务器约定的数据提交方式。

okhttp form表单提交示例:

Okhttp 知识点

在日常开发中,我们需要掌握的类和用法有:
1. OkHttpClient

      • OkHttpClient client=new OkHttpClient();
      • OkHttpClient client2=client.newBuilder().build();
      • OkHttpClient.Builder builder = new OkHttpClient.Builder();
        builder.connectTimeout(1, TimeUnit.NANOSECONDS);
        builder.writeTimeout(1, TimeUnit.NANOSECONDS);
        builder.readTimeout(1, TimeUnit.NANOSECONDS);
      • client.newBuilder()
        .addInterceptor(interceptor)
        .addNetworkInterceptor(interceptor)
        .build();
      • client.newCall(request).execute()
      • client.newCall(request).enqueue(Callback ...)
        1. Request
          • Request get = new Request.Builder().url("http://localhost/api").get().build();
            get.body()
          • Request.Builder builder = new Request.Builder();
            builder.header(null, "Value");
          • Request request = new Request.Builder()
            .cacheControl(new CacheControl.Builder().noCache().build())
            .url("https://square.com")
            .build();
        2. RequestBody
          • RequestBody.create(contentType, "abc".getBytes(Util.UTF_8));
          • MediaType contentType = MediaType.parse("text/plain; charset=utf-8");
          • MediaType contentType = MediaType.parse("text/plain");
          • MediaType contentType = MediaType.parse("application/json");
          • body.contentType()
          • body.contentLength()
          • 自定义RequestBody

        3. FormBody(同RequestBody)
        4. MultipartBody(同RequestBody)
        5. Buffer
          • Buffer buffer = new Buffer();
            body.writeTo(buffer);
            String result=buffer.readUtf8();
        6. Call
        7. CallBack
        8. Stream
          为什么要引入流的概念?
          流,是对流动的字节(字符)抽象的描述。当我们将数据传输的过程看作流体的流动后,很多抽象的编程做法就容易理解了。
          流可以帮助我们理解文件上传、文件下载、批量上传、批量下载、断点续传等经典需求;它们往往发生在:小杨在某一天在有道云笔记APP上写了很多笔记,点击同步,有道云笔记将本地的笔记同步至服务端(文件上传);小杨买了新手机,初次下载有道云笔记,登录了以前的账号,点击同步,同步服务器的笔记至新手机的存储卡上(文件下载);同步的时候发生错误,保存同步的进度,下次同步的时候根据上次同步的进度,继续同步。
          简明复习Java字节流的用法(下面章节会用到)InputStream、OutputStream用法:
          用法细节:

          用法总结:

            1. InputStream规定的流体的输入源、OutputStream规定了流体的输出源;
            2. InputStream 可以被一个字节一个字节的读取
            3. OutputStream 可以被一个字节一个字节的输出
            4. 为什么要强调一个一个的字节?因为要用于记录通讯进度,比如上传进度、下载进度。

          </ol start="1.">

        9. Response
          • ResponseBody body=response.body()
        10. ResponseBody
          • body.source().readUtf8()
          • body.byteStream()
          • body.charStream()
          • body.string()
          • body.contentLength()
        11. Interceptor
          • 使用Inteceptor的动机:查看HTTP的请求报文的参数、响应报文的参数
          • Interceptor的用法:自定义类实现Interceptor接口的方法;从Chain对象中获取Request、Response,打印输出想查看的参数

      </ol start="2.">

okhttp 结构

学习一门框架,掌握知识点之间结构尤为重要,笔者列出几个简单结构,供读者参考:

          1. OkHttpClient-Request-Response
          2. OkHttpClient-Request-RequestBody-Response
          3. OkHttpClient-RequestBody(MediaType):{RequestBody,FormBody,MultipartBody}-Response
          4. RequestBody-Buffer
          5. RequestBody-MediaType
          6. ResponseBody-String
          7. Response-Json-FastJson
          8. Response-ResponseBody-Call-CallBack
          9. Interceptor-Chain-Request-Response

        </ol start="1.">

okhttp工作的大致流程

整体流程

(1)、当我们通过OkhttpClient创建一个Call,并发起同步或异步请求时;
(2)、okhttp会通过Dispatcher对我们所有的RealCall(Call的具体实现类)进行统一管理,并通过execute()及enqueue()方法对同步或异步请求进行处理;
(3)、execute()及enqueue()这两个方法会最终调用RealCall中的getResponseWithInterceptorChain()方法,从拦截器链中获取返回结果;
(4)、拦截器链中,依次通过RetryAndFollowUpInterceptor(重定向拦截器)、BridgeInterceptor(桥接拦截器)、CacheInterceptor(缓存拦截器)、ConnectInterceptor(连接拦截器)、CallServerInterceptor(网络拦截器)对请求依次处理,与服务的建立连接后,获取返回数据,再经过上述拦截器依次处理后,最后将结果返回给调用方。
提供两张图便于理解和记忆:

 

6024478-fcfb26ca04a78fbc.png
okhttp整体流程1
6024478-80d45f4fcc34489e.png
okhttp整体流程2

 

这张图只画出了请求流程,没有数据返回流程,后期会处理。

拦截器的原理解析

RetryAndFollowUpInterceptor:负责重定向

构建一个StreamAllocation对象,然后调用下一个拦截器获取结果,从返回结果中获取重定向的request,如果重定向的request不为空的话,并且不超过重定向最大次数的话就进行重定向,否则返回结果。注意:这里是通过一个while(true)的循环完成下一轮的重定向请求。

(1)、StreamAllocation为什么在第一个拦截器中就进行创建?
???????便于取消请求以及出错释放资源。
(2)、StreamAllocation的作用是什么?
???????StreamAllocation负责统筹管理Connection、Stream、Call三个实体类,具体就是为一个Call(Realcall),寻找( findConnection() )一个Connection(RealConnection),获取一个Stream(HttpCode)。

BridgeInterceptor

负责将原始Requset转换给发送给服务端的Request以及将Response转化成对调用方友好的Response,具体就是对request添加Content-Type、Content-Length、Connection、Accept-Encoding等请求头以及对返回结果进行解压等。

CacheInterceptor

CacheInterceptor:负责读取缓存以及更新缓存。
在请求阶段:

      1. 读取候选缓存cacheCandidate;
      2. 根据originOequest和cacheresponse创建缓存策略CacheStrategy;
      3. 根据缓存策略,来决定是否使用网络或者使用缓存或者返回错误。
        具体的的缓存策略就是http的缓存策略,详见下图:
        在结果返回阶段:
        负责将网络结果进行缓存(使用于DiskLruCache)。
6024478-bcb83a4dccb3a2c4.png
okhttp&http缓存策略

强制缓存:当客户端第一次请求数据是,服务端返回了缓存的过期时间(Expires与Cache-Control),没有过期就可以继续使用缓存,否则则不适用,无需再向服务端询问。
对比缓存:当客户端第一次请求数据时,服务端会将缓存标识(Etag/If-None-Match与Last-Modified/If-Modified-Since)与数据一起返回给客户端,客户端将两者都备份到缓存中 ,再次请求数据时,客户端将上次备份的缓存
标识发送给服务端,服务端根据缓存标识进行判断,如果返回304,则表示缓存可用,如果返回200,标识缓存不可用,使用最新返回的数据。

ETag是用资源标识码标识资源是否被修改,Last-Modified是用时间戳标识资源是否被修改。ETag优先级高于Last-Modified。

ConnectInterceptor:负责与服务器建立连接

使用StreamAllocation.newStream来和服务端建立连接,并返回输入输出流(HttpCodec),实际上是通过StreamAllocation中的findConnection寻找一个可用的Connection,然后调用Connection的connect方法,使用socket与服务端建立连接。

CallServerInterceptor:负责从服务器读取响应的数据

主要的工作就是把请求的Request写入到服务端,然后从服务端读取Response。
(1)、写入请求头
(2)、写入请求体
(3)、读取响应头
(4)、读取响应体

连接池原理

由于HTTP是基于TCP,TCP连接时需要经过三次握手,为了加快网络访问速度,我们可以Reuqst的header中将Connection设置为keepalive来复用连接。

Okhttp支持5个并发KeepAlive,默认链路生命为5分钟(链路空闲后,保持存活的时间),连接池有ConectionPool实现,对连接进行回收和管理。

连接池的清理

6024478-b2d3dfc5542b4cce.png
连接池清理1

 

在ConectionPool中有一个异步线程去清理连接池中的连接,首先通过cleanup方法执行清理,然后等待clean返回的时间后,再次进行清理,以此循环,持续清理。

6024478-da5bf326653b7671.png
连接池原理2

1、首先统计空闲连接数量;
2、然后通过for循环查找最长空闲时间的连接以及对应空闲时长;
3、然后判断这个最长空闲时间的连接是否超出最大空闲连接数或者或者超过最大空闲时间,满足其一则清除最长空闲的连接。如果不满足清理条件,则返回一个对应等待时间。
这个对应等待的时间又分二种情况:
1 有空闲连接:则返回:keepAliveDurationNs-longestIdleDurationNs;
2 没有空闲的连接,则返回:keepAliveDurationNs
注意:清除一个空闲连接后,会返回0,再次立即开始清理。

如何统计空闲连接呢?

 

6024478-076bec66f5dd894f.png
统计空闲连接

 

StreamAllocation创建一个Connection后会将自己添加到Connection的connection.allocations列表中,数据读取完毕之后,会将自己从Connection的connection.allocations中移除,所以判读一个Connection是否是空闲连接可以采用引用计数法,判断connection.allocations列表中是否有StreamAllocation,如果没有就是空闲连接,否则不是。

扩展参考

本文地址:http://www.yangchaofan.cn/archives/466
版权声明:本文为原创文章,版权归 金诚 所有,欢迎分享本文,转载请保留出处!

说点什么

avatar
  Subscribe  
提醒