基于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

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