EventBus 3.0接入问题

2016-11-23 本文已影响1006人爱吃豆腐面

在开发过程中，为了避免页面之间的数据层层传递，很容易就想到使用订阅/发布的形式来传递数据，有一个出名开源库就是做这类事情的 ~
地址：https://github.com/greenrobot/EventBus

那么如何在自己的项目中集成这个库呢？在上面给出的链接中，官方给出了集成的步骤，为了方便说明，直接贴过来：

EventBus in 3 steps

Define events:

public static class MessageEvent { /* Additional fields if needed */ }

Prepare subscribers: Declare and annotate your subscribing method, optionally specify a thread mode:

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

Register and unregister your subscriber. For example on Android, activities and fragments should usually register according to their life cycle:

@Overridepublic
 void onStart() {
      super.onStart();
      EventBus.getDefault().register(this);
}
@Overridepublic
 void onStop() { 
       super.onStop();
       EventBus.getDefault().unregister(this);
}

Post events:

EventBus.getDefault().post(new MessageEvent());

看完这个步骤，那么开始着手写一个样例，样例是这样的：
有三个页面，第一个页面点击一个按钮进入到第二个页面，第二个页面点击一个按钮进入到第三个页面，第三个页面点击一个按钮发出消息，第一个页面和第二个页面接收消息并展示出来，如下图

Paste_Image.png

下面开始编写代码，也很简单：
FirstActivity.java

package com.vip.veblonwang.eventbus;

import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.greenrobot.eventbus.ThreadMode;

public class FirstActivity extends Activity {

    private TextView tvMsg;
    private Button btnGoNext;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_first);

        tvMsg = (TextView) findViewById(R.id.tvMsg);
        btnGoNext = (Button) findViewById(R.id.btnGoNext);

        btnGoNext.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Intent intent = new Intent(FirstActivity.this, SecondActivity.class);
                startActivity(intent);
            }
        });

    }

    @Override
    protected void onStart() {
        super.onStart();
        EventBus.getDefault().register(this);
    }

    @Override
    protected void onStop() {
        super.onStop();
        EventBus.getDefault().unregister(this);
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMessageEvent(SendMsgEvent event) {
        final String msg = event.getMsg();
        tvMsg.setText(msg);
    }
}

activity_first.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/activity_main"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:orientation="vertical">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="页面一" />

    <Button
        android:id="@+id/btnGoNext"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="下一个页面"/>

    <TextView
        android:id="@+id/tvMsg"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!" />
</LinearLayout>

SecondActivity.java

package com.vip.veblonwang.eventbus;

import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import org.greenrobot.eventbus.EventBus;
import org.greenrobot.eventbus.Subscribe;
import org.greenrobot.eventbus.ThreadMode;

public class SecondActivity extends Activity {

    private TextView tvMsg;
    private Button btnGoNext;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);

        tvMsg = (TextView) findViewById(R.id.tvMsg);
        btnGoNext = (Button) findViewById(R.id.btnGoNext);

        btnGoNext.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Intent intent = new Intent(SecondActivity.this, ThirdActivity.class);
                startActivity(intent);
            }
        });

    }

    @Override
    protected void onStart() {
        super.onStart();
        EventBus.getDefault().register(this);
    }

    @Override
    protected void onStop() {
        super.onStop();
        EventBus.getDefault().unregister(this);
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMessageEvent(SendMsgEvent event) {
        String msg = event.getMsg();
        tvMsg.setText(msg);
    }

}

activity_second.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/activity_main"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:orientation="vertical">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="页面二" />

    <Button
        android:id="@+id/btnGoNext"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="下一个页面"/>

    <TextView
        android:id="@+id/tvMsg"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!" />
</LinearLayout>

ThirdActivity.java

package com.vip.veblonwang.eventbus;

import android.app.Activity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;

import org.greenrobot.eventbus.EventBus;

public class ThirdActivity extends Activity {

    private Button btnSendMsg;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_third);

        btnSendMsg = (Button) findViewById(R.id.btnSendMsg);
        btnSendMsg.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getDefault().post(new SendMsgEvent("三千弱水，不饮一瓢！"));
            }
        });
    }
}

activity_third.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/activity_main"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    android:orientation="vertical">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="第三个页面" />

    <Button
        android:id="@+id/btnSendMsg"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:text="发消息"/>
</LinearLayout>

到目前为止，三个页面都写完了，可以发现，官方定义的步骤在上面的代码中都已经体现出来了，除了第一步，自己定义一个Event类(Define events)
SendMsgEvent.java

package com.vip.veblonwang.eventbus;

public class SendMsgEvent {

    private String msg;

    public SendMsgEvent(String msg) {
        this.msg = msg;
    }

    public String getMsg() {
        return msg;
    }
}

按照要求都做完了，接下来可以满心欢喜地运行demo来看结果 ~~

demo的主页面是页面一，点击按钮后进入到页面二，在页面二点击按钮进入到第三个页面，在第三个页面点击发消息后，一切正常。
关键的时刻到了，如果点击返回键，会回到页面二，页面一，按照预计，页面二和页面一会展示出页面三发出的消息。
可是，当你点击返回的时候，看到的并非这样，消息发出去了，但页面一和页面二并没有接收到消息。

为什么会这样呢？
仔细分析一下代码，找到了问题所在，当页面一进入到页面二时，页面一变不可见，其生命周期会调用onStop()方法，而在onStop()方法里，我们注销了对消息事件的监听（调用了EventBus.getDefault().unregister(this);），页面二进入到页面三时，也是一样。所以在页面三里发消息，他们是接收不到的。

如何解决呢？
我们期望在页面变成不可见时，不要注销掉eventbus，把注销代码写在生命周期的onStop()事件中。在页面一和页面二里删除onStart()方法，加上下面代码。

@Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }

修改完成后，再次运行demo，结果还是出人意料 ~
页面三发完消息点击返回时，程序无异常却重启了，查找日志却只看见I/Process: Sending signal. PID: 16048 SIG: 9
what the fuck !~ 什么情况？继续排查问题出在什么地方 ~

在接收消息的方法里加入Toast提示：

@Subscribe(threadMode = ThreadMode.MAIN)
    public void onMessageEvent(SendMsgEvent event) {
        final String msg = event.getMsg();
        tvMsg.setText(msg);
        Toast.makeText(this, event.getMsg(), Toast.LENGTH_SHORT).show();
    }

再次运行demo，在页面三点击发消息时，页面一和页面二确实收到了消息（因为有Toast弹出），但是当从页面三返回到页面二时就重启了应用。
好的，那么问题出在了页面二由不可见到可见这一个过程当中。
这个过程中会执行onRestart()-->onStart()-->onResume()，而这三个方法中我们只重写了一个onStart()，并且里面只有一句话，那就是注册eventbus。难道说是一个页面不能在未注销eventbus时再注册一次eventbus?
如果是这样，那么eventbus的注册事件就不能写在onStart()里，而应该写在onCreate()里。

为了验证这个想法，我们把eventbus注册代码写到onCreate()方法里，再次运行demo，一切顺利~~~

写了这么多，其实是想说，应该把注册写在onCreate()里，注销写在onDestory()里，不要被官方文档给骗了~

EventBus 3.0接入问题

猜你喜欢

热点阅读