基于RxJava2+Retrofit2的简单易用网络请求框架

Posted 2021-04-30 郭霖

今日科技快讯

昨日，HTC宣布与Google签署协议。原参与打造Google Pixel手机的HTC成员加入Google。此外，HTC还将其专利非专属权授予Google使用。为了得到HTC的这些专利和将近2000名员工，Google一共拿出了11亿美元的真金白银。

作者简介

明天就是周末啦，提前祝大家周末愉快！

本篇来自 周游 的投稿，分享了自己封装的网络框架，希望对大家有所帮助！

http://blog.csdn.net/zhouy478319399/

RxEasyHttp

本库是一款基于 RxJava2+Retrofit2 实现简单易用的网络请求框架，结合android平台特性的网络封装库,采用api链式调用一点到底,集成 cookie 管理,多种缓存模式,极简https配置,上传下载进度显示,请求错误自动重试,请求携带token、时间戳、签名sign动态配置,自动登录成功后请求重发功能,3种层次的参数设置默认全局局部,默认标准ApiResult同时可以支持自定义的数据结构，已经能满足现在的大部分网络请求。

注：Retrofit 和 Rxjava 是当下非常火爆的开源框架，均来自神一般的Square公司。本库就不介绍 Retrofit 和 Rxjava2 的用法。

为什么封装此库?

网上好的开源网络库像 Volley、async-http、okhttp、retrofit 等都非常强大，但是实际应用中我们不会直接去使用，一般都会根据自己的业务再封装一层，这样更方便快捷，又能统一处理业务共性的东西例如：统一的数据结构（code、msg、data）、token处理、网络异常等情况。在使用 retrofit 来请求网络的时候，项目的需求越来越多，api也随之越来越多，一个普通的应用api一般也在100+左右。如果把这些api放在一个ApiService内会很臃肿，不利于查看api.如果采用模块的方式对api进行分类，每个模块对应若干个api.以retrofit的使用方式又需要创建若干个ApiService，这种方式维护方便，但是模块增多了，类也增多了很多。对于懒人来说就想通过一个URL就能回调你所需要的数据，什么 ApiService 都不想理会，同时又可以很快的与自己的业务相关联，就类似于代替你在开源网络库基础上再封装一层的作用，于是本库就应运而生。

特点

• 比Retrofit使用更简单、更易用。

• 采用链式调用一点到底

• 加入基础ApiService，减少Api冗余

• 支持动态配置和自定义底层框架Okhttpclient、Retrofit.

• 支持多种方式访问网络GET、POST、PUT、DELETE等请求协议

• 支持网络缓存,六种缓存策略可选,涵盖大多数业务场景

• 支持固定添加header和动态添加header

• 支持添加全局参数和动态添加局部参数

• 支持文件下载、多文件上传和表单提交数据

• 支持文件请求、上传、下载的进度回调、错误回调，也可以自定义回调

• 支持默认、全局、局部三个层次的配置功能

• 支持任意数据结构的自动解析

• 支持添加动态参数例如timeStamp时间戳、token、签名sign

• 支持自定义的扩展API

• 支持多个请求合并

• 支持Cookie管理

• 支持异步、同步请求

• 支持Https、自签名网站Https的访问、双向验证

• 支持失败重试机制，可以指定重试次数、重试间隔时间

• 支持根据ky删除网络缓存和清空网络缓存

• 提供默认的标准ApiResult解析和回调，并且可自定义ApiResult

• 支持取消数据请求，取消订阅，带有对话框的请求不需要手动取消请求，对话框消失会自动取消请求

• 支持请求数据结果采用回调和订阅两种方式

• api设计上结合http协议和android平台特点来实现,loading对话框,实时进度条显示

• 返回结果和异常统一处理

• 结合RxJava2，线程智能控制

演示

缓存介绍

