RxBus

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 343)

:bus: The RxBus as steady as an old dog.

RxBus Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![logo][logo]

[![rb][rbsvg]][rb] [![License][licensesvg]][license]

## Download

Gradle:
```groovy
implementation "com.blankj:rxbus:1.6"
```

## How to use

### 非粘性事件
1. 注册事件
  ```java
  public class YourActivity extends Activity {
      @Override
      protected void onCreate(Bundle savedInstanceState) {
          super.onCreate(savedInstanceState);
          setContentView(R.layout.activity_main);

// 注册 String 类型事件
          RxBus.getDefault().subscribe(this, new RxBus.Callback<String>() {
              @Override
              public void onEvent(String s) {
                  Log.e("eventTag", s);
              }
          });

// 注册带 tag 为 "my tag" 的 String 类型事件
          RxBus.getDefault().subscribe(this, "my tag", new RxBus.Callback<String>() {
              @Override
              public void onEvent(String s) {
                  Log.e("eventTag", s);
              }
          });
      }

@Override
      protected void onDestroy() {
          super.onDestroy();
          // 注销
          RxBus.getDefault().unregister(this);
      }
  }
  ```
2. 发送事件
  ```java
  // 发送 String 类型事件
  RxBus.getDefault().post("without tag");

// 发送带 tag 为 "my tag" 的 String 类型事件
  RxBus.getDefault().post("with tag", "my tag");
  ```

### 粘性事件（也就是先发送事件，在之后注册的时候便会收到之前发送的事件）
1. 发送事件
  ```java
  // 发送 String 类型的粘性事件
  RxBus.getDefault().postSticky("without tag");

// 发送带 tag 为 "my tag" 的 String 类型的粘性事件
  RxBus.getDefault().postSticky("with tag", "my tag");

// 在需要移除粘性事件的地方移除它
  RxBus.getDefault().removeSticky("without tag");
  RxBus.getDefault().removeSticky("with tag", "my tag");
  ```
2. 注册事件
  ```java
  public class YourActivity extends Activity {
      @Override
      protected void onCreate(Bundle savedInstanceState) {
          super.onCreate(savedInstanceState);
          setContentView(R.layout.activity_main);

// 注册 String 类型事件
          RxBus.getDefault().subscribeSticky(this, new RxBus.Callback<String>() {
              @Override
              public void onEvent(String s) {
                  Log.e("eventTag", s);
              }
          });

// 注册带 tag 为 "my tag" 的 String 类型事件
          RxBus.getDefault().subscribeSticky(this, "my tag", new RxBus.Callback<String>() {
              @Override
              public void onEvent(String s) {
                  Log.e("eventTag", s);
              }
          });
      }

@Override
      protected void onDestroy() {
          super.onDestroy();
          // 注销
          RxBus.getDefault().unregister(this);
      }
  }
  ```

## Nice wrap

如果用到事件总线的地方比较多，那么可以把事件总线的使用放到一个 Manager 中使用，比如我 Demo 中做的封装如下所示：

```java
public class RxBusManager {

private static final String MY_TAG = "MY_TAG";

public static void subscribeRxBusManagerActivity(final RxBusManagerActivity activity){
        RxBus.getDefault().subscribe(activity, new RxBus.Callback<String>() {
            @Override
            public void onEvent(String s) {
                activity.updateText("without " + s);
            }
        });

RxBus.getDefault().subscribe(activity, MY_TAG, new RxBus.Callback<String>() {
            @Override
            public void onEvent(String s) {
                activity.updateText("with " + s);
            }
        });
    }

public static void postToRxBusManagerActivity(final String event) {
        RxBus.getDefault().post(event);
    }

public static void postWithMyTagToRxBusManagerActivity(final String event) {
        RxBus.getDefault().post(event, MY_TAG);
    }

public static void postStickyToRxBusManagerActivity(final String event) {
        RxBus.getDefault().postSticky(event);
    }

public static void postStickyWithMyTagToRxBusManagerActivity(final String event) {
        RxBus.getDefault().postSticky(event, MY_TAG);
    }

public static void unregisterRxBusManagerActivity(final RxBusManagerActivity activity) {
        RxBus.getDefault().unregister(activity);
    }
}
```

可以看出这是在 RxBusManagerActivity 中要使用 RxBus 的相关代码，这样可以更方便地管理应用中所有的事件总线，而不至于发了个事件都不清楚接收方在哪的尴尬。

## How it comes

网上现有 RxBus 存有的问题：

1. 使用的 RxBus 大多停留在 RxJava1 版本
2. RxBus 实现的粘性事件很多都是有问题的
3. 如果事件抛了异常，之后便再也无法接收到的问题
4. 同类型事件需自己再次封装 Bean 进行区别。

介于以上问题，我还是亲自封装一个简洁的供大家使用，库已经依赖了 RxAndroid 和 RxJava，所以导入了该库的就不需要再额外导入那两库了。

当然，如果通信频率比较高追求效率的话还是推荐使用 [EventBus](https://github.com/greenrobot/EventBus)。

## Principle

1. 利用 FlowableProcessor 既可以作为观察者又可以作为被观察者来实现事件总线
2. 粘性事件原理就是发送的时候把事件存到一个 hash 表中，在注册的时候查询下 hash 表中是否存在符合的事件，有的话就消费掉即可
3. 替换原有 LambdaSubscriber 来让抛了异常之后可以继续接收到后续事件
4. 封装了 TagMessage 来区分不同类别的 tag
5. 动态识别范型对象来省去传入 Type 类型

还有一些细节就自己看源码去了解吧，总共有用的代码不超过 300 行哈。

## [Change log](https://github.com/Blankj/RxBus/blob/master/CHANGELOG.md)

## 打个小广告

欢迎加入我的小专栏「**[基你太美](https://xiaozhuanlan.com/Blankj)**」一起学习。

[logo]: https://raw.githubusercontent.com/Blankj/RxBus/master/art/logo.png

[rbsvg]: https://img.shields.io/badge/RxBus-v1.6-brightgreen.svg
[rb]: https://github.com/Blankj/RxBus

[licensesvg]: https://img.shields.io/badge/License-Apache--2.0-brightgreen.svg
[license]: https://github.com/Blankj/RxBus/blob/master/LICENSE

RxBus

RxBus Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

RxBus

RxBus Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README