AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Android EventBus 3.0.0 使用总结

2016-11-07 1047
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 转载请标明出处：http://blog.csdn.net/zhaoyanjun6/article/details/53065112 本文出自【赵彦军的博客】前言EventBus框架 EventBus是一个通用的叫法，例如Google出品的Guava，Guava是一个庞大的库，EventBus只是它附带的一个小功能，因此实际项目中使用并不多。

转载请标明出处：http://blog.csdn.net/zhaoyanjun6/article/details/53065112
本文出自【赵彦军的博客】

前言

  • EventBus框架

    EventBus是一个通用的叫法，例如Google出品的Guava，Guava是一个庞大的库，EventBus只是它附带的一个小功能，因此实际项目中使用并不多。用的最多的是greenrobot/EventBus，这个库的优点是接口简洁，集成方便，但是限定了方法名，不支持注解。另一个库square/otto修改自 Guava ，用的人也不少。所以今天我们研究的目标是greenrobot的EventBus.

  • EventBus 简介

    1、EventBus3.0.0 是最新的版本。
    2、EventBus 是Android 发布/订阅事件总线，可简化 Activities, Fragments, Threads, Services 等组件间的消息传递。
    3、可替代 Intent, Handler, BroadCast ，接口等传统方案，更快，代码更小，50K 左右的 jar 包，代码更优雅，彻底解耦。

    github地址：https://github.com/greenrobot/EventBus

EventBus原理图

这里写图片描述

如何添加依赖

  • 在module的build.gredle 文件中的dependencies标签中添加

    compile ‘org.greenrobot:eventbus:3.0.0’

    例如

 apply plugin: 'com.android.application'

android {
    compileSdkVersion 24
    buildToolsVersion "24.0.3"

    defaultConfig {
        applicationId "com.eventbus.app"
        minSdkVersion 14
        targetSdkVersion 24
        versionCode 1
        versionName "1.0"

    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'com.android.support:appcompat-v7:24.2.1'

    compile 'org.greenrobot:eventbus:3.0.0'
}

如何使用

  • 注册事件

    EventBus.getDefault().register( this );

  • 取消注册

    EventBus.getDefault().unregister( this );

  • 发送数据

    EventBus.getDefault().post( “我发射了”);

简单小例子：使用EventBus传递简单字符串

package com.eventbus.app;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Toast;

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

public class MainActivity extends AppCompatActivity {

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

        //注册
        EventBus.getDefault().register( this );


        findViewById( R.id.button).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                EventBus.getDefault().post( "我发射了");
            }
        });
    }

    /**
     *  自定义一个方法 hello() ，用来接收事件。
     *  方法名字可以随便写
     * @return
     */

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void hello ( String event){
        /* Do something */
        Toast.makeText( this , event , Toast.LENGTH_SHORT).show();
    };


    @Override
    protected void onDestroy() {
        super.onDestroy();

        //取消注册 , 防止Activity内存泄漏
        EventBus.getDefault().unregister( this );
    }
}

效果图
这里写图片描述

线程模型

在接收事件消息的方法中，可以通过注解的方式设置线程模型，EventBus内置了4中线程模型，分别是ThreadMode.POSTING 、ThreadMode.MAIN、ThreadMode.BACKGROUND、ThreadMode.ASYNC