本库的缓存主要分 okhttp 的 Cache缓存 和 自定义的RxCache缓存,大家有疑问 okhttp 有缓存，retrofit 也是支持通过header来设置缓存，为什么还要自定义一个缓存机制呢？通过自定义 RxCache 缓存使用更简单，更符合我们常用的业务需求(常用的缓存策略也不会太复杂)， retrofit 的缓存借助于 okhttp 通过拦截器 interceptor 实现 或者 通过@Headers("Cache-Control: public, max-age=3600) 具体用法这里不做详细描述，有兴趣的可以自己去了解。动态修改缓存时间不方便，例如：同一个接口，不同时间段请求的内容缓存的时间不一样，需要动态修改。

对于 DEFAULT模式 是 okhttp 的 Cache缓存。因为该模式是完全遵循标准的http协议的,缓存时间是依靠服务端响应头来控制，也可以通过拦截器自己处理

对于 RxCache 的缓存支持多种存储方式，提供 IDiskConverter 转换器接口目前支持 SerializableDiskConverter 和 GsonDiskConverter 两种方式，也可以自定义 Parcelable、fastjson、xml、kryo 等转换器 SerializableDiskConverter 使用缓存前，必须让缓存的数据所有 javaBean 对象实现 Serializable 接口，否则会报 NotSerializableException。 因为缓存的原理是将对象序列化后保存，如果不实现 Serializable 接口，会导致对象无法序列化，进而无法保存，也就达不到缓存的效果。 优点：存储和读取都不用再转化直接就是需要的对象速度快 缺点：如果 javabean 里面还有 javabean 且层级比较多，也必须每个都要实现 Serializable接口，比较麻烦。

GsonDiskConverter 此种方式就是以 json 字符串的方式存储 优点：相对于SerializableDiskConverter 转换器，存储的对象不需要进行序列化 缺点：就是存储和读取都要使用Gson进行转换，object->String->Object的给一个过程，相对来说每次都要转换性能略低，但是性能基本忽略不计

目前提供了八种 CacheMode 缓存模式,每种缓存模式都可以指定对应的CacheTime,将复杂常用的业务场景封装在里面，让你不用关心缓存的具体实现，而专注于数据的处理

• NO_CACHE：不使用缓存,该模式下,cacheKey,cacheTime 等参数均无效

• DEFAULT：按照HTTP协议的默认缓存规则，走OKhttp的Cache缓存

• FIRSTREMOTE：先请求网络，请求网络失败后再加载缓存

• FIRSTCACHE：先加载缓存，缓存没有再去请求网络

• ONLYREMOTE：仅加载网络，但数据依然会被缓存

• ONLYCACHE：只读取缓存，缓存没有会返回null

• CACHEANDREMOTE: 先使用缓存，不管是否存在，仍然请求网络，CallBack会回调两次.

• CACHEANDREMOTEDISTINCT: 先使用缓存，不管是否存在，仍然请求网络，CallBack回调不一定是两次，如果发现请求的网络数据和缓存数据是一样的，就不会再返回网络的回调,既回调一次。否则不相同仍然会回调两次。（目的是为了防止数据没有发生变化，也需要回调两次导致界面无用的重复刷新）,此种模式缓存的对象bean一定要重写tostring()方法

注：无论对于哪种缓存模式，都可以指定一个 cacheKey，建议针对不同需要缓存的页面设置不同的 cacheKey，如果相同，会导致数据覆盖。

RxCache

RxCache 是自己封装的一个本地缓存功能库，采用 Rxjava+DiskLruCache 来实现，线程安全内部采用 ReadWriteLock 机制防止频繁读写缓存造成的异常，可以独立使用，单独用 RxCache 来存储数据。采用 transformer 与网络请求结合，可以实现网络缓存功能,本地硬缓存，具有缓存读写功能（异步）、缓存是否存在、根据key删除缓存、清空缓存（异步）、缓存Key会自动进行MD5加密、可以设置缓存磁盘大小、缓存key、缓存时间、缓存存储的转换器、缓存目录、缓存Version等功能本库不作为重点介绍。后期会将此代码独立开源一个库，作为一分钟让你自己的网络库也具有缓存功能，敬请期待！！！

最后

由于此库的用法以及配置多种多样，本篇文章就不再赘述，感兴趣的朋友可以点击最后 阅读原文 查看更加完整的详细用法。

https://github.com/zhou-you/RxEasyHttp

更多