android kotlin开发中对网络框架的封装

     app项目的开发过程中,都少不了进行网络请求的功能模块。而现在的主流网络框架中,使用最多而且反馈最好. 最稳定的就是 retrofit+okhttp+rxjava(rxandroid)的组合框架了。今天记录一下在kotlin语言开发下实现该网络框架的封装过程。

1.网络请求原理

        无论使用何种语言进行开发,其实只是在语法的编写和语法糖的调用上有一些差异。但是需要明确的是,先要搞清楚这一套网络框架的原理,包括框架中每个模块的具体作用。

1.1 okhttp 

    okhttp是最常用的网络请求框架了,最新的4.x的版本已经由java全部换成了kotlin,api的使用与老的3.x的版本也有了一些差异,具体调用可以去git官网查看,先来看一张它的调用流程图

调用流程

基本流程:

    1.我们通过OkhttpClient创建一个Call,并发起同步或异步请求时;

    2.okhttp会通过Dispatcher对我们所有的RealCall(Call的具体实现类)进行统一管理,并通过execute()及enqueue()方法对同步或异步请求进行处理;

    3.execute()及enqueue()这两个方法会最终调用RealCall中的getResponseWithInterceptorChain()方法,从拦截器链中获取返回结果;

   4.拦截器链中,依次通过RetryAndFollowUpInterceptor(重定向拦截器)、BridgeInterceptor(桥接拦截器)、CacheInterceptor(缓存拦截器)、ConnectInterceptor(连接拦截器)、CallServerInterceptor(网络拦截器)对请求依次处理,与服务的建立连接后,获取返回数据,再经过上述拦截器依次处理后,最后将结果返回给调用方。

     这其中不同的拦截器对应的不同的访问情况,具体的介绍可以自行去官网了解,这里就不一一介绍了 ,而且okhttp的拦截器模式使得我们很容易添加一个自定义拦截器对请求和返回结果进行处理。

1.2 retrofit

        retrofit可以理解为在okhttp的基础上进行加强再封装的一个网络框架,底层使用okhttp进行最终的访问,主要为了最大程度上优化请求链接的参数构建和实现解耦,使用注解+java接口来定义后台服务API接口。

注解主要分为 方法注解 和 参数注解

方法注解

@GET   表明HTTP请求方法为GET,(可选)注解的value属性用来设置相对/绝对url

@POST   表明HTTP请求方法为POST,(可选)注解的value属性用来设置相对/绝对url

@PUT    表明HTTP请求方法为PUT,(可选)注解的value属性用来设置相对/绝对url

@DELETE    表明http请求方法为DELETE,(可选)注解的value属性用来设置相对/绝对url

@PATCH   表明HTTP请求方法为PATCH,(可选)注解的value属性用来设置相对/绝对url

@HEAD   表明HTTP请求方法为HEAD,(可选)注解的value属性用来设置相对/绝对url

@OPTIONS   表明HTTP请求方法为OPTIONS,(可选)注解的value属性用来设置相对/绝对url

@HTTP  通过@HTTP注解指定http协议的请求方法,是否允许body,(可选)注解的value属性用来设置相对/绝对url

@FormUrlEncoded   表明发起HTTP请求的RequestBody是form表单方式

@Multipart    表明发起HTTP请求的RequestBody是Multipar方式

@Headers    使用注解的value值数组作为HTTP请求的头,用于一些固定的Header参数

@Streaming    用于需要直接返回流的函数

参数注解

@Url    HTTP请求的url路径(相对/绝对),可以包含{path_holder},如:http://xxx.com/{user_holder}/detail

@Path   用于动态替换URL路径中的path_holder

@Body   表明此参数用作HTTP请求的body

@Field  表明此参数用作HTTP请求的form表单参数,key为注解的value值

@FieldMap   以map形式传入的form表单参数

@Header   表明此参数用作HTTP请求的header,key为注解的value值

@HeaderMap   以map形式传入的多个header键值对

@Part   表明参数为Http的multipart参数之一

@PartMap  以map形式传入的multipart参数表

@Query GET方法的query参数,用于拼接完整请求路径

@QueryMap   以map传入的GET方法的query参数,用于拼接完整请求路径

      了解了注解之后,开始介绍Retrofit.create函数创建接口动态代理生成一个自定义的接口的实现类的过程

1 加载对应method的ServiceMethod实例

2 使用ServiceMethod实例和方法调用参数创建OkHttpCall

3 调用serviceMethod.callAdapter.adapt(okHttpCall)来产生method所定义的返回(Call<T>或者其他自定义CallAdapter支持的返回)

源码1

这其中以下4个元素是比较重要的,也是retrofit功能强大的保证,其中包括 callFactory,callAdapter,responseConverter ,parameterHandlers 

    callFactory是用来创建真正要执行的okhttp3.Call的工厂类,可以Retrofit.Builder中设置,如果不设置,默认会new一个OkHttpClient作为callFactory

callAdapter是用来最终处理OkHttpCall实例并返回接口Method所定义的返回

