Android EventBus框架（一）之使用详细介绍

研发DEMO背景

最近开发项目遇到一个情景，就是在APP主页MainActivity展示列表，有收藏功能，但是点收藏的时候，需要当前用户是已经登录身份，因此当用户点击列表item收藏按钮时，如果用户没有登录，便会跳转到APP的登录页（LoginActivity），此时如果用户之前并没有用户名/密码，又会点击此页面的立即注册，跳转到注册界面（RegistActivity），那么当在注册界面用户注册成功的时候，我们需要三个操作：

1. 关闭注册界面
2. 关闭登录界面

3. 回到主页，并修改主页用户的登录状态

   操作1直接finish（）即可，要实现操作2和3的话，我们平常一般会用到发送广播和接收广播来实现，这里其实可以用EventBus来实现。

EventBus框架介绍

官方的介绍特点如下：

（1）simplifies the communication between components decouples event senders and receivers  //发布--订阅关系
（2）performs well with Activities, Fragments, and background threads avoids complex and error-prone dependencies and life cycle issues makes your code simpler  //性能比Handler更好  
（3）is fast  //更快
（4）is tiny (~50k jar)    //jar包小
（5）is proven in practice by apps with 100,000,000+ installs   //使用者广泛

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

EventBus框架中涉及四个成分

订阅者，发布者，订阅事件，事件总线
它们的关系可以用官方的图表示：

订阅者可以订阅多个事件，发送者可以发布任何事件，发布者同时也可以是订阅者。

如何使用

官方给到四个步骤（EventBus in 4 steps）：

（1）Define events://定义事件
public class MessageEvent { /* Additional fields if needed */ }

（2）Prepare subscribers//注册订阅者
Register your subscriber (in your onCreate or in a constructor):
eventBus.register(this);

（3）Declare your subscribing method://订阅事件的动作
@Subscribe
public void onEvent(AnyEventType event) {/* Do something */};

（4）Post events://发布者发送事件
eventBus.post(event);

在项目中，最主要用到的EventBus的方法有：

EventBus.getDefault().register(this);//订阅事件
EventBus.getDefault().post(object);//发布事件
EventBus.getDefault().unregister(this);//取消订阅

onEvent:使用onEvent作为订阅函数，那么该事件在哪个线程发布出来的，onEvent就会在这个线程中运行，也就是说发布事件和接收事件线程在同一个线程。
onEventMainThread:无论事件在哪个线程发布出来的，始终在UI线程中执行订阅事件的操作。
onEventBackground:无论事件在哪个线程发布出来的，始终在工作线程中执行订阅事件的操作。
onEventAsync：使用这个函数作为订阅函数，那么无论事件在哪个线程发布，都会创建新的子线程在执行onEventAsync.

下面结合上文的具体情境来具体实现

DEMO的项目目录如下：

首先在build.gradle中添加依赖：

  compile 'org.greenrobot:eventbus:3.0.0'

主页MainActivity代码如下：

public class MainActivity extends AppCompatActivity {
    private TextView tv1,tv_status;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        EventBus.getDefault().register(this);//在当前界面注册一个订阅者
        tv1=(TextView)findViewById(R.id.tv);
        tv_status=(TextView)findViewById(R.id.tv_status);
        findViewById(R.id.btn).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                Intent intent = new Intent(getApplicationContext(),
                        LoginActivity.class);
                startActivity(intent);
            }
        });
    }


    @Subscribe          //订阅事件FirstEvent
    public  void onEventMainThread(LoginSuccessdEvent event){
        String msg=event.getMsg();
        tv_status.setText("已登录，当前账号"+msg);//获取事件中传递的参数
       Toast.makeText(this, msg, Toast.LENGTH_LONG).show();
    }
    @Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);//取消注册
    }
}

登录界面LoginActivity.java：

 @Subscribe          //订阅事件FirstEvent
    public  void onEventMainThread(LoginSuccessdEvent event){
        Log.i("TAG","LoginSuccessdEvent");
        LoginActivity.this.finish();//收到订阅事件之后关闭当前界面
        Toast.makeText(this, "finish", Toast.LENGTH_LONG).show();
    }

在注册界面RegistActivity：

//发布事件
 EventBus.getDefault().post(new LoginSuccessdEvent(username));

定义一个登录成功事件类LoginSuccessdEvent .java:

public class LoginSuccessdEvent {
    private String msg;

    public LoginSuccessdEvent(String msg) {//事件传递参数
        this.msg = msg;
    }

    public String getMsg() {//取出事件参数
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}

最后实现的大概状态是：

这样就使用EventBus完成了当注册成功后，主界面的登录状态的修改和登录界面的finish。当然引入第三方框架来实现并不是最好的方法，不过可以让我们了解EventBus的用法，以及感兴趣的话，可以深入EventBus背后的事件发布–订阅的原理—

EventBus源码简单分析

DEMO下载