事务绑定事件

自 Spring 4.2 起,事件监听器可以绑定到事务的一个阶段。典型的例子是在事务成功完成时处理事件。这样做可以在监听器确实关心当前事务结果时,更灵活地使用事件。

你可以使用 @EventListener 注解注册一个常规事件监听器。如果你需要将其绑定到事务,请使用 @TransactionalEventListener。默认情况下,监听器会绑定到事务的提交阶段。

下一个示例展示了这个概念。假设一个组件发布了一个订单创建事件,我们希望定义一个监听器,该监听器只应在该事件发布的事务成功提交后才处理该事件。以下示例设置了这样一个事件监听器:

  • Java

  • Kotlin

@Component
public class MyComponent {

	@TransactionalEventListener
	public void handleOrderCreatedEvent(CreationEvent<Order> creationEvent) {
		// ...
	}
}
@Component
class MyComponent {

	@TransactionalEventListener
	fun handleOrderCreatedEvent(creationEvent: CreationEvent<Order>) {
		// ...
	}
}

@TransactionalEventListener 注解暴露了一个 phase 属性,允许你自定义监听器应绑定到的事务阶段。有效阶段包括 BEFORE_COMMITAFTER_COMMIT(默认)、AFTER_ROLLBACK,以及聚合事务完成(无论是提交还是回滚)的 AFTER_COMPLETION

如果没有事务正在运行,监听器将根本不会被调用,因为我们无法遵守所需的语义。但是,你可以通过将注解的 fallbackExecution 属性设置为 true 来覆盖此行为。

自 6.1 版本起,@TransactionalEventListener 可以与由 PlatformTransactionManager 管理的线程绑定事务以及由 ReactiveTransactionManager 管理的响应式事务协同工作。对于前者,监听器保证能够看到当前的线程绑定事务。由于后者使用 Reactor 上下文而不是线程局部变量,因此事务上下文需要作为事件源包含在已发布的事件实例中。有关详细信息,请参阅 TransactionalEventPublisher 的 javadoc。

© . This site is unofficial and not affiliated with VMware.