基于RxJava的Android事件分发--QxBus

前言:在实现这个事件分发的时候也考虑过EventBus,因为种种原因没有采用,但是项目有个事件分发又非常方便,于是乎有了自己写个Bus的想法,之所以使用RxJava是考虑到RxAndroid简直不要太好用,各种线程间的切换如丝般顺滑,我们做Android开发的时候切换线程比较麻烦,索性给他改造一下就是个很简单的事件分发工具。

首先要知悉,这个工具只是我在做一个项目的时候偶然头脑发热搞出来的小玩意,没什么技术含量(连构思带实现一共才用了半天时间),不知道在大型项目上运行会出现什么未知的BUG,分享仅作为个人笔记和经验交流,如对您的项目有帮助,荣幸之至,反之请一笑置之;

特性:
支持同时向多个类发送数据,在多个类里定义一样的tag即可
基于RxJava,所以线程切换于RxJava、RxAndroid一致
除了可以发送数据,还可以主动向注册事件的位置获取数据
代码少

开始:首先要引入RxJava和RxAndroid(无版本要求)

    //RxJava
    implementation 'io.reactivex.rxjava2:rxjava:2.2.6'
    //RxAndroid
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'

然后。。。。。直接去文章末尾复制代码吧,200多行代码

使用方法:

发送数据

1.在基类中根据生命周期解绑

    @Override
    protected void onDestroy() {
        super.onDestroy();
        QxBus.getInstance().unregister(this);
    }

2.在任意位置注册,String可以更换任意指定类型(基础类型不可以),但对应tag的发送消息也需要是同类型,否则会导致崩溃

        QxBus.subscribe(this, tag, new QxBus.BusObserver<String>() {
            @Override
            public void onNext(@NotNull String s) {
                ToastUtils.show(s);
            }
        });

3.在任意位置发送消息

        QxBus.post(tag, "登录成功");
获取数据

1.在合适位置订阅一个获取数据的监听

        QxBus.subGet(this, "tag", new QxBus.OnGetDataListener<String>() {
            @Override
            public String data() {
                return "获取数据成功";
            }
        });

2.在使用数据的位置调用get

        QxBus.get("tag", new QxBus.BusObserver<String>() {
            @Override
            public void onNext(@NotNull String s) {
                ToastUtils.show(s);
            }
        });

所以只要tag保持一致,就可以正常发送和接收数据;
不过要时刻注意,因为使用了粗暴的泛型,同名的tag标签的发送和接收对象必须是同类型,否则直接崩溃没商量,tag就是个字符串,多定义一些,防止两个不同逻辑使用同一个tag就不会出错


/**
 * Author: 萧清轩
 * Date  : 2022/10/14
 * Dest  : 基于RxJava封装的事件分发总线
 */
public class QxBus {
    private static volatile QxBus client;

    private final Map<String, Map<String, BusObserver<Object>>> map;
    private final Map<String, Map<String, OnGetDataListener<Object>>> getMap;

    public static QxBus getInstance() {
        if (client == null)
            synchronized (QxBus.class) {
                if (client == null)
                    client = new QxBus();
            }
        return client;
    }

    private QxBus() {
        map = new HashMap<>();
        getMap = new HashMap<>();
    }

    /**
     * 订阅
     *
     * @param obj         类
     * @param tag         标签
     * @param busObserver 观察者
     * @param <T>         接收类型
     */
    public static <T> void subscribe(Object obj, String tag, BusObserver<T> busObserver) {
        getInstance().register(obj, tag, busObserver);
    }

    public <T> void register(Object obj, String tag, BusObserver<T> busObserver) {
        if (obj == null || busObserver == null) return;
        String objKey = obj.getClass().getName();
        Map<String, BusObserver<Object>> busMap;
        if (map.containsKey(objKey)) {
            busMap = map.get(objKey);
            if (busMap == null) {
                busMap = new HashMap<>();
            }
        } else {
            busMap = new HashMap<>();
        }
        busMap.put(tag, (BusObserver<Object>) busObserver);
        map.put(objKey, busMap);
    }

    /**
     * 解绑
     * 清除所有 obj类名下的标签,使之失效(伪生命周期)
     *
     * @param obj 对应类  unregister(this)
     */
    public void unregister(Object obj) {
        if (obj == null) return;
        String tag = obj.getClass().getName();
        map.remove(tag);
    }

