1. 程式人生 > >Android框架之EventBus的使用

Android框架之EventBus的使用

EventBus是由greenrobot 組織貢獻的一個Android事件釋出/訂閱輕量級框架。

EventBus是一個Android端優化的publish/subscribe訊息匯流排,簡化了應用程式內各元件間、元件與後臺執行緒間的通訊。比如請求網路,等網路返回時通過Handler或Broadcast通知UI,兩個Fragment之間需要通過Listener通訊,這些需求都可以通過EventBus實現。

傳統的事件傳遞的問題在於:通訊方式沒有實現解耦,是硬編碼在元件中的。元件一旦發生修改,對應的通訊方式就需要跟著修改。其實不管什麼場景下,我們最好能夠使得自己編寫的程式碼最大限度的解耦

 

使用EventBus的好處在於:

  • 簡化元件之間的通訊方式
  • 讓業務程式碼更加簡潔(但是需要配合相應註解進行使用)
  • 可以指定事件處理方法的執行執行緒,和訂閱者的優先順序(跟廣播類似)
  • 足夠的穩定,已經被很多Android應用使用,你絕對不是第一個吃螃蟹的人
  • EventBus實現瞭解耦,事件的建立和分發由EventBus管理,工作在一個單獨的執行緒。EventBus的工作原理如下圖:

 

官網地址:http://greenrobot.org/eventbus/
翻譯:http://blog.csdn.net/poorkick/article/details/55099311

二、新增依賴

compile 'org.greenrobot:eventbus:3.0.0'

 

三、解鎖技能

  1. EventBus的三要素
    • Event:事件,可以是任意型別的物件。
    • Subscriber:事件訂閱者,在EventBus3.0之前訊息處理的方法只能限定於onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync,他們分別代表四種執行緒模型。而在EventBus3.0之後,事件處理的方法可以隨便取名,但是需要新增一個註解@Subscribe,並且要指定執行緒模型(預設為POSTING)。
    • Publisher:事件釋出者,可以在任意執行緒任意位置傳送事件,直接呼叫EventBus的post(Object)方法。可以自己例項化EventBus物件,但一般使用EventBus.getDefault()就好了,根據post函式引數的型別,會自動呼叫訂閱相應型別事件的函式。
  2. EventBus的四種執行緒模型(ThreadMode)
    • POSTING(預設):如果使用事件處理函式指定了執行緒模型為POSTING,那麼該事件在哪個執行緒釋出出來的,事件處理函式就會在這個執行緒中執行,也就是說釋出事件和接收事件在同一個執行緒。線上程模型為POSTING的事件處理函式中儘量避免執行耗時操作,因為它會阻塞事件的傳遞,甚至有可能會引起應用程式無響應(ANR)。
    • MAIN:事件的處理會在UI執行緒中執行。事件處理時間不能太長,長了會ANR的。
    • BACKGROUND:如果事件是在UI執行緒中釋出出來的,那麼該事件處理函式就會在新的執行緒中執行,如果事件本來就是子執行緒中釋出出來的,那麼該事件處理函式直接在釋出事件的執行緒中執行。在此事件處理函式中禁止進行UI更新操作。
    • ASYNC:無論事件在哪個執行緒釋出,該事件處理函式都會在新建的子執行緒中執行,同樣,此事件處理函式中禁止進行UI更新操作。
  3. 使用步驟

    • 註冊:EventBus.getDefault().register(this);
    • 解註冊(為防止記憶體洩漏):EventBus.getDefault().unregister(this);
    • 構造傳送訊息類

      public class MessageEvent {
          public String name;
          public String password;
      
          public MessageEvent(String name, String password) {
              this.name = name;
              this.password = password;
          }
      }
      
    • 釋出訊息:EventBus.getDefault().post(new MessageEvent(“name”,”password”));
    • 接收訊息:可以有四種執行緒模型選擇

      @Subscribe(threadMode = ThreadMode.MAIN)
      public void messageEventBus(MessageEvent event){
          tv_result.setText("name:"+event.name+" passwrod:"+event.password);
      }
      
  4. 粘性事件
       之前說的使用方法,都是需要先註冊(register),再post,才能接受到事件;如果你使用postSticky傳送事件,那麼可以不需要先註冊,也能接受到事件,也就是一個延遲註冊的過程。
       普通的事件我們通過post傳送給EventBus,傳送過後之後當前已經訂閱過的方法可以收到。但是如果有些事件需要所有訂閱了該事件的方法都能執行呢?例如一個Activity,要求它管理的所有Fragment都能執行某一個事件,但是當前我只初始化了3個Fragment,如果這時候通過post傳送了事件,那麼當前的3個Fragment當然能收到。但是這個時候又初始化了2個Fragment,那麼我必須重新發送事件,這兩個Fragment才能執行到訂閱方法。
       粘性事件就是為了解決這個問題,通過 postSticky 傳送粘性事件,這個事件不會只被消費一次就消失,而是一直存在系統中,知道被 removeStickyEvent 刪除掉。那麼只要訂閱了該粘性事件的所有方法,只要被register 的時候,就會被檢測到,並且執行。訂閱的方法需要新增 sticky = true 屬性。

    • 構造傳送資訊類

      public class StickyEvent {
          public String msg;
      
          public StickyEvent(String msg) {
              this.msg = msg;
          }
      }
      
    • 釋出訊息:EventBus.getDefault().postSticky(new StickyEvent(“我是粘性事件”));
    • 接收訊息:和之前的方法一樣,只是多了一個 sticky = true 的屬性。

      @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
      public void onEvent(StickyEvent event){
          tv_c_result.setText(event.msg);
      }
      
    • 註冊

      EventBus.getDefault().register(CActivity.this);
      
      •  
    • 解註冊

      EventBus.getDefault().removeAllStickyEvents();
      EventBus.getDefault().unregister(CActivity.class);
      

