美文网首页
EventBus3.1使用详解(一)

EventBus3.1使用详解(一)

作者: 往事一块六毛八 | 来源:发表于2019-12-11 15:44 被阅读0次

    概述

    EventBus是一款针对Android优化的发布/订阅事件总线。主要功能是替代Intent,Handler,BroadCast在Fragment,Activity,Service,线程之间传递消息.优点是开销小,代码更优雅。以及将发送者和接收者解耦。
    官网地址跟github代码

    http://greenrobot.org/eventbus/
    https://github.com/greenrobot/EventBus

    EventBus三要素

    EventBus-Publish-Subscribe.png
    • Event事件:发布者/订阅者之间的消息传递,类型为Object。
    • Subscriber: 订阅者,接收并处理事件。
    • Publisher: 事件的发布者。

    EventBus使用三部曲

    • 开始之前请配置:
    implementation 'org.greenrobot:eventbus:3.1.1'
    
    • 第一步:自定义一个事件,类型为Object.
      例如:
    public static class MessageEvent { /* Additional fields if needed */ }
    
    • 第二步:注册Subscriber,并且声明你处理事件的方法,和处理事件方法的线程模型。
    //注册
     @Override
     public void onStart() {
         super.onStart();
         EventBus.getDefault().register(this);
     }
    //解除注册
     @Override
     public void onStop() {
         super.onStop();
         EventBus.getDefault().unregister(this);
     }
    

    声明接收/处理事件的方法,以及该方法的线程类型

    @Subscribe(threadMode = ThreadMode.MAIN)  
    public void onMessageEvent(MessageEvent event) {/* Do something */};
    

    四种线程模型(ThreadMode的取值)
    EventBus3.1有四种线程模型,分别是:

    • POSTING (默认) 表示事件处理函数的线程跟发布事件的线程在同一个线程。
    • MAIN 表示事件处理函数的线程在主线程(UI)线程,因此在这里不能进行耗时操作。
    • BACKGROUND 表示事件处理函数的线程在后台线程,因此不能进行UI操作。如果发布事件的线程是主线程(UI线程),那么事件处理函数将会开启一个后台线程,如果果发布事件的线程是在后台线程,那么事件处理函数就使用该线程。
    • ASYNC 表示无论事件发布的线程是哪一个,事件处理函数始终会新建一个子线程运行,同样不能进行UI操作。

    这里使用注解代替了2.0版本的onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync几个onEventXXX()方法

    • 第三步:发送事件
    EventBus.getDefault().post(new MessageEvent());
    

    EventBus实例:

    一:自定义事件:

    class Persons {
        private int age;
        private String name;
    
        public Persons(int age, String name) {
            this.age = age;
            this.name = name;
        }
    
        public int getAge() {
            return age;
        }
    
        public void setAge(int age) {
            this.age = age;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        @Override
        public String toString() {
            return "Persons{" +
                    "age=" + age +
                    ", name='" + name + '\'' +
                    '}';
        }
    }
    

    二:注册/解除注册,声明处理事件的方法

    public class MainActivity extends AppCompatActivity implements View.OnClickListener {
        private Button btn_skip;
        private TextView tv_content;
    
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            EventBus.getDefault().register(this);
    
            tv_content = findViewById(R.id.tv_content);
            btn_skip = findViewById(R.id.btn_skip);
            btn_skip.setOnClickListener(this);
        }
    
        @Subscribe(threadMode = ThreadMode.MAIN)
        public void onEvent(Persons persons) {
            tv_content.setText(persons.toString());
    
        }
    
        @Override
        protected void onDestroy() {
            super.onDestroy();
            EventBus.getDefault().unregister(this);
        }
    
        @Override
        public void onClick(View v) {
            switch (v.getId()) {
                case R.id.btn_skip:
                    startActivity(new Intent(this, SecondActivity.class));
                    break;
            }
    
        }
    }
    

    MainActivity对应的xml布局

    <?xml version="1.0" encoding="utf-8"?>
    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
    
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:text="这是第一个页面" />
        <TextView
            android:id="@+id/tv_content"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="15dp"
            android:layout_gravity="center"
            android:text="" />
        <Button
            android:id="@+id/btn_skip"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_marginTop="15dp"
            android:layout_gravity="center"
            android:text="跳转" />
    
    </LinearLayout>
    

    当我们跳转到SecondActivity,并在SecondActivity发送一个事件,MainActivity处理事件。
    SecondActivity代码如下:

    public class SecondActivity extends AppCompatActivity {
        private Button btn_send, btn_send_sticky;
    
        @Override
        protected void onCreate(@Nullable Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_second);
            btn_send = findViewById(R.id.btn_send);
            btn_send_sticky = findViewById(R.id.btn_send_sticky);
            btn_send.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    EventBus.getDefault().post(new Persons(18, "张三"));
                    finish();
                }
            });
            btn_send_sticky.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    EventBus.getDefault().postSticky(new Persons(19, "李四"));
                    startActivity(new Intent(SecondActivity.this, ThirdActivity.class));
                }
            });
        }
    }
    

    SecondActivity的xml布局如下

    <?xml version="1.0" encoding="utf-8"?>
    <LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:orientation="vertical">
    
        <TextView
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:text="这是第二个页面" />
    
        <TextView
            android:id="@+id/tv_content"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:layout_marginTop="15dp"
            android:text="" />
    
        <Button
            android:id="@+id/btn_send"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:layout_marginTop="15dp"
            android:text="发送消息" />
    
        <Button
            android:id="@+id/btn_send_sticky"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:layout_gravity="center"
            android:layout_marginTop="15dp"
            android:text="发送粘性消息" />
    
    </LinearLayout>
    

    当我们点击btn_send按钮发送事件:我们可以看到MainActivity页面上textView接收到了消息


    EventBus使用.gif

    EventBus粘性事件

    所谓粘性事件,就是在发送事件之后再订阅该事件也能收到该事件。请注意这里与普通事件的区别,普通事件是先注册在绑定。
    例如:我们在SecondActivity发送了个事件,在ThirdActivity中是接收不到消息的,因为ThirdActivity用于接收消息的EventBus还未完成注册,也就是发布者发了消息,但订阅者还未产生。
    此时:我们在SecondActivity发送粘性事件

      //EventBus.getDefault().postSticky()
        btn_send_sticky.setOnClickListener(new View.OnClickListener() {
                @Override
                public void onClick(View v) {
                    EventBus.getDefault().postSticky(new Persons(19, "李四"));
                    startActivity(new Intent(SecondActivity.this, ThirdActivity.class));
                }
            });
    

    在ThirdActivity处理粘性事件:

    public class ThirdActivity extends AppCompatActivity {
        private TextView tv_content;
    
        @Override
        protected void onCreate(@Nullable Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_third);
            tv_content = findViewById(R.id.tv_content);
            EventBus.getDefault().register(this);
    
        }
    
        @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
        public void onEventMsg(Persons persons) {
            Log.d("ThirdActivity", "ThirdActivity--接收到了粘性事件");
            tv_content.setText("接收到了粘性事件:" + persons.toString());
        }
    
        @Override
        protected void onDestroy() {
            super.onDestroy();
            Log.d("ThirdActivity", "ThirdActivity--onDestroy()--");
            EventBus.getDefault().unregister(this);
        }
    }
    
    EventBus粘性事件.gif

    好了基本使用就告一段路了。

    相关文章

      网友评论

          本文标题:EventBus3.1使用详解(一)

          本文链接:https://www.haomeiwen.com/subject/qgbogctx.html