举例讲解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"); } }