Android框架之路——EventBus的使用

一、簡介

EventBus是由greenrobot 組織貢獻的一個Android事件發佈/訂閱輕量級框架。EventBus是一個Android端優化的publish/subscribe消息總線,簡化了應用程序內各組件間、組件與後臺線程間的通信。比如請求網絡,等網絡返回時通過Handler或Broadcast通知UI,兩個Fragment之間需要通過Listener通信,這些需求都可以通過EventBus實現。

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

</p>

 

二、添加依賴

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函數參數的類型,會自動調用訂閱相應類型事件的函數。

  • EventBus的四種線程模型(ThreadMode)

    • POSTING(默認):如果使用事件處理函數指定了線程模型爲POSTING,那麼該事件在哪個線程發佈出來的,事件處理函數就會在這個線程中運行,也就是說發佈事件和接收事件在同一個線程。在線程模型爲POSTING的事件處理函數中儘量避免執行耗時操作,因爲它會阻塞事件的傳遞,甚至有可能會引起應用程序無響應(ANR)。

    • MAIN:事件的處理會在UI線程中執行。事件處理時間不能太長,長了會ANR的。

    • BACKGROUND:如果事件是在UI線程中發佈出來的,那麼該事件處理函數就會在新的線程中運行,如果事件本來就是子線程中發佈出來的,那麼該事件處理函數直接在發佈事件的線程中執行。在此事件處理函數中禁止進行UI更新操作。

    • ASYNC:無論事件在哪個線程發佈,該事件處理函數都會在新建的子線程中執行,同樣,此事件處理函數中禁止進行UI更新操作。

  • 使用步驟

    • 註冊: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);
        }
  • 粘性事件
       之前說的使用方法,都是需要先註冊(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;
            }
        }
    • 實現結果:

       

      <p>

      </p>

  • 發送粘性事件:

    • 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);
            }
        }
    • 實現效果

       

      <p>

      </p>


    發表評論
    所有評論
    還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
    相關文章