200代码写一套属于自己的事件总线(EventBus)库

可莉
• 阅读 438

理论千万篇,不如实战来一篇。

源码 https://github.com/harvie1208/EventBus

关键词:观察者模式、反射、自定义注解、线程调度

手写200行代码,一步一步实现EventBus核心功能,看完可以写一套属于自己的事件总线库啦!

不知大家平常在看博客的时候有没有和我遇到一样的问题,就是看的是懂非懂,好像懂了,又好像没懂。

主要有以下两点:

  • 1.文章缺少部分实现思路,导致自己实现时卡住。
  • 2.术语太过专业化,不易理解。

在求知的路上,我也看了不少文章,有非常优秀的,也有缺这少那的。一路走来填了不少坑,后面我会将所学知识点整理出来分享给大家,尽量做到通俗易懂的理论加完整案例源码。一方面是对自己知识点的总结回顾,另一方面也希望能帮助到有需要的同学少走弯路。因技术水平有限,如有不正之处,还望各位不吝指教。

EventBus简介

EventBus顾名思义就是事件总线,实际上就是一个事件发布者/事件监听者(订阅者) 的框架, 发布者发布事件,Bus自动处理与分发,监听者被动的接受。简化各种异步和跳转的通信。

200代码写一套属于自己的事件总线(EventBus)库

使用场景示例

1.短信验证码登陆场景

主登陆界面A->输入手机号界面B->短信验证码界面C->登陆成功跳转首页D
需求:登陆成功后需要关闭A、B、C三个页面

2.音乐播放场景

假如首页有5个tab(包含5个fragment),每个fragment中都有音乐播放状态小图标
需求:音乐播放或暂停时,需要更新所有播放状态图标

核心思路

使用观察者模式,在需要接收事件的方法上添加订阅注解标识,并将此方法所在对象添加到订阅者集合,
发送事件时遍历订阅者集合,在通过反射调用相关订阅方法。

代码实战

1.编写EventBus核心类,使用单例模式提供唯一实例

public class EventBus {
    private static EventBus myBus;
    public static EventBus getInstance(){
        if (myBus==null){
            synchronized (EventBus.class){
                if (myBus==null){
                    myBus = new EventBus();
                }
            }
        }
        return myBus;
    }
}

2.给订阅方法添加@Subscribe标识

  • 创建自定义注解@Subscribe用来标示订阅方法

    注解Annontation是Java5开始引入的新特征,通俗来说就是为程序的元素(类、方法、成员变量)添加标记用的

    @Target(ElementType.METHOD) //表示此注解作用域在方法上
    @Retention(RetentionPolicy.RUNTIME) //编译程序处理完注解信息后存储在class中,可由VM读入
    public @interface Subscribe {
    
        ThreadModel thread();//用于指定被注解方法执行时所在的线程
    }
    
  • 使用注解

    public class MainActivity extends AppCompatActivity {
    
        @Subscribe(thread = ThreadModel.BACKGROUND)//指定在子线程中执行
        public void haha(LoginEvent loginEvent){
            Log.e("EventBus",loginEvent.getLoginStatus()+Thread.currentThread().getName());
        }
    }
    

3.注册订阅关系

  • 先声明一个集合用于存储类对象和被注解的方法及线程模式

  • 遍历注册对象的所有方法,取出带有@Subscribe注解的方法

  • 获取参数类型数组,当前仅支持一个参数

  • 获取指定线程模式

  • 构建订阅者实例(方法、参数类型、线程模式),加入订阅集合

    public class EventBus {
    
        //存储订阅类及方法参数
        private Map<Object,List<Subscriber>> subscribeMethod;
    
        public void register(Object obj){
            if (obj==null){
                return;
            }
            Class<?> mclazz = obj.getClass();
            //获取本类所有方法
            Method[] methods = mclazz.getDeclaredMethods();
            List<Subscriber> methods1 = new ArrayList<>();
            for (Method method : methods){
                //获取带有我们Subscribe注解的方法
                Subscribe subscribe = method.getAnnotation(Subscribe.class);
                if (subscribe==null){
                    continue;
                }
                //获取参数类型集合
                Class<?>[] typeVariable = method.getParameterTypes();
                if (typeVariable.length!=1){
                    continue;
                }
                ThreadModel threadModel = subscribe.thread();
                Subscriber busMethod = new Subscriber(method,threadModel,typeVariable[0]);
                methods1.add(busMethod);
            }
            if (methods1.size()>0){
                subscribeMethod.put(obj,methods1);
            }
        }
    }
    

