NetBus —— 让你的 App 内部随处感知网络的变化
简介
NetBus 是一个实时监听网络状态的一个框架,接入简单。只需要几步就可以在 Activity 和 Fragment 以及其他要观测的类中很方便的收到网络状态变化的通知。
愿景
- 可以在 App 任意位置监听网络的变化
- 同一类中监听不同类型的网络
- 监听者可以指定不同的网络环境
- 布局封装,简化布局状态切换
使用
1. 添加依赖
implementation 'com.github.meetsl.netbus:SNetBus:1.1'
2. 初始化
在项目最开始的地方需要对 NetBus 进行初始化,例如 Application 或者 启动页中初始化。初始化代码如下:
//初始化 NetBus(必须)
NetBus.init(this)
//全局设置公共布局(可选)
NetBus.initNetView(loadResId = R.layout.layout_loading_view, netErrorResId = R.layout.layout_net_error_view)
3. 添加监听
- Activity 或者 Fragment 中添加监听
- 在 `Activity` 或者 `Fragment`中注册该接收者,在 `onCreate()` 或者 `onCreateView()` 中添加注册:
NetBus.getDefault().register(this)
- 然后需要在类中添加一个只有一个 boolean 类型参数的方法并添加注解:
/**
* 接受网络状态变化通知的方法
*
* @param isAvailable : true 当前 NetMode 下网络可用;false 无网络状态,与 NetMode 无关
*/
@NetSubscribe(netMode = NetMode.WIFI, threadMode = ThreadMode.MAIN, priority = 1)
fun onNetEvent(isAvailable: Boolean) {
Log.i("Callback_Network", "${this.javaClass} $name 网络变化了")
}
- OK,Activity 或者 Fragment 对网络的监听这样子就可以了。如果你的项目中 Activity 或者 Fragment 中有父类,则注册的这个操作放在父类中也是可以的。
- 在其他位置中监听网络变化
- 在代码中新建一个 `NetBusTest` 的测试类,示例代码完整的展示了如何进行监听:
public class NetBusTest { /**
* 需要在适当的时机,比如类对象创建的时候就进行注册
*/
public void run() {
NetBus.Companion.getDefault().register(this);
} /**
* 接收网络状态变化,这里监听的是移动数据网络
*
* @param isAvailable true 当前 NetMode 下网络可用;false 无网络状态,与 NetMode 无关
*/
@NetSubscribe(netMode = NetMode.CELLULAR, threadMode = ThreadMode.MAIN, priority = 1)
public void onEvent(boolean isAvailable) {
Log.i("Callback_Network", "NetBusTest ---- 网络变化了");
} /**
* 在类对象不再被使用或者销毁的时候,进行解注册
*/
public void stop() {
NetBus.Companion.getDefault().unregister(this);
}
}
- 在类中添加了一个 `run()` 和一个 `stop()` 方法用于注册和解注册,`onEvent` 方法用于接收网络状态变化。与 `Activity` 或者 `Fragment` 不一样的地方就是需要我们自己手动解注册,这一点需要在使用的时候注意一下。
辅助开发
在该框架中还提供了一个用于辅助开发的布局 `PageStateLayout` ,在一个正常的业务 App 中,一个 Page 中一般会有三到四种的状态布局,比如 EmptyLayout (无数据视图) 、NetErrorLayout(网络错误视图)、LoadLayout(加载视图)以及 NormalLayout(正常显示视图)。这个辅助布局有一定的限制,大家可以根据场景决定使不使用。下面说一下这个布局的具体使用:
- 设置全局状态布局
- 比如我们的 App 设计的时候,网络错误的视图都是统一的,那么我们可以将该试图设置为全局视图。这样每一个 `PageStateLayout` 对象在显示网络错误视图时,显示的都是一个:(在 App 启动页或者 Application 中设置)
//全局设置公共布局
NetBus.initNetView(netErrorResId = R.layout.layout_net_error_view)
- 设置局部状态布局
- 由于每一个 Page 在同一状态下布局可能不一致,所以提供了局部设置:
private lateinit var stateLayout: PageStateLayout override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
stateLayout = PageStateLayout(this)
//设置正常显示视图
stateLayout.setNormalView(R.layout.activity_main)
//设置该 Page 的 空视图
stateLayout.setEmptyView(R.layout.layout_empty_default)
//设置该 Page 的加载视图
stateLayout.setLoadingView(R.layout.layout_loading_view)
//设置该 Page 的网络错误视图
stateLayout.setNetErrorView(R.layout.layout_net_error_view)
//显示
setContentView(stateLayout)
NetBus.getDefault().register(this)
}
- 示例代码说明了如何设置局部视图,以及显示使用
- 显示调用
- 将 `PageStateLayout` 设置给 Page 后如何控制显示布局,很简单:
@NetSubscribe(netMode = NetMode.WIFI, threadMode = ThreadMode.POSTING, priority = 1)
fun onEvent(isAvailable: Boolean) {
println("网络变化了")
if (!isAvailable)
stateLayout.showNetErrorView()
else
stateLayout.showNormalView()
Log.i("Callback_Network", "MainActivity ----$isAvailable 网络变化了")
}
- `PageStateLayout` 提供了 `showXXXX` 的方法来显示布局
总结
到这里该框架基本就介绍完了,希望它可以在你的项目中,很方便的帮助你监听网络状态。如果在使用中有什么问题或者建议,能告诉我那就太棒了。框架会持续更新,这里放上框架的 github 地址,欢迎 star 以及 comment 。
NetBus —— 让你的 App 内部随处感知网络的变化的更多相关文章
- 碰到一个在app内部浏览器锚点异常的问题
最近在做一个文章评论的功能,其中一个需求是:在提交完评论后,需要跳转到位于页面底部的评论区域,正常情况下location.href=http://m.hostname.cn/article#comme ...
- 苹果拒绝App内部使用版本检测功能
10.6 - Apple and our customers place a high value on simple, refined, creative, well thought through ...
- Android APP 内部捐赠实现(支付宝&微信)
Android APP 内部捐赠实现(支付宝&微信) 目前支持 支付宝和 微信. 项目地址:https://github.com/didikee/AndroidDonate https://p ...
- android app内部更新适配到8.0
app 内部跟新是app中必须要有的功能,在app出现改变时,app内部更新能以最快的速度将应用提升到最新版本. 步骤: 1.获取本地app的版本号 int versionCode = 0; try ...
- 上门洗车APP --- Androidclient开发 之 网络框架封装介绍(二)
上门洗车APP --- Androidclient开发 之 网络框架封装介绍(二) 前几篇博文中给大家介绍了一下APP中的基本业务及开发本项目使用的网络架构: 上门洗车APP --- Androidc ...
- cordova在app内部指定浏览器打开链接插件:cordova-plugin-inappbrowser
原文网址:http://www.ncloud.hk/%E6%8A%80%E6%9C%AF%E5%88%86%E4%BA%AB/cordova-plugin-inappbrowser/ 要想App里边的 ...
- iOS - 跳到系统App内部设置
从App中跳转到手机设置中此App内的设置授权界面: NSURL *url = [NSURL URLWithString:UIApplicationOpenSettingsURLString]; if ...
- app接口,如何保证是由app内部调用而非外部模拟post请求调用。
在爬虫快手主播信息的时候,发现只要我改动一下参数,比如第一页 page=1的时候,需要爬下一页,把page改为2发现提示sign验证失败了 也就是说,快手在开发的时候考虑了有人抓包到接口后,通过修改参 ...
- 如何获得APP内部资源
安装一个iTools(百度一下就有) 用USB连接设备,打开iTools
随机推荐
- JS变量类型与计算
一.题目 1.JS中使用typeof能得到哪些类型? 2.何时使用===何时使用==? 3.JS中有哪些内置函数? 4.JS变量按照存储方式区分为哪些类型,并描述其特点? 5.如何理解JSON? 知识 ...
- python 使用 PIL 和 matplotlib 获取图片像素点处理之后再写入
python 版本 3.x 首先安装 PIL 由于PIL仅支持到Python 2.7,加上年久失修,于是一群志愿者在PIL的基础上创建了兼容的版本,名字叫Pillow,支持最新Python 3.x,又 ...
- 深入理解Java虚拟机8-chap12-13-斗者5星
一.操作系统与内存 通过在处理器与内存之间添加一层访问及更新速度更快的高速缓存,可以一定程度解决处理器与内存速度的矛盾 引入新问题:缓存一致性,即每个处理器只与自己的缓存交互,如果操作的是内存中的同一 ...
- python实现可以被with上下文管理的类或函数
# .开始之前先明确一下with机制 # 1.类包函数__enter__()和__exit__()函数,即是可以被上下文管理的类 # __enter__用来执行with时的方法,__exit__返 ...
- Linux内核开发进阶书籍推荐(不适合初学者)
Linux内核开发进阶书籍推荐(不适合初学者) 很早之前就想写一篇文章总结一下Linux Kernel开发的相关资料,项目的原因,再加上家里的一些事情,一直没能找到闲暇,今天终于有些时间,希望可以完成 ...
- sql server导出数据,远程连接失败,需要设置权限
在sql server management中右键当前连接——>方面 在 服务器配置中 将 RemoteAccessEnabled.RemoteDacEnabled设置为TRUE 安全性—— ...
- webstorm编辑器使用
1.自动生成vue文件模板,如图
- Machine Learning 第一二周
# ML week 1 2 一.关于machine learning的名词 学习 从无数数据提供的E:experience中找到一个函数使得得到T:task后能够得到P:prediction 监督学习 ...
- Windows Server 2012安装IIS 8.0
一.安装 1.鼠标右键[This PC]→[Manage] 2.选择[Add Roles and Features] 3.勾选[.Net Framewore 3.5] 和 [.Net Framewor ...
- java 字符串笔记
java字符串当中有三个关于字符串对象的类. String 首先谈论下他们各自的含义: 1.String含义为引用数据类型,是字符串常量.是不可变的对象,(显然线程安全)在每次对string类型进行改 ...