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

关键时刻,第一时间送达!

RxEasyHttp

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

注:Retrofit和Rxjava是当下非常火爆的开源框架,均来自神一般的公司。本库就不介绍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,线程智能控制

演示(请star支持)

RxEasyHttp与Rxjava结合使用场景演示

build.gradle设置

权限说明

如果使用本库实现文件下载到SD卡、或者配置了缓存数据到SD卡,你必须要考虑到Android6.0及以上系统的运行时权限,给大家推荐两个权限库:

AndPermission

RxPermissions

因为要请求网络、从SD卡读写缓存、下载文件到SD卡等等,所以需要在manifest.xml中配置以下几个权限,如果你已经配置过了这些权限,请不要重复配置:

全局配置

一般在 Aplication,或者基类中,只需要调用一次即可,可以配置调试开关,全局的超时时间,公共的请求头和请求参数等信息

初始化需要一个Context,最好在Application#onCreate()中初始化,记得在manifest.xml中注册Application。

Application:

manifest.xml:

默认初始化

如果使用默认始化后,一切采用默认设置。如果你需要配置全局超时时间、缓存、Cookie、底层为OkHttp的话,请看高级初始化。

高级初始化

可以进行超时配置、网络缓存配置、okhttp相关参数配置、retrofit相关参数配置、cookie配置等,这些参数可以选择性的根据业务需要配置。

请求数据

网络请求,采用链式调用,支持一点到底。

入口方法

通用功能配置

1.包含一次普通请求所有能配置的参数,真实使用时不需要配置这么多,按自己的需要选择性的使用即可

2.以下配置全部是单次请求配置,不会影响全局配置,没有配置的仍然是使用全局参数。

3.为单个请求设置超时,比如涉及到文件的需要设置读写等待时间多一点。

完整参数GET示例:

url

Url可以通过初始化配置的时候传入

入口方法传入:

如果入口方法中传入的url含有http或者https,则不会拼接初始化设置的baseUrl.

例如:则setBaseUrl()和baseUrl()传入的baseurl都不会被拼接。

注:EasyHttp.get/post/put/等采用拼接的用法时请注意,url要用/斜杠开头,例如:正确 错误

http请求参数

两种设置方式

.params(HttpParams params)

.params("param1","param1Value")//添加参数键值对

HttpParams params = new HttpParams();

params.put("appId", AppConstant.APPID);

.addCommonParams(params)//设置全局公共参数

http请求头

.headers(HttpHeaders headers)

.headers("header2","header2Value")//添加参数键值对

.addCommonHeaders(headers)//设置全局公共头

普通网络请求

支持get/post/delete/put等

链式调用的终点请求的执行方式有:execute(Classclazz) 、execute(Type type)、execute(CallBackcallBack)三种方式,都是针对标准的ApiResult

execute(CallBackcallBack)

1.EasyHttp(推荐

示例:

2.手动创建请求对象

execute(Classclazz)和execute(Type type)

execute(Classclazz)和execute(Type type)功能基本一样,execute(Type type)主要是针对集合不能直接传递Class

请求返回Disposable

网络请求会返回Disposable对象,方便取消网络请求

带有进度框的请求

带有进度框的请求,可以设置对话框消失是否自动取消网络和自定义对话框功能,具体参数作用请看请求回调讲解

方式一:ProgressDialogCallBack

ProgressDialogCallBack带有进度框的请求,可以设置对话框消失是否自动取消网络和自定义对话框功能,具体参数作用请看自定义CallBack讲解

注:错误回调 super.onError(e);必须写

方式二:ProgressSubscriber

请求返回Observable

通过网络请求可以返回Observable,这样就可以很好的通过Rxjava与其它场景业务结合处理,甚至可以通过Rxjava的connect()操作符处理多个网络请求。例如:在一个页面有多个网络请求,如何在多个请求都访问成功后再显示页面呢?这也是Rxjava强大之处。

注:目前通过execute(Classclazz)方式只支持标注的ApiResult结构,不支持自定义的ApiResult

示例:

文件下载

本库提供的文件下载非常简单,没有提供复杂的下载方式例如:下载管理器、断点续传、多线程下载等,因为不想把本库做重。如果复杂的下载方式,还请考虑其它下载方案。

文件目录如果不指定,默认下载的目录为/storage/emulated/0/Android/data/包名/files

文件名如果不指定,则按照以下规则命名:

1.首先检查用户是否传入了文件名,如果传入,将以用户传入的文件名命名

2.如果没有传入文件名,默认名字是时间戳生成的。

3.如果传入了文件名但是没有后缀,程序会自动解析类型追加后缀名

示例:

POST请求,上传String、json、object、body、byte[]

一般此种用法用于与服务器约定的数据格式,当使用该方法时,params中的参数设置是无效的,所有参数均需要通过需要上传的文本中指定,此外,额外指定的header参数仍然保持有效。

如果你对请求头有自己的要求,可以使用这个重载的形式,传入自定义的content-type文本

upJson该方法与upString没有本质区别,只是数据格式是json,通常需要自己创建一个实体bean或者一个map,把需要的参数设置进去,然后通过三方的Gson或者 fastjson转换成json字符串,最后直接使用该方法提交到服务器。

必须要增加设置

1.upString、upJson、requestBody、upBytes、upObject五个方法不能同时使用,当前只能选用一个

2.使用upJson、upObject时候params、sign(true/false)、accessToken(true/false)、拦截器都不会起作用

示例:

源码地址:https://github.com/zhou-you/RxEasyHttp

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20180701B14U1L00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。

扫码关注云+社区

领取腾讯云代金券