EventBus源码详解（一）：基本使用

写在前面

对于Android程序员来说，相信大家都听过EventBus的大名。EventBus是一个Android平台上基于事件发布和订阅的轻量级框架，可以对发布者和订阅者解耦，并简化Android的事件传递。正如官方介绍其优势：

• 简化了组件之间的通信
  
  • 解耦事件的发送者和接收者
  • 在Activity、Fragment和后台线程表现良好
  • 避免复杂和易出错的依赖性和生命周期问题
• 使你的代码更加简洁
• 快速和轻量

接下来，让我们一起从EventBus的使用到源码解读，全方位地解读这个轻量但功能强大的开源框架。

EventBus项目：EventBus GitHub

---

正文

本文先从EventBus的简单使用开始，先介绍EventBus的基本配置和简单使用，然后用一个Demo来举例EventBus的使用及其优势。

配置和简单使用

在app下的build.gradle配置：

compile 'org.greenrobot:eventbus:3.0.0'

是的，就添加这句就可以了，非常简单。当然还可以配置生成索引，这部分在进阶使用文章里介绍。

定义一个事件类：

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

在订阅者类中定义一个用注解“@Subscribe”标记并参数为事件类的方法：

@Subscribe
public void onMessageEvent(MessageEvent event) {/* Do something */};

然后在订阅者类中注册和注销，在Android上，通常在Activity或Fragment的生命周期里处理：

@Override
 public void onStart() {
     super.onStart();
     EventBus.getDefault().register(this); // 注册
 }

 @Override
 public void onStop() {
     super.onStop();
     EventBus.getDefault().unregister(this); // 注销，当订阅者不再订阅事件时，必须注销，否则可能发生内存泄漏
 }

最后，发送事件，每个订阅者注册的事件都将收到消息（会调用“@Subscribe”标记的方法）：

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

举例

现在来举个栗子来展示EventBus的魅力！想想一个阅读App看书的场景：左边是书籍选择列表，右边是书籍的内容。这时我们大多数情况都是用Fragment来处理，也即左右两边都是Fragment，这就涉及两个Fragment的通信问题。我们通常的处理方式是在Fragment添加接口回调，然后Activitty作为两个Fragment的通信桥梁。

或许有人说直接在Activity获取Fragment里的控件，交互更加简单。这样虽然简单，但Activity的职责变得很重，而Fragment的作用之一就是分担Activity的职责，所以这是不可取的。

好，我们先来看不用EventBus时用回调的方式来实现Fragment的通信的例子。

首先先定义两个Fragment，左边的Fragment1，布局只有一个ListView（布局代码不贴，后面有源码），在Fragment1里定义一个接口，当点击ListView的item时，就把所点击的书籍回调给外部：

public class Fragment1 extends Fragment {

    private final static String[] BOOKS = new String[] {
            "第一行代码",
            "Java编程思想",
            "Android开发艺术探索",
            "Android源码设计模式",
            "算法",
            "研磨设计模式"
    };

    ListView listView;

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container,
                             @Nullable Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment1, container, false);
        listView = (ListView) view.findViewById(R.id.lv_catalogue);
        ArrayAdapter arrayAdapter = new ArrayAdapter<String>(getActivity(),
                android.R.layout.simple_list_item_1, BOOKS);
        listView.setAdapter(arrayAdapter);
        listView.setOnItemClickListener(new AdapterView.OnItemClickListener() {
            @Override
            public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
                // 回调
                if (listener != null) {
                    listener.onCLickBook(BOOKS[position]);
                }
            }
        });
        return view;
    }

    private OnClickBookListener listener;

    public void setOnClickBookListener(OnClickBookListener listener) {
        this.listener = listener;
    }

    /**
     * 点击书籍监听接口
     */
    public interface OnClickBookListener {
        void onCLickBook(String book);
    }
}

右边的Fragment2就更加简单了，布局只有一个TextView来展示书籍的内容:

public class Fragment2 extends Fragment {

    TextView textView;

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment2, container, false);
        textView = (TextView) view.findViewById(R.id.tv_content);
        return view;
    }

    /**
     * 需要暴露接口给外部来交互
     */
    public void readBook(String book) {
        textView.setText(book);
    }
}

最后，MainActivity作为两个Fragment的通信桥梁，来实现两个Fragment的通信：

public class MainActivity extends AppCompatActivity {