4.注销订阅

  • 将此订阅对象移除订阅集合

    public void unRegister(Object object){
        if (subscribeMethod.containsKey(object)){
            subscribeMethod.remove(object);
        }
    }
    

5.发送事件

  • 根据发送事件参数类型,遍历集合找到对应方法

  • 判断线程模式,主线程用handler处理,子线程用线程池处理

  • 反射调用方法将事件传过去

    public class EventBus {
    
        //存储订阅类及方法参数
        private Map<Object,List<Subscriber>> subscribeMethod;
        //线程调度
        private Handler mHandler;
        //线程池
        private ExecutorService executorService;
    
        private EventBus(){
            subscribeMethod = new HashMap<>();
            mHandler = new Handler(Looper.getMainLooper());
            executorService = Executors.newCachedThreadPool();
        }
    
        public void postEvent(Object eventParam){
            Set<Object> set = subscribeMethod.keySet();
            Iterator<Object> iterable =set.iterator();
            while (iterable.hasNext()){
                Object obj = iterable.next();
                List<Subscriber> busMethodList = subscribeMethod.get(obj);
                for (Subscriber busMethod : busMethodList){
                    if(busMethod.getParamsType() == eventParam.getClass()){
                        invoke(obj,busMethod,eventParam);
                    }
                }
            }
        }
    
        private void invoke(final Object obj, final Subscriber busMethod, final Object eventParam){
            switch (busMethod.getThreadModel()){
                case MAIN:
                    //通过handler调度到主线程
                    mHandler.post(new EventRunable(busMethod, obj, eventParam));
                    break;
                default:
                    //交由线程池处理
                    executorService.execute(new EventRunable(busMethod, obj, eventParam));
                    break;
            }
        }
    }
    

    事件参数与接收参数类型一致即可,方法名随意

    EventBus.getInstance().postEvent(new LoginEvent("登录成功"));
    

总结

很多看似高大上的框架其实也没我们想的那么难,写着写着就顺手了,知而不行为不知,快动起手来吧!

源码 https://github.com/harvie1208/EventBus

点赞
收藏
评论区
推荐文章
blmius blmius
2年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Jacquelyn38 Jacquelyn38
2年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Wesley13 Wesley13
2年前
java中比较两个时间的差值
项目背景1.某篇文稿的发布时间是publishDate,例如:2020072118:00:41。2.现要求判断该篇文稿的发布时间是否在近30天之内。publicstaticlongdayDiff(DatecurrentDate,DatepublishDate){LongcurrentTimecurrentDat
Stella981 Stella981
2年前
KaliTools说明书+BurpSuit实战指南+SQL注入知识库+国外渗透报告
!(https://oscimg.oschina.net/oscnet/d1c876a571bb41a7942dd9752f68632e.gif"15254461546.gif")0X00KaliLinux Tools中文说明书!(https://oscimg.oschina.net/oscnet/
Stella981 Stella981
2年前
200代码写一套属于自己的事件总线(EventBus)库
理论千万篇,不如实战来一篇。源码https://github.com/harvie1208/EventBus(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fgithub.com%2Fharvie1208%2FEventBus)关键词:观察者模式、
Wesley13 Wesley13
2年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Stella981 Stella981
2年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
1个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这