EventBus-Kotlin的实例应用

EventBus原理

EventBus 是基于观察者模式,核心是事件。EventBus通过注册将所有订阅事件的方法储存在集合中,当有事件发布的时候,根据某些规则,匹配出符合条件的方法,调用执行,从而实现组件间的通信。
发布的事件相当于被观察者,注册的对象相当于观察者,被观察者和观察者是一对多的关系。当被观察者状态发生变化,即发布事件的时候,观察者对象将会得到通知并作出响应,即执行对应的方法。

EventBus三要素

1.事件(Event),是一个对象可以是任意数据类型。
2.事件订阅者(Subscriber),EventBus3.0之后,事件处理的方法可以自由命名,在使用它时需要在方法上面添加一个注解@Subscribe,并写明采用哪种线程模式,默认为POSTING。
3.事件发布者(Publisher),可以用它在任意位置发送事件,需要调用post方法实例化EventBus对象,然后根据破石头函数的参数类型,自动调用订阅这个事件的函数。

EventBus的实例应用

下面简单介绍一个发送“发表评论”事件,然后详情页面通知评论列表作出刷新响应的例子。

0.添加依赖

请参考[https://github.com/greenrobot/EventBus]

implementation 'org.greenrobot:eventbus:3.2.0'
1.自定义一个Event消息事件类
class PublishCommentEvent {
    companion object{
        fun post(){
            EventBusCompat.post(PublishCommentEvent())
        }
    }
}
2.在需要订阅事件的地方注册和注销EventBus

订阅者需要在总线中注册/注销。只有注册后,订阅者才能正常接收到事件。通常我们都在 Activity、Fragment 中订阅事件,需要在生命周期回调函数中做这步。

  • Activity:在 onCreate 中注册,在 onDestory 中注销。
//详情页面DetailActivity
//注册
Override protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    EventBus.getDefault().register(this);
}
//注销
@Override protected void onDestroy() {
    super.onDestroy();
    EventBus.getDefault().unregister(this);
}
  • Fragment:在 onCreateView 中注册,在 onDestoryView 中注销。(同上)
3.发送事件

发送事件只需要调用一个 post 方法即可。

//发表评论CommentCreateActivity
override fun addCommentSuccess(bean: NewsCommentListBean) {
        PublishCommentEvent.post()
        finish()
    }
4.处理事件

在 Activity 或 Fragment 中定义一个方法,方法名可以任意指定,参数为要接收的 Event 对象,需要加上 @Subscribe 注解。注解中可以添加线程模型、是否支持粘性事件、优先级属性。其中线程模型是必需的,默认值为 POSTING。

//详情页面DetailActivity
@Subscribe(threadMode = ThreadMode.MAIN)
    fun onPublishCommentEvent(event: PublishCommentEvent) {
    //业务逻辑
        mPage = 1
        mPresenter.getBusinessDetailCommentList(shopId, mPage)
    }
另外
5.粘性事件(StickyEvent)

普通事件必须要订阅者先注册,然后发送事件,才能被订阅者接收到。有的情况下,我们希望即使先发送事件,再注册,订阅者也能接收到。EventBus 提供了粘性事件来满足这种情形。

在发布事件时,改用 postSticky 方法来发送一个粘性事件。

EventBus.getDefault().postSticky(new StringEvent("Hello World!"));

然后在订阅者接收事件方法的 @Subscribe 注解中加上sticky=true,表示支持接收粘性事件。

@Subscribe(sticky = true, threadMode = ThreadMode.MAIN)
public void onStringEvent(StringEvent event) {   
    mTextView.setText(event.message);
}

以上。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。