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. 訂閱者
當你想進行訂閱時,首先要開啟註冊(比如生命週期的啟動/恢複部分)
當你不再關注某個事情後,需要取消註冊(比如生命週期的停止/暫停部分)
當你對某個事情感興趣的話,就加入@Subscribe進行關注。
@Subscribe public void getMessage(@NonNull SomeEvent s) { //TODO: 在回掉中使用這個事件 }
2. 發行者
當你想發布訊息時,使用post即可,注意發行者同樣需要事先註冊。
執行個體說明
本文以簡訊服務接受為例,介紹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"); }}