soul 网关入门篇(四):ApplicationEventPublisher 的使用

前言

官网上有这么一句话说:插件化设计思想,插件热插拔,易扩展。 一开始学习插件化就遇到很陌生的概念,比如 ApplicationEventPublisher。它是做什么的,是怎么使用的?那今天就从这个入手,一步一步的来吧。

起因

由于之前配置过 divide 的插件,那当配置插件时,查看请求的连接为:PUT http://localhost:9095/plugin/5 时,我们查看源代码,查看所属方法为:
PluginController#updatePlugin(@PathVariable("id") final String id, @RequestBody final PluginDTO pluginDTO)
然后我们进入 service 方法:

public String createOrUpdate(final PluginDTO pluginDTO) {
        final String msg = checkData(pluginDTO);
        if (StringUtils.isNoneBlank(msg)) {
            return msg;
        }
        PluginDO pluginDO = PluginDO.buildPluginDO(pluginDTO);
        DataEventTypeEnum eventType = DataEventTypeEnum.CREATE;
        if (StringUtils.isBlank(pluginDTO.getId())) {
            pluginMapper.insertSelective(pluginDO);
        } else {
            eventType = DataEventTypeEnum.UPDATE;
            pluginMapper.updateSelective(pluginDO);
        }

        // publish change event. 
        eventPublisher.publishEvent(new DataChangedEvent(ConfigGroupEnum.PLUGIN, eventType,
                Collections.singletonList(PluginTransfer.INSTANCE.mapToData(pluginDO))));
        return StringUtils.EMPTY;
}

查看 eventPublisher 时 ,发现 ApplicationEventPublisher 的定义如下

@FunctionalInterface
public interface ApplicationEventPublisher {
...
}

这里有个陌生的概念, 什么是 ApplicationEventPublisher,它的作用是什么,又是怎么用的呢?

ApplicationEventPublisher 概念

spring 的官网 上所定义的是
Interface that encapsulates event publication functionality , 能发送事件,实现监听。

Soul 上怎么用的

前面说到,我们看到跟踪到了消息的发送,那它肯定有消息的接收,我们可以看到相关的 DataChangedEvent 相关的代码。

DataChangedEvent

这部分是猜想的,接下来需要验证。当我们进入调试的模式的时候,发现它进入果真到了这里


event Listener

跟踪到了这里,我们基本把 ApplicationEventPublisher 跟踪完了。接下来,我们自己根据 soul 上的代码自己实现一下。

使用 ApplicationEventPublisher

新建 SpringBoot 的项目。仿照 Soul 的流程,我们新建事件发布者 AService.java,

@Service
public class AService {
    @Autowired
    private ApplicationEventPublisher eventPublisher;

    public void sendMessage() {
        String s = "Hello";
        String b = "soul";
        eventPublisher.publishEvent(new DEvent(s + b, s, b));
    }
}

事件:DEvent.java

public class DEvent extends ApplicationEvent {
    private final String name;
    private final String text;

    public DEvent(Object source, String name, String text) {
        super(source);
        this.name = name;
        this.text = text;
    }

    public String getName() {
        return name;
    }

    public String getText() {
        return text;
    }
}

监听者:BListener.java

@Component
@Slf4j
public class BListener implements ApplicationListener<DEvent> {
    @Override
    public void onApplicationEvent(DEvent applicationEvent) {
        log.info(">==== listen: {}", applicationEvent.getName(), applicationEvent.getText());
    }
}

在入口类中:


@SpringBootApplication
public class EventApplication implements CommandLineRunner {
    // 如果不采用注入的方式,eventPublisher 为 null值,原因待查
    @Autowired 
    private AService aService;

    public static void main(String[] args) {
        SpringApplication.run(EventApplication.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        aService.sendMessage();
    }
}

启动程序查看日志,日志中有显示的监听到发送的事件。


日志

总结

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

推荐阅读更多精彩内容