【每天学点Spring】Spring Events

事件驱动设计模式，也可能通过Spring来实现。

围绕事件的三个角色：

  • 事件（Event）
  • 事件发布者（Publisher）
  • 事件监听者（Listener）

文章内容：

Spring Event.jpg

1. Demo-01: Spring 4.2版本前

  • 在Spring4.2之前，Event 需要继承ApplicationEvent类。
  • Publisher 需要注入类：ApplicationEventPublisher.
  • Listener 需要实现接口ApplicationListener。

默认情况下，事件的发布和执行都是同步的，这样做的好处是监听的方法也可以参与到发布事件类的transaction中。

1.1 先是Event类：
@Getter
public class UserCreateEvent extends ApplicationEvent {
    private String userId;

    public UserCreateEvent(Object source, String userId) {
        super(source);
        this.userId = userId;
    }
}
1.2 Publisher类：

有两种方式可以实现：

  1. 如示例中的代码，注入ApplicationEventPublisher对象。
  2. 可以实现接口ApplicationEventPublisher。
@Slf4j
@Service
public class UserCreateService {
    @Autowired
    public ApplicationEventPublisher applicationEventPublisher;

    public boolean addUser(String userId) {
        log.info("Start to add user.");
        applicationEventPublisher.publishEvent(new UserCreateEvent(this, userId));
        log.info("Add user done.");
        return true;
    }
}
1.3 Listener类：
@Slf4j
@Component
public class UserCreateListener implements ApplicationListener<UserCreateEvent> {
    public void onApplicationEvent(UserCreateEvent userCreateEvent) {
        String userId = userCreateEvent.getUserId();
        log.info("Start to notify user.");

        // mock service, cost 3 second to send email:
        ThreadUtils.sleep(3000L);

        log.info("Finished notifying user for userId = " + userId);
    }
}
1.4 Test类：
@SpringBootTest
public class UserCreateServiceTest {
    @Autowired
    private UserCreateService userCreateService;

    @Test
    public void addUserTest() {
        userCreateService.addUser("testUser1");
    }
}

打印结果：可以看到Listener的代码是同步的，Add user done等到Listener代码执行后才打印：

2022-04-17 15:24:56.857 INFO 21545 --- [ main] UserCreateService : Start to add user.
2022-04-17 15:24:56.858 INFO 21545 --- [ main] UserCreateListener : Start to notify user.
2022-04-17 15:24:59.863 INFO 21545 --- [ main] UserCreateListener : Finished notifying user for userId = testUser1
2022-04-17 15:24:59.864 INFO 21545 --- [ main] UserCreateService : Add user done.

2. Demo-02：在Spring 4.2版本前，想要异步事件，需要额外定义BeanApplicationEventMulticaster：

@Configuration
public class AsynchronousSpringEventsConfig {
    @Bean(name = "applicationEventMulticaster")
    public ApplicationEventMulticaster simpleApplicationEventMulticaster() {
        SimpleApplicationEventMulticaster eventMulticaster = new SimpleApplicationEventMulticaster();

        eventMulticaster.setTaskExecutor(new SimpleAsyncTaskExecutor());
        return eventMulticaster;
    }
}
Test类：
@SpringBootTest
public class UserCreateServiceTest {
    @Autowired
    private UserCreateService userCreateService;

    @Test
    public void addUserTest() {
        userCreateService.addUser("testUser1");
        ThreadUtils.sleep(5000L); //等5秒，为了等Listener执行完毕
    }
}

打印结果：可以看到Listener的代码是异步的，Add user done没有等到Listener代码执行后才打印，并且线程池名称也能看出Listener用的不是Main主线程：

2022-04-17 15:30:03.329 INFO 21549 --- [ main] UserCreateService : Start to add user.
2022-04-17 15:30:03.331 INFO 21549 --- [TaskExecutor-18] UserCreateListener : Start to notify user.
2022-04-17 15:30:03.331 INFO 21549 --- [ main] UserCreateService : Add user done.
2022-04-17 15:30:06.336 INFO 21549 --- [TaskExecutor-18] UserCreateListener : Finished notifying user for userId = testUser1

3. demo-03: Spring 4.2版本后，基于Annotation注解的事件驱动模型：

3.1 @EventListener

Listener不需要再实现接口ApplicationListener，而是可以直接在方法上加注解@EventListener:

@Slf4j
@Component
public class UserCreateListenerWithAnnotation {
    @EventListener
    public void onApplicationEvent(UserCreateEvent userCreateEvent) {
        // 实现同UserCreateListener
    }
}
3.2 @Async

异步事件可以使用@Async注解：

@Slf4j
@Component
public class UserCreateListenerWithAnnotation {
    @Async
    @EventListener
    public void onApplicationEvent(UserCreateEvent userCreateEvent) {
        // 实现同UserCreateListener
    }

使用@Async需要开启：@EnableAsync

@SpringBootApplication
@EnableAsync
public class SpringProjectApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringProjectApplication.class, args);
    }
}
3.3 Event类支持泛型，且不需要继承ApplicationEvent:

