基于RxJava2+Retrofit+OkHttp3搭建网络框架(包括添加公共参数,统一错误处理,自动登录,数据加解密)

1.相关库的依赖

2.全局网络管理

    封装思路大体都差不多,单例模式构建全局网络管理者:

   在构造方法中初始化OkHttpClient和Retrofit:       

3.公共参数添加

   项目中经常会要求接口添加一些公共的请求参数,例如手机版本信息,app版本,系统版本,时间戳等。 okhttp提供了强大的拦截器Interceptor,基于此实现公共参数的统一添加:

4.统一错误处理

一般后台返回的json数据都有统一格式,例如:

根据实际情况去自定义,一般都会包含code,msg,data这三个字段。然后定义一个异常类:

这个类也很简单,code对应的就是服务端返回的code,displayMsg对应两种情况:一种是服务端返回的错误信息,另一种则是网络问题等外部错误信息。具体的错误处理逻辑我放在了Observer类中:


onNext()方法重的处理很简单,根据返回数据中的succsee字段判断成功与否,这里做了一个data的非空判断,是为了处理有些成功但不返回data数据的情况。失败则直接调用了onError()方法,将失败的情况当作异常来处理:

根据异常类型来做处理,如果异常为之前定义的ApiException,则在此处可以根据定义好的code做具体处理,如登录信息过期,被限制登录等等。这里仅仅将错误信息取出来做展示。

5.token过期时自动登录

        有种需求是客户端请求某个接口,发现登录信息已经过期,此时要帮客户自动登录且登录成功后继续请求之前的接口,让用户察觉不到,也就是自动登录。具体做法是用户初次登录,服务端返回token和access_token,客户端将其保存在本地,通过access_token来访问服务端。access_token的有效期比较短,一旦失效,服务端会返回一个401错误,客户端在收到这个错误后,拿token去访问一个接口生成新的access_token,然后拿着有效的access_token访问。OkHttp提供了authenticator()方法:

实现的authenticator:

注意要使用同步的方式获取refresh_token。获取成功后将新的token放在header中继续访问。

6.请求参数与响应数据的加解密

        通常生产环境下接口请求参数和服务端返回的数据都是要经过加密处理的,这里就需要借助retrofit的addConverterFactory()方法来实现。首先需要自定义一个Converter.Factory类:

主要实现responseBodyConverter()和requestBodyConverter()两个方法,返回两个Converter对象,在这两个类里面可以实现加解密。由于加密的实现各不相同,这里不给出具体实现,只展示解密:

具体解密方法可以按需替换。

最后还有一个统一的线程调度实现,避免每个请求都去做同样的事情:


demo地址:https://github.com/huangxshuo/RetrofittedNetwork

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