    /**
     * 发送消息
     *
     * @param subscribeOn 发送线程
     * @param observeOn   目标线程
     * @param tag         标记
     * @param t           对象
     */
    private <T> void send(Scheduler subscribeOn, Scheduler observeOn, String tag, T t) {
        for (Map<String, BusObserver<Object>> busMap : map.values()) {
            if (busMap != null && busMap.containsKey(tag)) {
                BusObserver<T> busObserver = (BusObserver<T>) busMap.get(tag);
                if (busObserver != null)
                    Observable.create((ObservableOnSubscribe<T>) emitter -> {
                        emitter.onNext(t);
                    }).subscribeOn(subscribeOn)
                            .observeOn(observeOn)
                            .subscribe(busObserver);
            }
        }
    }

    /**
     * 开放方法 发送消息
     * 简化{@link #send(Scheduler, Scheduler, String, Object)} 的调用
     * 最常用的方法,向订阅指定标签的位置发送数据
     *
     * @param tag  消息标签
     * @param data 数据
     * @param <T>  对象类型
     */
    public static <T> void post(String tag, T data) {
        post(Schedulers.io(), tag, data);
    }

    /**
     * 向主线程发送消息
     */
    public static <T> void post(Scheduler subscribeOn, String tag, T data) {
        post(subscribeOn, AndroidSchedulers.mainThread(), tag, data);
    }

    /**
     * 向任意指定线程发送消息
     *
     * @param subscribeOn 发送线程
     * @param observeOn   接收线程
     */
    public static <T> void post(Scheduler subscribeOn, Scheduler observeOn, String tag, T data) {
        getInstance().send(subscribeOn, observeOn, tag, data);
    }

    /**
     * 订阅一个主动获取数据的方法
     * 和post方法刚好相反,这里是提供数据,如AActivity 跳转到 BActivity,在BActivity 中通过点击某个按钮
     * 获取AActivity中的数据,可以在AActivity中订阅一个 subscribeGet 方法,
     * 通过 OnGetDataListener.data()的返回值提供数据
     * 对应获取数据的方法为 {@link #getData(String, BusObserver)}
     *
     * @param tag      标签
     * @param listener 监听器
     * @param <T>      数据类型
     */
    public <T> void subscribeGet(Object obj, String tag, OnGetDataListener<T> listener) {
        if (obj == null || listener == null) return;
        String objKey = obj.getClass().getName();
        Map<String, OnGetDataListener<Object>> dataMap;
        if (getMap.containsKey(objKey)) {
            dataMap = getMap.get(objKey);
            if (dataMap == null) {
                dataMap = new HashMap<>();
            }
        } else {
            dataMap = new HashMap<>();
        }
        dataMap.put(tag, (OnGetDataListener<Object>) listener);
        getMap.put(objKey, dataMap);
    }

    /**
     * {@link #subscribeGet(Object, String, OnGetDataListener)} 的开放方法
     */
    public static <T> void subGet(Object obj, String tag, OnGetDataListener<T> listener) {
        getInstance().subscribeGet(obj, tag, listener);
    }

    /**
     * 获取数据
     * 意在主动获取数据
     * 对应注册方法为{@link #subscribeGet(Object, String, OnGetDataListener)}
     *
     * @param tag         标签
     * @param busObserver 数据观察者
     * @param <T>         数据类型
     */
    public <T> void getData(String tag, BusObserver<T> busObserver) {
        if (busObserver == null) return;
        Observable.create((ObservableOnSubscribe<T>) emitter -> {
            OnGetDataListener<T> listener = null;
            for (Map<String, OnGetDataListener<Object>> dataMap : getMap.values()) {
                if (dataMap != null && dataMap.containsKey(tag)) {
                    listener = (OnGetDataListener<T>) dataMap.get(tag);
                }
            }
            if (listener != null) {
                emitter.onNext(listener.data());
            }
        }).subscribeOn(Schedulers.io())
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(busObserver);
    }

    /**
     * {@link #getData(String, BusObserver)} getData的开放方法
     */
    public static <T> void get(String tag, BusObserver<T> busObserver) {
        getInstance().getData(tag, busObserver);
    }


    /**
     * 自定义观察者 简化版的{@link Observable}
     */
    public abstract static class BusObserver<T> implements Observer<T> {
        @Override
        public void onSubscribe(@NotNull Disposable d) {

        }

        @Override
        public void onNext(@NotNull T t) {

        }

        @Override
        public void onError(@NotNull Throwable e) {

        }

        @Override
        public void onComplete() {

        }
    }

    /**
     * 获取数据的接口,意在简化 {@link ObservableOnSubscribe} 的操作方式
     *
     * @param <T> 数据类型
     */
    public static interface OnGetDataListener<T> {
        T data();
    }
}

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

推荐阅读更多精彩内容