注：在做测试的时候，别忘记给新的GenericUserCreateEvent类加上Publisher。

@Getter
public class GenericUserCreateEvent<T> {
    private T userId;
    private boolean success;

    public GenericUserCreateEvent(T userId, boolean success) {
        this.userId = userId;
        this.success = success;
    }
}
3.4 Listener支持condition，使用SpEL表达式来定义触发的条件：

以下示例是condition结合支持泛型的Event类：

@Slf4j
@Component
public class UserCreateListenerWithAnnotation {
    @EventListener(condition = "#event.success")
    public void onApplicationEvent(GenericUserCreateEvent event) {
        String userId = (String)event.getUserId();
        log.info("Finished notifying user for userId = " + userId);
    }

}

举例：

  • condition = "#event.success": 匹配event.getSuccess() == true时，才会触发。
  • condition = "#event.type eq 'email'": 匹配event.getType()等于email时，才会触发。
  • condition = "#event.type ne 'email'": 匹配event.getType()不等于email时，才会触发。

3.5 还可以监听多个事件：

@EventListener(classes = { ContextStartedEvent.class, ContextStoppedEvent.class })

4. 扩展

4.1 Spring自带的Event：

除了自定义Event类，Spring框架也定义了一系列的Event，我们可以自定义Listener来监听这些事件，例如：

  • ContextRefreshedEvent：执行了ConfigurableApplicationContext#refresh()方法
  • ContextStartedEvent：执行了ConfigurableApplicationContext#start()方法
  • ContextStoppedEvent：执行了ConfigurableApplicationContext#stop()方法
  • ContextClosedEvent：执行了ConfigurableApplicationContext#close()方法
4.2 @TransactionalEventListener

Spring 4.2版本后，新定义了一个注解叫@TransactionalEventListener，是@EventListener的扩展，从名字也可以看出，这个注解跟事务有关。

我们可以定义不同的phase（阶段）：

  1. AFTER_COMMIT (默认)：在事务成功提交后执行。
  2. AFTER_ROLLBACK：事件被rollback后执行。
  3. AFTER_COMPLETION – 事务完成后提交 (包含上述#1 #2两个阶段)。
  4. BEFORE_COMMIT：在事件提交前执行。

示例：

@Slf4j
@Service
public class UserCreateListenerTransaction {

    @TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT)
    public void onApplicationEvent(GenericUserCreateEvent event) {
        // 实现同UserCreateListenerWithAnnotation
    }

}

上述的Listener代码何时被触发？当publisher代码有事务被且将要被提交时才会触发。

Publisher示例，可以看到addUserOnlySuccessNotify方法需要加上@Transactional才可以触发上述的UserCreateListenerTransaction#onApplicationEvent()方法：

@Slf4j
@Service
public class UserCreateService {
    @Autowired
    public ApplicationEventPublisher applicationEventPublisher;

    @Transactional
    public boolean addUser(String userId) {
        log.info("Start to add user.");

        applicationEventPublisher.publishEvent(new GenericUserCreateEvent(userId, true));
        log.info("Add user done.");
        return true;
    }
}

执行Test类后，打印如下，注意打印顺序，addUser先执行后再执行Listener：

2022-04-17 17:41:31.334 INFO 21729 --- [ main] UserCreateService : Start to add user.
2022-04-17 17:41:31.335 INFO 21729 --- [ main] UserCreateService : Add user done.
2022-04-17 17:41:31.336 INFO 21729 --- [ main] UserCreateListenerTransaction : Start to notify user.
2022-04-17 17:41:34.341 INFO 21729 --- [ main] UserCreateListenerTransaction : Finished notifying user for userId = testUser2

也就是说，如果Publisher方法没有事务，Listener中的方法将不会被触发。除非加上fallbackExecution = true
即：

@TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT, fallbackExecution = true)

改成上述的注解后，即便Publisher方法没有事务，Listener也会执行。

【参考】
Spring Event: https://www.baeldung.com/spring-events
Spring Application Context Event: https://www.baeldung.com/spring-context-events
How to do @Async in Spring: https://www.baeldung.com/spring-async#enable-async-support
Spring expression langurage: https://www.baeldung.com/spring-expression-language

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 218,546评论 6赞 507
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 93,224评论 3赞 395
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 164,911评论 0赞 354
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 58,737评论 1赞 294
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 67,753评论 6赞 392
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 51,598评论 1赞 305
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 40,338评论 3赞 418
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 39,249评论 0赞 276
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 45,696评论 1赞 314
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,888评论 3赞 336
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,013评论 1赞 348
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 35,731评论 5赞 346
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 41,348评论 3赞 330
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,929评论 0赞 22
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,048评论 1赞 270
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 48,203评论 3赞 370
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 44,960评论 2赞 355

推荐阅读更多精彩内容