responseConverter 用来将Http请求的结果转换成接口Method所定义的结果(return或者Callback<T>中的T)

parameterHandlers 根据接口Method参数的注解所生成的参数处理Handler数组

1.3  rxjava

        rxjava 其实是一个实现异步操作,基于时间本身的第三方库,没有这个库之前,我们执行异步操作可以通过handler或者是tread进行,rajva等于就是针对这一类型事务处理的加强版本,那相对于传统实现异步操作的功能,rxjava的好处或者是优势点在哪里呢?先来看看它的基本原理和使用。

    rxjava采用的是观察者模式,有四个基本概念:Observable (可观察者,即被观察者)、 Observer (观察者)、 subscribe (订阅)、事件。Observable 和 Observer 通过 subscribe() 方法实现订阅关系,从而 Observable 可以在需要的时候发出事件来通知 Observer。

RxJava 的事件回调方法除了普通事件 onNext() (相当于 onClick() / onEvent())之外,还定义了两个特殊的事件:onCompleted() 和 onError()。

onCompleted(): 事件队列完结。RxJava 不仅把每个事件单独处理,还会把它们看做一个队列。RxJava 规定,当不会再有新的 onNext() 发出时,需要触发

onCompleted() 方法作为标志。

onError(): 事件队列异常。在事件处理过程中出异常时,onError() 会被触发,同时队列自动终止,不允许再有事件发出。

在一个正确运行的事件序列中, onCompleted() 和 onError() 有且只有一个,并且是事件序列中的最后一个。需要注意的是,onCompleted() 和 onError() 二者也是互斥的,即在队列中调用了其中一个,就不应该再调用另一个。

观察者模式

    在 RxJava 的默认规则中,事件的发出和消费都是在同一个线程的。也就是说,如果只用上面的方法,实现出来的只是一个同步的观察者模式。观察者模式本身的目的就是『后台处理,前台回调』的异步机制,因此异步对于 RxJava 是至关重要的。而要实现异步,则需要用到 RxJava 的另一个线程切换概念: Scheduler ,在不指定线程的情况下, RxJava 遵循的是线程不变的原则,即:在哪个线程调用 subscribe(),就在哪个线程生产事件;在哪个线程生产事件,就在哪个线程消费事件。如果需要切换线程,就需要用到 Scheduler (调度器)。RxJava 已经内置了几个 Scheduler 

    Schedulers.newThread(): 总是启用新线程,并在新线程执行操作。

    Schedulers.io(): I/O 操作(读写文件、读写数据库、网络信息交互等)所使用的 Scheduler。行为模式和 newThread() 差不多,区别在于 io() 的内部实现是是用一个无数量上限的线程池,可以重用空闲的线程,因此多数情况下 io() 比 newThread() 更有效率。不要把计算工作放在 io() 中,可以避免创建不必要的线程。

    Schedulers.computation(): 计算所使用的 Scheduler。这个计算指的是 CPU 密集型计算,即不会被 I/O 等操作限制性能的操作,例如图形的计算。这个 Scheduler 使用的固定的线程池,大小为 CPU 核数。不要把 I/O 操作放在 computation() 中,否则 I/O 操作的等待时间会浪费 CPU。

     AndroidSchedulers.mainThread(),它指定的操作将在 Android 主线程运行

有了这几个 Scheduler ,就可以使用 subscribeOn() 和 observeOn() 两个方法来对线程进行控制了。

subscribeOn(): 指定 subscribe() 所发生的线程,即 Observable.OnSubscribe 被激活时所处的线程。或者叫做事件产生的线程。

observeOn(): 指定 Subscriber 所运行在的线程。或者叫做事件消费的线程。

   2 具体实现

       基本模块的功能简单的介绍完成了,现在我们开始组合它们,将它们分装成通用的网络请求模块 ,首先我们需要在gradle文件中添加对应的远程仓库依赖。

依赖地址

    代码中首先实现okhttpclient请求类,常用的拦截器,连接时长等配置。

client类
请求日志的拦截器

   这样最基本的一个ohttp模块构建就完成了,接下来要开始进行retrofit模块的处理,既然是通用的请求模块,那就需要使用泛型来实现统一的retrofit请求模块的方法,其中包含有对应的gson解析工厂,rxjava的适配器,设置最基本的okhttpclient模块。

retrofit请求类

    目前这一步,已经完成了网络框架的大部分功能了,但是我们知道常规的网络请求或者去数据时,为了保证app使用过程的流畅,一般都是异步回调的操作。,所以接下来要实现rxjava的相关功能。

rxjava观察者模式

到了这一步,很多人有疑问说没见到具体的网络请求包含在这里面。其实这正是rxjava的关键作用,它的主要作用只是设置观察者和被观察者,进行事件的订阅而已,我们最后看看具体事例使用。

网络请求1
retrofit接口类

这样来看,就把rxjava和retrofit关联在一起了,最终实现了异步回调的网络请求. 代码很简单,只是为了熟悉和掌握个功能的模块及原理,在此做个笔记记录一下。

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