Android框架之路——EventBus的使用


一、简介

EventBus是由greenrobot 组织贡献的一个Android事件发布/订阅轻量级框架。EventBus是一个Android端优化的publish/subscribe消息总线,简化了应用程序内各组件间、组件与后台线程间的通信。比如请求网络,等网络返回时通过Handler或Broadcast通知UI,两个Fragment之间需要通过Listener通信,这些需求都可以通过EventBus实现。

官网地址:http://greenrobot.org/eventbus/
翻译:http://blog.csdn.net/poorkick/article/details/55099311
<p>

</p>

二、添加依赖

compile 'org.greenrobot:eventbus:3.0.0'

三、解锁技能

  1. EventBus的三要素

    • Event:事件,可以是任意类型的对象。
    • Subscriber:事件订阅者,在EventBus3.0之前消息处理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync,他们分别代表四种线程模型。而在EventBus3.0之后,事件处理的方法可以随便取名,但是需要添加一个注解@Subscribe,并且要指定线程模型(默认为POSTING)。
    • Publisher:事件发布者,可以在任意线程任意位置发送事件,直接调用EventBus的post(Object)方法。可以自己实例化EventBus对象,但一般使用EventBus.getDefault()就好了,根据post函数参数的类型,会自动调用订阅相应类型事件的函数。
  2. EventBus的四种线程模型(ThreadMode)

    • POSTING(默认):如果使用事件处理函数指定了线程模型为POSTING,那么该事件在哪个线程发布出来的,事件处理函数就会在这个线程中运行,也就是说发布事件和接收事件在同一个线程。在线程模型为POSTING的事件处理函数中尽量避免执行耗时操作,因为它会阻塞事件的传递,甚至有可能会引起应用程序无响应(ANR)。
    • MAIN:事件的处理会在UI线程中执行。事件处理时间不能太长,长了会ANR的。
    • BACKGROUND:如果事件是在UI线程中发布出来的,那么该事件处理函数就会在新的线程中运行,如果事件本来就是子线程中发布出来的,那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。
    • ASYNC:无论事件在哪个线程发布,该事件处理函数都会在新建的子线程中执行,同样,此事件处理函数中禁止进行UI更新操作。
  3. 使用步骤

    • 注册:EventBus.getDefault().register(this);

    • 解注册(为防止内存泄漏):EventBus.getDefault().unregister(this);

    • 构造发送消息类

        public class MessageEvent {
            public String name;
            public String password;
        
            public MessageEvent(String name, String password) {
                this.name = name;
                this.password = password;
            }
        }
      
    • 发布消息:EventBus.getDefault().post(new MessageEvent("name","password"));

    • 接收消息:可以有四种线程模型选择

        @Subscribe(threadMode = ThreadMode.MAIN)
        public void messageEventBus(MessageEvent event){
            tv_result.setText("name:"+event.name+" passwrod:"+event.password);
        }
      
  4. 粘性事件
       之前说的使用方法,都是需要先注册(register),再post,才能接受到事件;如果你使用postSticky发送事件,那么可以不需要先注册,也能接受到事件,也就是一个延迟注册的过程。
       普通的事件我们通过post发送给EventBus,发送过后之后当前已经订阅过的方法可以收到。但是如果有些事件需要所有订阅了该事件的方法都能执行呢?例如一个Activity,要求它管理的所有Fragment都能执行某一个事件,但是当前我只初始化了3个Fragment,如果这时候通过post发送了事件,那么当前的3个Fragment当然能收到。但是这个时候又初始化了2个Fragment,那么我必须重新发送事件,这两个Fragment才能执行到订阅方法。
       粘性事件就是为了解决这个问题,通过 postSticky 发送粘性事件,这个事件不会只被消费一次就消失,而是一直存在系统中,知道被 removeStickyEvent 删除掉。那么只要订阅了该粘性事件的所有方法,只要被register 的时候,就会被检测到,并且执行。订阅的方法需要添加 sticky = true 属性。

    • 构造发送信息类

        public class StickyEvent {
            public String msg;
        
            public StickyEvent(String msg) {
                this.msg = msg;
            }
        }
      
    • 发布消息:EventBus.getDefault().postSticky(new StickyEvent("我是粘性事件"));

    • 接收消息:和之前的方法一样,只是多了一个 sticky = true 的属性。

        @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
        public void onEvent(StickyEvent event){
            tv_c_result.setText(event.msg);
        }
      
    • 注册

        EventBus.getDefault().register(CActivity.this);
      
    • 解注册

        EventBus.getDefault().removeAllStickyEvents();
        EventBus.getDefault().unregister(CActivity.class);
      

