Android EventBus 的基本使用（一）

1.简介

下一篇：Android EventBus 的基本封装（二）
https://www.jianshu.com/p/199d8e376dd3

EventBus是一种用于Android的事件发布-订阅总线，由GreenRobot开发，Gihub地址是：EventBus。它简化了应用程序内各个组件之间进行通信的复杂度，尤其是碎片之间进行通信的问题，可以避免由于使用广播通信而带来的诸多不便。

1.1 三个角色

Event：事件，它可以是任意类型，EventBus会根据事件类型进行全局的通知。
Subscriber：事件订阅者，在EventBus 3.0之前我们必须定义以onEvent开头的那几个方法，分别是onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，而在3.0之后事件处理的方法名可以随意取，不过需要加上注解@subscribe，并且指定线程模型，默认是POSTING。
Publisher：事件的发布者，可以在任意线程里发布事件。一般情况下，使用EventBus.getDefault()就可以得到一个EventBus对象，然后再调用post(Object)方法即可。

1.2 四种线程模型

EventBus3.0有四种线程模型，分别是：

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

2、EventBus 使用

2.1 引入依赖

（1）在使用之前先要引入如下依赖：

implementation 'org.greenrobot:eventbus:3.1.1'

（2）注册事件：

  @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //注册
        EventBus.getDefault().register(this);
        init();
    }

（3）反注册事件：

@Override
    protected void onDestroy() {
        super.onDestroy();
        //反注册
        if(EventBus.getDefault().isRegistered(this)) {
            EventBus.getDefault().unregister(this);
        }
    }

（4）接受并处理事件：

@Subscribe(threadMode = ThreadMode.MAIN)
public void XXX(MessageEvent messageEvent) {
    ...
}

处理消息的方法名字可以随便取。但是需要加一个注解@Subscribe，并且要指定线程模型。

（5）在另外一个类或 Activity 中发送事件消息：

 EventBus.getDefault().post(new MessageEvent("中国必将能够崛起！"));

2.2 定义事件

我们定义一个事件的封装对象。在程序内部就使用该对象作为通信的信息：

public class MessageWrap {

    public final String message;

    public static MessageWrap getInstance(String message) {
        return new MessageWrap(message);
    }

    private MessageWrap(String message) {
        this.message = message;
    }
}

2.3 定义一个发布事件

MainActivity是注册一个事件接受者：

public class MainActivity extends AppCompatActivity {

    private Button button1;
    private TextView tv1;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //注册
        EventBus.getDefault().register(this);
        init();
    }

    private void init() {

        button1 = findViewById(R.id.button1);
        tv1 = findViewById(R.id.tv1);

        //点击事件
        button1.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
               TwoActivity.launch(MainActivity.this);
            }
        });
    }


    /**
     * 主线程接受消息
     * @param messageEvent
     */
    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onEvent(MessageEvent messageEvent) {


        tv1.setText(messageEvent.getMessage());
        Toast.makeText(this,messageEvent.getMessage(),Toast.LENGTH_SHORT).show();
    }


    @Override
    protected void onDestroy() {
        super.onDestroy();
        //反注册
        if(EventBus.getDefault().isRegistered(this)) {
            EventBus.getDefault().unregister(this);
        }
    }
}

TwoActivity 是一个事件发布者：

public class TwoActivity extends Activity {
    private Button button1;
    private Button button2;
    private TextView tv1;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_two);
        button1 = findViewById(R.id.button1);
        button2 = findViewById(R.id.button2);
        tv1 = findViewById(R.id.tv1);


        init();
    }

    private void init() {
        button1.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getDefault().post(new MessageEvent("中国必将能够崛起！"));
                finish();
            }
        });



    public static void launch(Context mContext) {
        Intent intent = new Intent(mContext,TwoActivity.class);
        mContext.startActivity(intent);
    }
}

3.总结：

发送消息前，一定要先注册和定义接受消息的方法类（ @Subscribe）；
所有注册过和写过接受消息的方法类（ @Subscribe），都会被调用；
多处使用时，可以根据消息类型，来筛选我们需要的消息；