比如：

 @Subscribe(threadMode = ThreadMode.POSTING)
    public void onMessageEventPostThread(String event) {
        Log.e( "event PostThread", "消息： " + event + "  thread: " + Thread.currentThread().getName()  );
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMessageEventMainThread(String event) {
        Log.e( "event MainThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.BACKGROUND)
    public void onMessageEventBackgroundThread(String event) {
        Log.e( "event BackgroundThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.ASYNC)
    public void onMessageEventAsync(String event) {
        Log.e( "event Async",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

  • PostThread：如果使用事件处理函数指定了线程模型为PostThread，那么该事件在哪个线程发布出来的，事件处理函数就会在这个线程中运行，也就是说发布事件和接收事件在同一个线程。在线程模型为PostThread的事件处理函数中尽量避免执行耗时操作，因为它会阻塞事件的传递，甚至有可能会引起ANR。

  • MainThread：如果使用事件处理函数指定了线程模型为MainThread，那么不论事件是在哪个线程中发布出来的，该事件处理函数都会在UI线程中执行。该方法可以用来更新UI，但是不能处理耗时操作。

  • BackgroundThread：如果使用事件处理函数指定了线程模型为BackgroundThread，那么如果事件是在UI线程中发布出来的，那么该事件处理函数就会在新的线程中运行，如果事件本来就是子线程中发布出来的，那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。

  • Async：如果使用事件处理函数指定了线程模型为Async，那么无论事件在哪个线程发布，该事件处理函数都会在新建的子线程中执行。同样，此事件处理函数中禁止进行UI更新操作。

小例子1： 在子线程发送数据

package com.eventbus.app;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.View;

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

public class MainActivity extends AppCompatActivity {

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

        //注册
        EventBus.getDefault().register( this );

        findViewById( R.id.button).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                new Thread(new Runnable() {
                    @Override
                    public void run() {
                        Log.d( "event 发射数据线程 : " , Thread.currentThread().getName() ) ;
                        EventBus.getDefault().post( "我发射了");
                    }
                }).start() ;
            }
        });
    }


    @Subscribe(threadMode = ThreadMode.POSTING)
    public void onMessageEventPostThread(String event) {
        Log.e( "event PostThread", "消息： " + event + "  thread: " + Thread.currentThread().getName()  );
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMessageEventMainThread(String event) {
        Log.e( "event MainThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.BACKGROUND)
    public void onMessageEventBackgroundThread(String event) {
        Log.e( "event BackgroundThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.ASYNC)
    public void onMessageEventAsync(String event) {
        Log.e( "event Async",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }


    @Override
    protected void onDestroy() {
        super.onDestroy();

        //取消注册 , 防止Activity内存泄漏
        EventBus.getDefault().unregister( this );
    }
}

运行结果：

D/event 发射数据线程 :: Thread-109
E/event BackgroundThread: 消息： 我发射了 thread: Thread-109
E/event PostThread: 消息： 我发射了 thread: Thread-109
E/event Async: 消息： 我发射了 thread: pool-1-thread-2
E/event MainThread: 消息： 我发射了 thread: main

小例子2： 在主线程发送数据

package com.eventbus.app;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.View;

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

public class MainActivity extends AppCompatActivity {

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

        //注册
        EventBus.getDefault().register( this );

        findViewById( R.id.button).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Log.d( "event 发射数据线程 : " , Thread.currentThread().getName() ) ;
                EventBus.getDefault().post( "我发射了");
            }
        });
    }

    @Subscribe(threadMode = ThreadMode.POSTING)
    public void onMessageEventPostThread(String event) {
        Log.e( "event PostThread", "消息： " + event + "  thread: " + Thread.currentThread().getName()  );
    }

    @Subscribe(threadMode = ThreadMode.MAIN)
    public void onMessageEventMainThread(String event) {
        Log.e( "event MainThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.BACKGROUND)
    public void onMessageEventBackgroundThread(String event) {
        Log.e( "event BackgroundThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Subscribe(threadMode = ThreadMode.ASYNC)
    public void onMessageEventAsync(String event) {
        Log.e( "event Async",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }


    @Override
    protected void onDestroy() {
        super.onDestroy();

        //取消注册 , 防止Activity内存泄漏
        EventBus.getDefault().unregister( this );
    }
}

运行结果：

D/event 发射数据线程 :: main
E/event MainThread: 消息： 我发射了 thread: main
E/event PostThread: 消息： 我发射了 thread: main
E/event Async: 消息： 我发射了 thread: pool-1-thread-3
E/event BackgroundThread: 消息： 我发射了 thread: pool-1-thread-4

黏性事件

除了上面讲的普通事件外，EventBus还支持发送黏性事件。何为黏性事件呢？简单讲，就是在发送事件之后再订阅该事件也能收到该事件，跟黏性广播类似。具体用法如下：

  • 注册

    EventBus.getDefault().register( this );

  • 事件接收

    @Subscribe(threadMode = ThreadMode.MAIN , sticky = true )
    public void onMessageEventMainThread(String event) {
    Log.e( “event MainThread”, “消息： ” + event + ” thread: ” + > Thread.currentThread().getName());
    }

  • 取消注册

    EventBus.getDefault().unregister( this ) ;

  • 发送事件

    EventBus.getDefault().postSticky( “我发射了”);

小例子：在MainActivity发送事件，在Activity2里注册并且接收事件

MainActivity源码

package com.eventbus.app;

import android.content.Intent;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.View;

import org.greenrobot.eventbus.EventBus;

public class MainActivity extends AppCompatActivity {

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

        findViewById( R.id.button).setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Log.d( "event 发射数据线程 : " , Thread.currentThread().getName() ) ;
                EventBus.getDefault().postSticky( "我发射了");

                startActivity( new Intent( MainActivity.this , Activity2.class ));
            }
        });
    }
}

Activity2源码

package com.eventbus.app;

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;

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

public class Activity2 extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_2);
        //注册
        EventBus.getDefault().register( this );
    }

    @Subscribe(threadMode = ThreadMode.MAIN  , sticky =  true )
    public void onMessageEventMainThread(String event) {
        Log.e( "event MainThread",  "消息： " + event + "  thread: " + Thread.currentThread().getName());
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        //取消注册 , 防止Activity内存泄漏
        EventBus.getDefault().unregister( this ) ;
    }
}

这就是粘性事件，能够收到订阅之前发送的消息。但是它只能收到最新的一次消息，比如说在未订阅之前已经发送了多条黏性消息了，然后再订阅只能收到最近的一条消息。

EventBus源码分析

  • Subscribe 接口源码
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Subscribe {
    ThreadMode threadMode() default ThreadMode.POSTING;

    /**
     * If true, delivers the most recent sticky event (posted with
     * {@link EventBus#postSticky(Object)}) to this subscriber (if event available).
     */
    boolean sticky() default false;

    /** Subscriber priority to influence the order of event delivery.
     * Within the same delivery thread ({@link ThreadMode}), higher priority subscribers will receive events before
     * others with a lower priority. The default priority is 0. Note: the priority does *NOT* affect the order of
     * delivery among subscribers with different {@link ThreadMode}s! */
    int priority() default 0;
}

可以看出默认的线程模型是ThreadMode.POSTING ；默认黏性事件为false,也就是默认不开启黏性事件；默认的优选级为0 。

  • EventBus 类部分源码
  static volatile EventBus defaultInstance;

   /** Convenience singleton for apps using a process-wide EventBus instance. */
    public static EventBus getDefault() {
        if (defaultInstance == null) {
            synchronized (EventBus.class) {
                if (defaultInstance == null) {
                    defaultInstance = new EventBus();
                }
            }
        }
        return defaultInstance;
    }

getDefault() 是一个单例模式 , 只有一个实例对象。

  • ThreadMode 类源码
public enum ThreadMode {

    /**
     * Subscriber will be called in the same thread, which is posting the event. This is the default. Event delivery
     * implies the least overhead because it avoids thread switching completely. Thus this is the recommended mode for
     * simple tasks that are known to complete is a very short time without requiring the main thread. Event handlers
     * using this mode must return quickly to avoid blocking the posting thread, which may be the main thread.
     */

    POSTING,

    /**
     * Subscriber will be called in Android's main thread (sometimes referred to as UI thread). If the posting thread is
     * the main thread, event handler methods will be called directly. Event handlers using this mode must return
     * quickly to avoid blocking the main thread.
     */

    MAIN,

    /**
     * Subscriber will be called in a background thread. If posting thread is not the main thread, event handler methods
     * will be called directly in the posting thread. If the posting thread is the main thread, EventBus uses a single
     * background thread, that will deliver all its events sequentially. Event handlers using this mode should try to
     * return quickly to avoid blocking the background thread.
     */

    BACKGROUND,

    /**
     * Event handler methods are called in a separate thread. This is always independent from the posting thread and the
     * main thread. Posting events never wait for event handler methods using this mode. Event handler methods should
     * use this mode if their execution might take some time, e.g. for network access. Avoid triggering a large number
     * of long running asynchronous handler methods at the same time to limit the number of concurrent threads. EventBus
     * uses a thread pool to efficiently reuse threads from completed asynchronous event handler notifications.
     */

    ASYNC
}

这个类是枚举类，定义了线程模型中的几种类型。

个人公众号，欢迎关注

这里写图片描述

参考资料

【EventBus 3.0的用法详解】
【EventBus使用详解】
【腾讯Bugly干货】老司机教你“飙”EventBus3】

文章标签：
Android开发
关键词：
Android EventBus
Android总结
赵彦军521
目录
相关文章
聚优云惠
|
存储 缓存 前端开发
关于Android SurfaceView截屏总结
关于Android SurfaceView截屏总结
聚优云惠
1662 0
游客3u52v363zu2bg
|
移动开发 编解码 监控
mmkv跨进程，Android开发经验的有效总结，系列篇
mmkv跨进程，Android开发经验的有效总结，系列篇
游客3u52v363zu2bg
888 0
彭旭锐
|
编解码 Android开发
Android | 老生常谈！屏幕适配原理 & 方案总结笔记
Android | 老生常谈！屏幕适配原理 & 方案总结笔记
彭旭锐
569 0
Android | 老生常谈！屏幕适配原理 & 方案总结笔记
tinyvvampirepudge
|
开发工具 Android开发
Android推送集成方案总结
刚做完推送集成方案，记录下坑。 这里记录的特性和使用时针对写blog时采用的sdk的，具体使用流程和限制还请参考官方给出的sdk. #### 1、推送规则 小米手机用小米推送； 华为手机用华为推送； 其他手机用友盟推送。
tinyvvampirepudge
359 0
技术小达人
|
存储 前端开发 数据管理
淘宝安卓端搜索架构升级总结
推荐语：这篇文章图文并茂地介绍了淘宝搜索滚动容器的技术演进过程，结合代码讲解页面结构划分、数据处理、交互效果，还包含了对逻辑抽象、功能拓展的思考，最后总结了可复用的架构。非常具有实践意义，推荐阅读学习！ ——大淘宝技术终端开发工程师 门柳
技术小达人
352 0
淘宝安卓端搜索架构升级总结
彭旭锐
|
Java Android开发 Kotlin
Android | 这是一份详细的 EventBus 使用教程 | 牛气冲天新年征文
Android | 这是一份详细的 EventBus 使用教程 | 牛气冲天新年征文
彭旭锐
836 0
Android | 这是一份详细的 EventBus 使用教程 | 牛气冲天新年征文
1016743651376594
|
缓存 Java Android开发
Android EventBus的使用
Android EventBus的使用
1016743651376594
194 0
不良使
|
Android开发 容器
猿创征文｜Android常用知识总结
猿创征文｜Android常用知识总结
不良使
220 0
猿创征文｜Android常用知识总结
starry陆离
|
Android开发
Android基础入门：EventBus实现总线数据分发
我们之前学习了Activity-》Activity中的数据传送，是通过intent.putExtra()方法实现的，如果要实现Activity-》Fragment或者Fragment-》Fragment都是不方便的，通过EventBus能很好的解决这个问题
starry陆离
204 0
岛哥手记
|
测试技术 Android开发
Android获取启动页面Activity方法总结
我们在做Android自动化测试过程中，经常会需要获取应用的启动Activity页面信息，那么今天就来跟大家分享一下有哪些获取应用启动Activity页面信息的方法。
岛哥手记
1003 0
Android获取启动页面Activity方法总结

热门文章

最新文章

  • 1
    Android 11 中的存储机制更新
  • 2
    《Android游戏开发详解》——第1章，第1.1节什么是编程
  • 3
    android处理拍照旋转问题及带来的对内存占用
  • 4
    Android Sqlite数据库版本升级管理初探
  • 5
    离线安装Eclipse的Android ADT开发插件
  • 6
    Android——Fragment介绍
  • 7
    android使用Activity
  • 8
    Android开发1——查找所需要出示权限的内容
  • 9
    实现一个用于显示当前时间的Google Android 窗口小部件（AppWidget）
  • 10
    Android学习之四大组件（四）——BroadcastReceiver
  • 1
    Android使用ViewPager实现图片轮播系列之三：手动滑动 + 左右箭头(1)
    65
  • 2
    构建高效Android应用：探究Kotlin协程的优势与实践
    49
  • 3
    构建高效Android应用：Kotlin与协程的完美结合
    38
  • 4
    Android自定义View：MeasureSpec的真正意义与View大小控制
    46
  • 5
    Android中的多线程及AsyncTask的引入，最终入职阿里
    58
  • 6
    Android 11 中的存储机制更新，面试心得体会
    90
  • 7
    真的强！借助阿里技术博主分享的Android面试笔记，我拿到了字节跳动的offer
    61
  • 8
    对标腾讯T9架构师的 Android 面试题新鲜出炉，算法真的太重要了
    52
  • 9
    webRTC（十五），2024最新Android中级面试题目汇总解答
    99
  • 10
    Android 开发网易面试凉凉经，面试官：基础不牢，彻底帮你搞懂
    54

    • 相关课程

    更多
  • 开源Android容器化框架Atlas开发者指南

    • 相关电子书

    更多
  • 58同城Android客户端Walle框架演进与实践之路
  • Android组件化实现
  • 蚂蚁聚宝Android秒级编译——Freeline
    • 下一篇
    阿里云OSS设置跨域访问