四、举个栗子

  1. 主线程发送事件:

    • 自定义事件(类似定义JavaBean),包含用户的姓名和密码;

        public class UserEvent {
            private String name;
            private String password;
        
            public UserEvent() {
            }
        
            public UserEvent(String name, String password) {
                this.name = name;
                this.password = password;
            }
        
            public String getName() {
                return name;
            }
        
            public void setName(String name) {
                this.name = name;
            }
        
            public String getPassword() {
                return password;
            }
        
            public void setPassword(String password) {
                this.password = password;
            }
        
            @Override
            public String toString() {
                return "UserEvent{" +
                        "name='" + name + '\'' +
                        ", password='" + password + '\'' +
                        '}';
            }
        }
      
    • 在onCreate方法中注册订阅者,在onDestroy中解注册。

        public class MainActivity extends AppCompatActivity {
        
            @BindView(R.id.jump)
            Button mJump;
            @BindView(R.id.send)
            Button mSend;
            @BindView(R.id.tv_result)
            TextView mTvResult;
        
            @Override
            protected void onCreate(Bundle savedInstanceState) {
                super.onCreate(savedInstanceState);
                setContentView(R.layout.activity_main);
                ButterKnife.bind(this);
                //注册订阅者
                EventBus.getDefault().register(this);
            }
        
            @OnClick({R.id.jump, R.id.send})
            public void onViewClicked(View view) {
                switch (view.getId()) {
                    case R.id.jump:
                        startActivity(new Intent(MainActivity.this, SecActivity.class));
                        break;
                    case R.id.send:
                        break;
                }
            }
        
            //定义处理接收的方法
            @Subscribe(threadMode = ThreadMode.MAIN)
            public void userEventBus(UserEvent userEvent){
                mTvResult.setText(userEvent.toString());
            }
        
            @Override
            protected void onDestroy() {
                super.onDestroy();
                //注销注册
                EventBus.getDefault().unregister(this);
            }
        }
      
    • 在另一个activity中发送事件,让订阅者能够接收;

        @OnClick({R.id.sendData, R.id.receive})
        public void onViewClicked(View view) {
            switch (view.getId()) {
                case R.id.sendData:
                    //发送事件
                    EventBus.getDefault().post(new UserEvent("Mr.sorrow", "123456"));
                    finish();
                    break;
                case R.id.receive:
                    break;
            }
        }
      
    • 实现结果:

      <p>
      </p>
  2. 发送粘性事件:

    • MainActivity中发送粘性事件;

        case R.id.send:
                EventBus.getDefault().postSticky(new MessageEvent("粘性事件", "urgent"));
                startActivity(new Intent(MainActivity.this, SecActivity.class));
                break;
      
    • SecActivity中接受注册并处理;

        public class SecActivity extends AppCompatActivity {
            @BindView(R.id.sendData)
            Button mSendData;
            @BindView(R.id.receive)
            Button mReceive;
            @BindView(R.id.tv_receive)
            TextView mTvReceive;
        
            @Override
            protected void onCreate(@Nullable Bundle savedInstanceState) {
                super.onCreate(savedInstanceState);
                setContentView(R.layout.activity_sec);
                ButterKnife.bind(this);
            }
        
            @OnClick({R.id.sendData, R.id.receive})
            public void onViewClicked(View view) {
                switch (view.getId()) {
                    case R.id.sendData:
                        //发送事件
                        EventBus.getDefault().post(new UserEvent("Mr.sorrow", "123456"));
                        finish();
                        break;
                    case R.id.receive:
                        //要接收时开始注册
                        EventBus.getDefault().register(SecActivity.this);
                        break;
                }
            }
        
            //处理事件逻辑
            @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
            public void receiveEventBus(MessageEvent messageEvent) {
                mTvReceive.setText(messageEvent.toString());
            }
        
            @Override
            protected void onDestroy() {
                super.onDestroy();
                //解注册
                EventBus.getDefault().removeAllStickyEvents();
                EventBus.getDefault().unregister(SecActivity.this);
            }
        }
      
    • 实现效果

      <p>
      </p>

五、栗子下载

      源码链接

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 前言:EventBus出来已经有一段时间了,github上面也有很多开源项目中使用了EventBus。所以抽空学习...
    Kerry202阅读 1,280评论 1 2
  • EventBus 是一个Android端优化的 publish/subscribe 消息总线,简化了应用程序各个组...
    王世军Steven阅读 1,845评论 4 21
  • EventBus可以实现组件间通信,线程通信,比较方便灵活,2.x和3.0差别很多。 Android Studio...
    Sunyard_QiL阅读 782评论 0 2
  • 此去湘西,路过景区的大街,隐隐也听得商铺里传出这首歌, 不再是宋姐的歌喉,是多数人唱腔的组合,极富地方特色。继而,...
    沧海信风阅读 903评论 0 1