EventBus 使用

Android课程

http://www.jianshu.com/p/acfe78296bb5
http://www.cnblogs.com/whoislcj/p/5595714.html

配置

compile 'org.greenrobot:eventbus:3.0.0'

接收消息

Activity或Fragment生命周期方法里面进行注册，页面关闭需要取消

EventBus.getDefault().register(this);//注册
EventBus.getDefault().unregister(this);//解除注册

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        EventBus.getDefault().register(this);
    }
    //接收一个String类型的消息
    @Subscribe
    public void onEvent(String msg){
        Toast.makeText(this, "msg" + msg, Toast.LENGTH_SHORT).show();
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }
}

发送消息

发送成功后会执行MainActivity里面的onEvent方法

public class SecondActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_login);
        findViewById(R.id.button).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                //发送一个String类型的消息
                EventBus.getDefault().post(new MainMessage("我是消息");
            }
        });
    }
}

发送自定义对象消息

构造一个自定义消息类

public class MainMessage{
    private String message;
    public String getMessage() {
        return message;
    }
    public void setMessage(String message) {
        this.message = message;
    }
}

发送自定义对象消息

findViewById(R.id.button).setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        MainMessage message = new MainMessage();
        message.setMessage("我是消息");
        EventBus.getDefault().post(message);
    }
});

接收自定义对象消息

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        EventBus.getDefault().register(this);
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }
    //接收自定义消息
    @Subscribe
    public void onMainMessage(MainMessage message) {
        Toast.makeText(this, "msg" + message.getMessage(), Toast.LENGTH_SHORT).show();
    }
}

@Subscribe注解

上面演示的代码都用了@Subscribe注解，该注解标识了当前方法为订阅方法，我们可以给方法设置几个属性：

1. 方法运行的线程

• ThreadMode总共四个：
  
  • NAIN：
    表示订阅方法运行在UI线程，由于UI线程不能阻塞，因此当使用MAIN的时候，订阅方法不应该耗时过长。
  • BACKGROUND
    表示订阅方法运行在后台线程，如果发送的事件线程不是UI线程，那么就使用该线程；如果发送事件的线程是UI线程，那么新建一个后台线程来调用订阅方法。
  • POSTING
    和发布者处在同一个线程
  • ASYNC
    订阅方法与发送事件始终不在同一个线程，即订阅方法始终会使用新的线程来运行。

@Subscribe(threadMode = ThreadMode.MAIN) //在ui线程执行
public void onMainMessage(MainMessage message) {
    Log.e(TAG, "msg" + message.getMessage());
}

2. 优先级

事件的优先级类似广播的优先级，优先级越高优先获得消息

@Subscribe(threadMode = ThreadMode.MAIN, priority = 100) //在ui线程执行 优先级100
public void onMainMessage(MainMessage message) {
    Log.e(TAG, "msg" + message.getMessage());
}

另外，发送有序广播可以终止广播的继续往下传递，EventBus也实现了此功能

EventBus.getDefault().cancelEventDelivery(event) ;//优先级高的订阅者可以终止事件往下传递

3. sticky 粘性事件

关于粘性事件，可以参考Android的广播机制，其中有一个粘性广播，粘性广播的意思是：

该广播发送后，会保存在内存中，如果后来有注册的Receiver与之匹配，那么该Receiver便会接收到该广播。那么粘性事件同理，在注册之前便把事件发生出去，等到注册之后便会收到最近发送的粘性事件（必须匹配）。
注意：只会接收到最近发送的一次粘性事件，之前的会接收不到。

需要注解中添加sticky = true

@Subscribe(threadMode = ThreadMode.MAIN, sticky = true) //在ui线程执行，订阅事件为粘性事件
public void onSticky(StickyEvent event) {
    Log.e(TAG, "收到粘性事件");
}

4. 代码示例

public class SecondActivity extends Activity implements View.OnClickListener {
    private static final String TAG = "SecondActivity";
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);
        Button button1 = findViewById(R.id.sendStickyMessageBtn1);
        Button button2 = findViewById(R.id.sendStickyMessageBtn2);
        Button button3 = findViewById(R.id.sendStickyMessageBtn3);
        Button button4 = findViewById(R.id.sendRegisterBtn);
        button1.setOnClickListener(this);
        button2.setOnClickListener(this);
        button3.setOnClickListener(this);
        button4.setOnClickListener(this);
    }
    @Override
    public void onClick(View v) {
        switch (v.getId()) {
            case R.id.sendStickyMessageBtn1:
                EventBus.getDefault().postSticky(new StickyEvent("粘性事件1"));
                Log.e(TAG, "发送粘性事件1...");
                break;
            case R.id.sendStickyMessageBtn2:
                EventBus.getDefault().postSticky(new StickyEvent("粘性事件2"));
                Log.e(TAG, "发送粘性事件2...");
                break;
            case R.id.sendStickyMessageBtn3:
                EventBus.getDefault().postSticky(new StickyEvent("粘性事件3"));
                Log.e(TAG, "发送粘性事件3...");
                break;
            case R.id.sendRegisterBtn:
                Log.e(TAG, "注册，接收粘性事件...");
                EventBus.getDefault().register(this);
                break;
        }
    }
    @Subscribe(sticky = true)
    public void onEvent(StickyEvent messageEvent) {
        Log.d("cylog", "接受到了来自EventBus的事件：" + messageEvent.getMessage());
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }
}

依次点击按钮，执行结果如下：