    Fragment1 fragment1;
    Fragment2 fragment2;

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

        fragment1 = (Fragment1) getSupportFragmentManager().findFragmentById(R.id.fragment1);
        // 设置监听
        fragment1.setOnClickBookListener(new Fragment1.OnClickBookListener() {
            @Override
            public void onCLickBook(String book) {
                // 更新fragment2的阅读书籍
                fragment2.readBook(String.format("我正在阅读%s", book));
            }
        });
        fragment2 = (Fragment2) getSupportFragmentManager().findFragmentById(R.id.fragment2);
    }
}

从上面代码可以看到，两个Fragment的通信也非常简单，而Activity的职责也明显降低，只需作为桥梁，那么我们还有必要用EventBus吗？答案是有必要的！这只是一个例子，而实际开发中两个Fragment通信交互几乎不可能这么简单，往往是纵横交错的，这时难道在Fragment上定义多个监听接口，然后在Activity上处理这些逻辑？这就又导致了Activity职责过大，而耦合度也显著增加了。所以，使用回调的通信方式似乎适合交互较少的两个Fragment，但一旦交互过多，就无能为力了。下面再来看看EventBus怎么实现Fragment的通信。

首先，先定义一个阅读书籍的事件类（注意，最好用public修饰，否则有可能在生成索引时失败，这些内容在后续文章会讲解，现在先记着）：

public class ReadBookEvent {

    private String book;

    ReadBookEvent(String book) {
        this.book = book;
    }

    public String getBook() {
        return book;
    }
}

显然，因为Fragment2是监听Fragment1的点击事件作出更新响应，所以，这里Fragment2是订阅者（注意：与事件类一样，订阅者最好声明为public，否则有可能在生成索引失败）：

public class Fragment2 extends Fragment {

    TextView textView;

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment2, container, false);
        textView = (TextView) view.findViewById(R.id.tv_content);
        return view;
    }

    @Override
    public void onStart() {
        super.onStart();
        EventBus.getDefault().register(this); // 注册订阅者
    }

    @Override
    public void onStop() {
        super.onStop();
        EventBus.getDefault().unregister(this); 注销订阅者
    }

    /**
     * 监听阅读事件
     */
    @Subscribe
    public void onReadBook(ReadBookEvent event) {
        textView.setText(String.format("我正在阅读%s", event.getBook()));
    }
}

而Fragment1不用定义回调接口了，只需在点击书籍时发送事件：

public class Fragment1 extends Fragment {

    private final static String[] BOOKS = new String[] {
            "第一行代码",
            "Java编程思想",
            "Android开发艺术探索",
            "Android源码设计模式",
            "算法",
            "研磨设计模式"
    };

    ListView listView;

    @Nullable
    @Override
    public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container,
                             @Nullable Bundle savedInstanceState) {
        View view = inflater.inflate(R.layout.fragment1, container, false);
        listView = (ListView) view.findViewById(R.id.lv_catalogue);
        ArrayAdapter arrayAdapter = new ArrayAdapter<String>(getActivity(),
                android.R.layout.simple_list_item_1, BOOKS);
        listView.setAdapter(arrayAdapter);
        listView.setOnItemClickListener(new AdapterView.OnItemClickListener() {
            @Override
            public void onItemClick(AdapterView<?> parent, View view, int position, long id) {
                EventBus.getDefault().post(new ReadBookEvent(BOOKS[position])); // 发送事件
            }
        });
        return view;
    }
}

另外在MainActivity里，不用再处理Fragment的交互了，甚至不用创建Fragment的实例，直接解耦：

public class MainActivity extends AppCompatActivity {

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

从上面代码可以看到，EventBus很好地使两个Fragment解耦，并优雅地实现了两者的通信，同时也减少了Fragment和Activity的耦合，真正的一举多得！再想想两个Activity之间的通信，我们通常使用Intent作为载体，来传递数据，使用EventBus就可以抛开Intent了，直接实现Activity间的通信！这里就不再举例了，相信聪明的你能举一反三。

至此，相信大家对EventBus有了基础的认知了。

---

写在最后

EventBus所带来的便利和简洁有没有使你震惊？！别满足的太早，EventBus如此受人待见，当然有她的厉害之处。后续文章将会介绍使用编译期处理生成索引来提升事件发送的效率，还有EventBus的高级配置，敬请期待！

---

demo