簡介
RxBus 是基于 RxJava 實現(xiàn)的事件總線方式，他的強大之處是代碼非常的少但是功能卻并不簡單。最簡單的 RxBus 實現(xiàn)僅僅需要三十幾行代碼，相較之下 EventBus 顯得有些臃腫。正因為強大的 RxBus ，Android 開源界的良心企業(yè) Square 公司停止了維護他們的事件總線庫 Otto并且在 github 項目主頁上為 RxBus 投了一張推薦票：
Deprecated!
This project is deprecated in favor of RxJava and RxAndroid. These projects permit the same event-driven programming model as Otto, but they’re more capable and offer better control of threading.
If you’re looking for guidance on migrating from Otto to Rx, this post is a good start.
該項目已被RxJava和RxAndroid取代。Rx類項目允許與Otto類似的事件驅(qū)動編程模型，而且能力更強，操作線程更方便。
如果你正在尋找從Otto遷移到Rx的指導，這個帖子是個很好的開始。
在引入 RxJava 和 RxAndroid 庫的前提下 RxBus 的實現(xiàn)僅僅需要幾十行代碼的一個類，在越來越多的開發(fā)者傾向于使用 RxAndroid + Retrofit 實現(xiàn)網(wǎng)絡(luò)請求框架的現(xiàn)在，RxBus 成為對應的事件總線實現(xiàn)方式也順理成章，沒必要再為了時間總線單獨再引入一個庫從而增加應用體積，當然如果項目已經(jīng)介入 EventBus 作為事件總線庫，那就得自己衡量切換成本了。
實踐
RxJava 與 RxJava2 在操作符和方法上有了一些修改，兩個版本的實現(xiàn)方式下面都會講到.
最簡實現(xiàn)
RxJava 1
public class RxBus {
private static volatile RxBus defaultInstance;
private final Subject<Object, Object> bus;
// PublishSubject只會把在訂閱發(fā)生的時間點之后來自原始Observable的數(shù)據(jù)發(fā)射給觀察者
public RxBus() {
bus = new SerializedSubject<>(PublishSubject.create());
}
public static RxBus getDefault() {
if (defaultInstance == null) {
synchronized (RxBus.class) {
if (defaultInstance == null) {
defaultInstance = new RxBus();
}
}
}
return defaultInstance ;
}
// 發(fā)送一個新的事件
public void post (Object o) {
bus.onNext(o);
}
// 根據(jù)傳遞的 eventType 類型返回特定類型(eventType)的 被觀察者
public <T> Observable<T> toObservable (Class<T> eventType) {
return bus.ofType(eventType);
}
}
RxJava 2
public class RxBus {
private static volatile RxBus defaultInstance;
private final Subject<Object> bus;
// PublishSubject只會把在訂閱發(fā)生的時間點之后來自原始Observable的數(shù)據(jù)發(fā)射給觀察者
private RxBus() {
bus = PublishSubject.create().toSerialized();
}
// 單例RxBus
public static RxBus getDefault() {
if (defaultInstance == null) {
synchronized (RxBus.class) {
if (defaultInstance == null) {
defaultInstance = new RxBus();
}
}
}
return defaultInstance;
}
// 發(fā)送一個新的事件，所有訂閱此事件的訂閱者都會收到
public void post(Object action) {
bus.onNext(action);
}
// 根據(jù)傳遞的 eventType 類型返回特定類型(eventType)的 被觀察者
public <T> Observable<T> toObservable(Class<T> eventType) {
return bus.ofType(eventType);
}
}
RxJava1 升級到 RxJava2 只是初始化方式發(fā)生了變化，其他地方保持不變。
簡單使用
RxJava 1
// 數(shù)據(jù)發(fā)送端
// data 為任意數(shù)據(jù)類型，以 Data 類型代表
RxBus.getDefault().post(data);
.
.
.
// 數(shù)據(jù)接收端
mSubscription = RxBus
.getDefault()
.toObservable(Data.class)
.subscribe(new Action1<Data>()){
@Override
public void call(Data data){
// do something with data ...
}
}
.
.
.
// 監(jiān)聽使用離開之后（如關(guān)閉監(jiān)聽所在界面）時記得解綁監(jiān)聽，避免引起內(nèi)存泄漏
if (mSubscription != null && !mSubscription.isUnsubscribed()) {
mSubscription.unsubscribe();
}
RxJava 2
// 數(shù)據(jù)發(fā)送端
// data 為任意數(shù)據(jù)類型，以 Data 類型代表
RxBus.getDefault().post(data);
private Disposable mDisposable;
.
.
.
RxBus.getDefault()
.toObservable(Data.class)
//使用 subscribeWith 和 subscribe 都可以
.subscribeWith(new Observer<Data>){
@Override
public void onSubscribe(Disposable d) {
mDisposable = d;
}
@Override
public void onNext(Data data) {
// do something with data ...
}
@Override
public void onError(Throwable e) {
// do something with e ...
}
@Override
public void onComplete() {
}
};
.
.
.
if (mDisposable != null && !mDisposable.isDisposed()) {
mDisposable.dispose();
}
帶 Code 封裝
通過上面的簡單實用會發(fā)現(xiàn)一個問題，每發(fā)送一個類都需要一個發(fā)送對象類，接收的時候也需要傳入該對象類。假如存在觀察者 A、B、C 都已經(jīng)注冊了對 D.class 消息接收。如果此時只想向 A 發(fā)送 D對象，那么就會造成多個觀察者都收到這個消息。這也違背了只想傳給 A 觀察者的初衷。因此我的想法是為每個發(fā)送對象在添加一個發(fā)送 Code 當 Code 和 class 都滿足時觀察者才會接收處理消息，這樣如果需要通知多個觀察者那么觀察者注冊時使用相同的 Code 就行。
代碼實現(xiàn)
實現(xiàn)帶 Code 的消息發(fā)送需要先實現(xiàn)一個 Code 封裝類（我命名為 Action）然后在 RxBus 內(nèi)部將傳入的 Code 和對象轉(zhuǎn)換成 Action 封裝對象：
/**
* 封裝的消息對象
*/
public class Action
// 消息 Code
public int code;
// 消息對象
public Object data;
public Action(int code, Object data) {
this.code = code;
this.data = data;
}
}
RxJava 1
public class RxBus {
private static volatile RxBus defaultInstance;
private final Subject<Object,Object> bus;
// PublishSubject只會把在訂閱發(fā)生的時間點之后來自原始Observable的數(shù)據(jù)發(fā)射給觀察者
private RxBus() {
bus = new SerializedSubject<>(PublishSubject.create());
}
// 單例RxBus
public static RxBus getDefault() {
if (defaultInstance == null) {
synchronized (RxBus.class) {
if (defaultInstance == null) {
defaultInstance = new RxBus();
}
}
}
return defaultInstance;
}
// 發(fā)送一個新的事件
public void postWithCode(int code, Object action) {
bus.onNext(new Action(code,action));
}
// 根據(jù)傳遞的 eventType 類型返回特定類型(eventType)的 被觀察者
public <T> Observable<T> toObservableWithCode(final int code, Class<T> eventType) {
return bus.ofType(Action.class)
// 過濾掉非自己 code 對應的接收項
.filter(new Func1<Action,Boolean>(){
@Override
public boolean call(Action action){
return action.code == code;
}
})
// 返回傳遞的數(shù)據(jù)對象
.map(new Func1<Action,Object>){
@Override
public Object call(Action action){
return action.data;
}
}
.cast(eventType);
}
RxJava 2
public class RxBus {
private static volatile RxBus defaultInstance;
private final Subject<Object> bus;
// PublishSubject只會把在訂閱發(fā)生的時間點之后來自原始Observable的數(shù)據(jù)發(fā)射給觀察者
private RxBus() {
bus = PublishSubject.create().toSerialized();
}
// 單例RxBus
public static RxBus getDefault() {
if (defaultInstance == null) {
synchronized (RxBus.class) {
if (defaultInstance == null) {
defaultInstance = new RxBus();
}
}
}
return defaultInstance;
}
// 發(fā)送一個新的事件，所有訂閱此事件的訂閱者都會收到
public void post(Object action) {
bus.onNext(action);
}
// 用 code 指定訂閱此事件的對應 code 的訂閱者
public void postWithCode(int code, Object action) {
bus.onNext(new Action(code, action));
}
// 根據(jù)傳遞的 eventType 類型返回特定類型(eventType)的 被觀察者
public <T> Observable<T> toObservable(Class<T> eventType) {
return bus.ofType(eventType);
}
// 根據(jù)傳遞的 eventType 類型返回特定類型(eventType)的 被觀察者,
public <T> Observable<T> toObservableWithCode(final int code, Class<T> eventType) {
return bus.ofType(Action.class)
.filter(new Predicate<Action>() {
@Override
public boolean test(Action action) throws Exception {
return action.code == code;
}
})
.map(new Function<Action, Object>() {
@Override
public Object apply(Action action) throws Exception {
return action.data;
}
})
.cast(eventType);
}
}
與簡單使用一樣，封裝上 RxJava1 與 RxJava2 僅用操作符上的一些差別，實現(xiàn)思路未改變都是在發(fā)送時將行為 code 和數(shù)據(jù)對象 object 封裝成 Action 對象，在轉(zhuǎn)換成 Observable 時返回 Action 對象的處理結(jié)果，通過 Action 的 code 進行數(shù)據(jù)過濾。
使用
除了發(fā)送和接收數(shù)據(jù)對象時會同時接收 code 參數(shù)外，帶 Code 的 Rxbus 封裝使用與不帶 Code 完全一致
RxBus.getDefault().postWithCode(code, data);
.
.
.
RxBus.getDefault()
.toObservableWithCode(RxConstants.BACK_PRESSED_CODE, String.class)
.subscribeWith(...);
.
.
.
總結(jié)
RxBus 普通使用的具體使用場景大家可以參考我的開源項目 熊貓眼
RxBus 在引入了 RxJava、RxAndroid 庫后實現(xiàn)可以說非常簡潔了，如果已經(jīng)在使用 RxJava 了就大膽的嘗試 RxBus 吧。有好處也必定有壞處，譬如上面提到的簡單實現(xiàn)就有兩個特別頭疼的問題：
- Sticky 事件時就是不適用的。
- 訂閱處理過程中一旦發(fā)生了異常，那么該處訂閱就再也收不到了除非重新訂閱。這是因為當出現(xiàn)異常時 onError() 被調(diào)用了，訂閱者和被訂閱者的關(guān)系被解除了。
上面的兩個問題我推薦大家看一下 YoKey 的 [深入 RxBus ：支持 Sticky 事件]、 [深入 RxBus ：異常處理]兩篇文章。
