举例讲解Android应用开发中OTTO框架的基本使用
otto是一个eventbus类型的事件传输总线,它可以提供“存储转发”的功能,让你app中各个组件的交流更加便利,让你的程序分层更加清晰。
使用场景
otto基于observer设计模式。它有发布者,订阅者这两个主要对象。otto的最佳实践就是通过反射牺牲了微小的性能,同时极大的提高了程序的耦合度,更加利于mvp分工开发与维护。业务层开发者在处理资源(比如db, rest等)后并发布消息,展示层开发者(比如activity/fragment)就可以处理消息,而不用关心数据是怎么来的(在读报纸的时候需要知道编辑们如何排版印刷吗?),比如:
fragment,service或者activity组件之间的通信。比如
导航菜单的navigationdrawer与activity的通信
activity与activity的通信(在设置界面上勾选了夜间模式,回到主界面就发现已经完成变色了;或者你在详细界面上点了一个赞,回到主界面发现已经同步增加了一个"赞")
mvp(model view presidenter)架构中,model与presidenter的回掉通信。包括但不限于rest, db, sp, broadcastreceiver, contentobserver。
一、android studio中配置otto (eclipse中直接下载jar包导入)
跟之前介绍的其他的框架一样,它只需要简单地在build.gradle中配置下面的部分即可
dependencies { compile filetree(dir: 'libs', include: ['*.jar']) compile 'com.android.support:appcompat-v7:19.+' / /otto 所需要依赖的包 }
二、开始使用
1. 订阅者
当你想进行订阅时,首先要打开注册(比如生命周期的启动/恢复部分)
bus.register(this);
当你不再关注某个事情后,需要取消注册(比如生命周期的停止/暂停部分)
bus.unregister(this);
当你对某个事情感兴趣的话,就加入@subscribe进行关注。
@subscribe public void getmessage(@nonnull someevent s) { //todo: 在回掉中使用这个事件 }
2. 发布者
当你想发布消息时,使用post即可,注意发布者同样需要事先注册。
bus.post(someevent);
实例说明
本文以短信服务接受为例,介绍otto的使用
1. 构造单例模式
bus是一个单例,所以我们要创建一个单例模式,而最简单的单例当然是在application中建立,记得在manifest注册哦。
/** * created by leon on 15/5/27. * 主线程事件总线,方便在异步任务中回掉 */ public class mainthreadbus extends bus { private final handler handler = new handler(looper.getmainlooper()); @override public void post(final object event) { if (looper.mylooper() == looper.getmainlooper()) { //直接通过反射调用 super.post(event); } else { //通过handler把异步任务发送到ui线程,然后再反射调用 handler.post(new runnable() { @override public void run() { mainthreadbus.super.post(event); } }); } } }
接着是application的重写
public class globalcontext extends application { //event bus singleton public static final mainthreadbus bus = new mainthreadbus(); public static globalcontext instance; @override public void oncreate() { super.oncreate(); instance = this; } public static mainthreadbus getbusinstance(){ return bus; } public static globalcontext getcontextinstance(){ return instance; } }
2. 发送者(publisher)
现在我们要注册一个短信接收机器,为了与国内毒瘤软件抢占第一的短信监听,我们使用service动态注册接收器,以抢占第一优先级。
建立一个常驻后台的服务,动态注册接收器,以抢占第一优先级。同样记得要把service在manifest注册哦。
public class smsservice extends service { private smsreceiver mreceiver = null; public smsservice() { } @override public ibinder onbind(intent intent) { // todo: return the communication channel to the service. throw new unsupportedoperationexception("not yet implemented"); } @override public void oncreate() { super.oncreate(); log.d(tag, "oncreate"); intentfilter ifilter = null; // 意图过滤对象 mreceiver = new smsreceiver(); // 广播接收类初始化 ifilter = new intentfilter("android.provider.telephony.sms_received"); ifilter.setpriority(integer.max_value); // 设置优先级 globalcontext.getbusinstance().register(mreceiver);//注册bus registerreceiver(mreceiver, ifilter); // 注册广播 } @override public void ondestroy() { super.ondestroy(); if (mreceiver != null){ globalcontext.getbusinstance().unregister(mreceiver);//取消注册bus unregisterreceiver(mreceiver); } } }
接下来就是真正的发布者smsreceiver了,大部分代码与网上都是一样的,注意看我是如何发布消息的。
public class smsreceiver extends broadcastreceiver { public smsreceiver() { } @override public void onreceive(context context, intent intent) { bundle bundle = intent.getextras(); //获取链路层的协议数据单元 object[] messages = (object[]) bundle.get("pdus"); smsmessage[] sms = new smsmessage[messages.length]; // create messages for each incoming pdu for (int n = 0; n < messages.length; n++) { sms[n] = smsmessage.createfrompdu((byte[]) messages[n]); } for (smsmessage msg : sms) { //todo: 这里应该加上你自己的过滤条件,比如手机号,短信内容 //尽可能的拦截短信,这个命令在miui,flyme上都没有用 abortbroadcast(); globalcontext.getbusinstance().post(msg); } } }
从代码中可以看出,在service中,我们控制了smsreceiver中bus的生命周期,之后在smsreceiver中,通过post把消息发布出去
globalcontext.getbusinstance().post(msg);
3. 接收者(subscriber)
接收者可以是activity,也可以是fragment,还可以是service。
我们以fragment为例进行操作.
public class smscontrolfragment extends fragment { bus bus = globalcontext.getbusinstance(); @override public void onattach(activity activity) { super.onattach(activity); bus.register(this); } @override public void ondetach() { super.ondetach(); bus.unregister(this); } @subscribe public void getmessage(smsmessage s) { mtvnumber.settext(s.getoriginatingaddress()); mtvmessage.settext(s.getmessagebody()); } }
订阅者是fragment,发布者是smsreceiver,消息内容是smsmessage。
通过以上操作,一个使用otto的消息传递总线就完成了。
4.综合demo
下面的demo, 仅为了让大家知道“事件”被产生了之后,post出来,所有订阅了该事件的类都会接到该事件,接受的先后顺序,不由我们控制!
public class myactivity extends actionbaractivity { @override protected void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); setcontentview(r.layout.activity_my); findviewbyid(r.id.button_change).setonclicklistener(new view.onclicklistener() { @override public void onclick(view view) { busprovider.getbusinstance().post(new datachangedevent("this is changed string"));//发布事件 } }); } @override protected void onresume() { super.onresume(); busprovider.getbusinstance().register(this);//注册 } @override protected void onpause() { super.onpause(); busprovider.getbusinstance().unregister(this);//注销 } @subscribe //订阅事件datachangedevent public void saygoodonevent(datachangedevent event){ log.e("event", "good"); } @subscribe //订阅事件 public void saybadonevent(datachangedevent event){ log.e("event", "bad"); } @produce //产生事件 public datachangedevent producedatachangedevent(){ return new datachangedevent("this is changed string"); } }