优雅的处理加载中(loading)、重试(retry)和无数据(empty)
本文作者
作者:KingJA
链接:http://www.jianshu.com/p/2d3537101281
本文由作者投稿推送。
LoadSir是一个高效易用,低碳环保,扩展性良好的加载反馈页管理框架,在加载网络或其他数据时候,根据需求切换状态页面,可添加自定义状态页面,如加载中,加载失败,无数据,网络超时,占位图,登录失效等常用页面。可配合网络加载框架,结合返回状态码,错误码,数据进行状态页自动切换,封装使用效果更佳。
Github传送门
https://github.com/KingJA/LoadSir
本文前面是使用流程,后面是原理解析,如果大家有兴趣,可耐心看完。
效果预览
in Activity | in View | in Fragment |
---|---|---|
Placeholder | Muitl-Fragment | ViewPage+Fragment |
---|---|---|
使用场景
下面为大家常见的加载反馈页面:
loading | error | timeout |
---|---|---|
empty | custom | placeholder |
---|---|---|
面对这么多状态页面,你是不是还在用include的方式,setVisibility(View.VISIBLE/GONE),这种方式即不方便控制,也造成了视图层级冗余(你要把所有状态布局include进一个视图)。
如果有一种工具,能把这些事都做了就好了。恰好, LoadSir 把这些事做了,接下来我们就来了解一下它。
LoadSir的功能及特点
支持Activity,Fragment,Fragment(v4),View状态回调
适配多个Fragment切换,及Fragment+ViewPager切换,不会状态叠加或者状态错乱
利用泛型转换输入信号和输出状态,可根据网络返回体的状态码或者数据返回自动适配状态页,实现全局自动状态切换
只加载唯一一个状态视图,不会预加载全部视图
可设置重新加载点击事件(OnReloadListener)
可自定义状态页(继承Callback类)
可在子线程直接切换状态
可设置初始状态页(常用进度页作为初始状态)
不需要设置枚举或者常量状态值,直接用状态页类类型(xxx.class)作为状态码
可扩展状态页面,在配置中添加自定义状态页
可对单个状态页单独设置点击事件,根据返回boolean值覆盖或者结合OnReloadListener使用,如网络错误可跳转设置页
可全局单例配置,也可以单独配置
无预设页面,低耦合,开发者随心配置
LoadSir的使用只需要简单的三步,三步上篮的三步。
添加依赖
compile 'com.kingja.loadsir:loadsir:1.2.0'
第一步: 配置
全局配置方式
全局配置方式,使用的是单例模式,即获取的配置都是一样的。可在Application中配置,添加状态页,设置初始化状态页,建议使用这种配置方式。
单独配置方式
如果你即想保留全局配置,又想在某个特殊页面加点不同的配置,可采用该方式。
第二步: 注册
在Activity中使用
在View 中使用
在Fragment 中使用
由于Fragment添加到Activitiy方式多样,比较特别,所以在Fragment中注册方式不同于上面两种,大家先看模板代码:
第三步: 回调
直接回调
转换器回调 (推荐使用)
如果你不想再每次回调都要手动进行的话,可以选择注册的时候加入转换器,可根据返回的数据,适配对应的回调。
回调的时候直接传入转换器指定的数据类型。
loadService.showWithConvertor(httpResult);
自定义回调页
LoadSir为了完全解耦,没有预设任何状态页,开发者根据需求自定义自己的回调页面,比如加载中,没数据,错误,超时等常用页面,
设置布局及自定义点击逻辑
看到这,想必各位使用LoadSir应该没问题了,如果还想再进一步了解它的内部结构,可以继续往下看。
流程图
关键类
LoadSir:提供单例模式获取全局唯一实例,内部保存配置信息,根据配置创建LoadService。
LoadService:具体操作服务类,提供showSuccess,showCallback,showWithCoverator等方法来进行状态页回调。
LoadLayout:最终显示在用户面前的视图View,替换了原布局,是LoadService直接操作对象,要显示的状态页的视图会被添加到LoadLayout上。
Callback:状态页抽象类,抽象自定义布局和自定义点击事件两个方法留给子类实现。
Coverator:转换接口,可将网络返回实体转换成对应的状态页,达到自动适配状态页的目的。
我们直接观察在Activity中普通加载和使用LoadSir加载视图的区别
>>>没使用LoadSir
>>>使用LoadSir
大家可以看到,LoadSir用LoadLayout把原来的布局给替代掉了,原来的布局加在了LoadLayout上,其它自定义的状态页也同样会被加到这个LoadLayout上(显示的时候),而且LoadLayout的子View只有一个,就是当前要显示的状态页布局,并没有把当前不显示的比如加载中布局,错误布局,无数据布局加载进来,这也是LoadSir的优点之一,按需加载,并且只加载一个状态布局。
>>>替换逻辑
大家可以看到,在Activity和View中的情况都比较简单,直接获取target的父控件,然后在父控件中替换掉该布局即可。在Fragment中,由于可能多个Fragment的布局View并存在一个父控件里,所以不能简单地使用父控件删除子View方式替换,也有可能父控件是ViewPager,不能通过addView()的方式添加LoadLayout。因此Fragment的注册方式是直接返回了LoadLayout到Activity上。这样也达到了一样的目的。
下面是ViewPager+Fragment场景中使用LoadSir的视图,两个Fragment用各自的LoadLayout进行视图分离,避免了状态页叠加或错位。
看到这的童鞋应该也大概知道LoadSir是怎么回事了,如果想明白LoadSir的代码实现,请继续往下看。
我们按上面三步上篮的步骤来稍微分析下源码
>>>第一步:配置
单例模式获取LoadSir,在LoadSir构造的时候创建默认配置
Builder主要提供添加状态页,和设置默认状态页的方法
LoadSir提供beginBuilder()...commit()来设置全局配置。
>>>第二步:注册
LoadSir注册后返回的是LoadService,一看名字大家就明白这是服务类,就是我们所说的Service层。
在LoadService的构造方法中根据target等信息创建Success视图,并且生成LoadLayout,相当于LoadSir每次注册都会创建一个LoadLayout。
>>>第三步:回调
LoadService的三个回调方法最终调用的都是loadLayout.showCallback(callback);
我们直接看LoadLayout的showCallback方法,先做Callback是否配置判断,然后进行线程安全操作。重点还是showCallbackView(callback);
这个方法可以说是最后的执行者,就做两件事,删除LoadLayout所有子View(重置),添加指定的布局页View(回调)。
自此,LoadSir一个完整的配置,注册,回调的过程完成了。不知道你们明白了没,反正我是有点口渴了。
总结
建议在Application中全局配置,在BaseActivity,BaseFragment或者MVP中封装使用,能极大的减少代码量,让你的代码更加优雅,生活更加愉快。时间和个人能力有限,如果大家发现需要改进的地方,欢迎提交issue。
如果这个库对你有用的话,也请点个star:p
Github传送门
https://github.com/KingJA/LoadSir
推荐下100offer这个平台,除了找工作以外,也可以扫码关注下行业动态。
优秀人才不缺工作机会,只缺适合自己的好机会。但是他们往往没有精力从海量机会中找到最适合的那个。
100offer 会对平台上的人才和企业进行严格筛选,让「最好的人才」和「最好的公司」相遇。
扫描下方二维码,注册 100offer,谈谈你对下一份工作的期待。一周内,收到 5-10 个满足你要求的好机会!
如果你有想学习的文章直接留言,我会整理征稿。如果你有好的文章想和大家分享欢迎投稿,直接向我投递文章链接即可。