四、舉個栗子

  1. 主執行緒傳送事件:

    • 自定義事件(類似定義JavaBean),包含使用者的姓名和密碼;

      public class UserEvent {
          private String name;
          private String password;
      
          public UserEvent() {
          }
      
          public UserEvent(String name, String password) {
              this.name = name;
              this.password = password;
          }
      
          public String getName() {
              return name;
          }
      
          public void setName(String name) {
              this.name = name;
          }
      
          public String getPassword() {
              return password;
          }
      
          public void setPassword(String password) {
              this.password = password;
          }
      
          @Override
          public String toString() {
              return "UserEvent{" +
                      "name='" + name + '\'' +
                      ", password='" + password + '\'' +
                      '}';
          }
      }
      
    • 在onCreate方法中註冊訂閱者,在onDestroy中解註冊。

      public class MainActivity extends AppCompatActivity {
      
          @BindView(R.id.jump)
          Button mJump;
          @BindView(R.id.send)
          Button mSend;
          @BindView(R.id.tv_result)
          TextView mTvResult;
      
          @Override
          protected void onCreate(Bundle savedInstanceState) {
              super.onCreate(savedInstanceState);
              setContentView(R.layout.activity_main);
              ButterKnife.bind(this);
              //註冊訂閱者
              EventBus.getDefault().register(this);
          }
      
          @OnClick({R.id.jump, R.id.send})
          public void onViewClicked(View view) {
              switch (view.getId()) {
                  case R.id.jump:
                      startActivity(new Intent(MainActivity.this, SecActivity.class));
                      break;
                  case R.id.send:
                      break;
              }
          }
      
          //定義處理接收的方法
          @Subscribe(threadMode = ThreadMode.MAIN)
          public void userEventBus(UserEvent userEvent){
              mTvResult.setText(userEvent.toString());
          }
      
          @Override
          protected void onDestroy() {
              super.onDestroy();
              //登出註冊
              EventBus.getDefault().unregister(this);
          }
      }
      
    • 在另一個activity中傳送事件,讓訂閱者能夠接收;

      @OnClick({R.id.sendData, R.id.receive})
      public void onViewClicked(View view) {
          switch (view.getId()) {
              case R.id.sendData:
                  //傳送事件
                  EventBus.getDefault().post(new UserEvent("Mr.sorrow", "123456"));
                  finish();
                  break;
              case R.id.receive:
                  break;
          }
      }
      
    • 實現結果:

  2. 傳送粘性事件:

    • MainActivity中傳送粘性事件;

      case R.id.send:
              EventBus.getDefault().postSticky(new MessageEvent("粘性事件", "urgent"));
              startActivity(new Intent(MainActivity.this, SecActivity.class));
              break;
      
    • SecActivity中接受註冊並處理;

      public class SecActivity extends AppCompatActivity {
          @BindView(R.id.sendData)
          Button mSendData;
          @BindView(R.id.receive)
          Button mReceive;
          @BindView(R.id.tv_receive)
          TextView mTvReceive;
      
          @Override
          protected void onCreate(@Nullable Bundle savedInstanceState) {
              super.onCreate(savedInstanceState);
              setContentView(R.layout.activity_sec);
              ButterKnife.bind(this);
          }
      
          @OnClick({R.id.sendData, R.id.receive})
          public void onViewClicked(View view) {
              switch (view.getId()) {
                  case R.id.sendData:
                      //傳送事件
                      EventBus.getDefault().post(new UserEvent("Mr.sorrow", "123456"));
                      finish();
                      break;
                  case R.id.receive:
                      //要接收時開始註冊
                      EventBus.getDefault().register(SecActivity.this);
                      break;
              }
          }
      
          //處理事件邏輯
          @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
          public void receiveEventBus(MessageEvent messageEvent) {
              mTvReceive.setText(messageEvent.toString());
          }
      
          @Override
          protected void onDestroy() {
              super.onDestroy();
              //解註冊
              EventBus.getDefault().removeAllStickyEvents();
              EventBus.getDefault().unregister(SecActivity.this);
          }
      }
      
    • 實現效果