前言
官网上有这么一句话说:插件化设计思想,插件热插拔,易扩展。 一开始学习插件化就遇到很陌生的概念,比如 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
相关的代码。
这部分是猜想的,接下来需要验证。当我们进入调试的模式的时候,发现它进入果真到了这里
跟踪到了这里,我们基本把 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();
}
}
启动程序查看日志,日志中有显示的监听到发送的事件。
总结
- 由于我的现状是对于 Spring 本身还不是很熟,有些知识需要跟着源码的学习不断的提升,比如这个事件。
- 关于今天这个主题还需要深入的是:
ApplicationEvent
的原理是什么,Spring
的事件有哪些,和guava event bus
有哪些相同点和不同点。先预留一个坑到这里吧,目前先要会用。 - 关于Debug:由于
soul
的命名还是很规范的,先看文件名,大体猜是做什么的,然后去debug,验证自己的想法。