TransactionalEventListener，事务事件监听，可监听事务提交前、提交后、事务回滚、事务完成（成功或失败）。

(资料图片)

一、介绍

Spring内置了简便的事件机制，可以非常方便的实现事件驱动，核心类包括

二、使用示例：不定义事件，直接发布Object对象，同步

1、定义发送事件对象

public class UserEntity {    private long id;    private String name;    private String msg;}

2、定义事件监听器

可以添加条件condition，限制监听具体的事件

@Slf4j@Componentpublic class RegisterListener {    @EventListener(condition = "#entity.id != null and #entity.async==false ")    public void handlerEvent(UserEntity entity) {        try {            // 休眠5秒            TimeUnit.SECONDS.sleep(5);        } catch (InterruptedException e) {            e.printStackTrace();        }        log.info("handlerEvent: {}", entity);    }}

3、定义发送接口以及实现类

public interface IRegisterService {    public void register(String name);}

@Servicepublic class RegisterServiceImpl implements IRegisterService {    @Resource    private ApplicationEventPublisher applicationEventPublisher;    @Override    public void register(String name) {        UserEntity entity = new UserEntity();        entity.setName(name);        entity.setId(1L);        entity.setMsg("新用户注册同步调用");        applicationEventPublisher.publishEvent(entity);    }}

4、测试Controller类，进行测试

@Slf4j@Controllerpublic class TestController {    @Resource    private IRegisterService registerService;    @RequestMapping("test")    @ResponseBody    public void test1(String name) {        registerService.register(name);        log.info("执行同步调用结束");    }}

在浏览器中输入地址：http://localhost/test?name=nik

控制台输出：

handlerEvent: UserEntity(id=1, name=nik, msg=新用户注册同步调用)执行同步调用结束

三、使用示例：异步发布

1、在启动类添加异步注解@EnableAsync

2、在监听方法上添加注解@Async

@Async@EventListener(condition = "#entity.name != null and #entity.async ")public void handlerEventAsync(UserEntity entity) {    try {        TimeUnit.SECONDS.sleep(5);    } catch (InterruptedException e) {        e.printStackTrace();    }    log.info("handlerEventAsync: {}", entity);}

3、在service中添加异步发送方法

@Overridepublic void registerAsyn(String name) {    UserEntity entity = new UserEntity();    entity.setName(name);    entity.setId(1L);    entity.setMsg("新用户注册异步调用");    entity.setAsync(true);    applicationEventPublisher.publishEvent(entity);}

3、测试

@RequestMapping("test")@ResponseBodypublic void test(String name) {    registerService.registerAsyn(name);    log.info("执行异步调用结束");}

控制台输出：

执行异步调用结束handlerEventAsync: UserEntity(id=1, name=nik, msg=新用户注册异步调用)

四、使用示例：在事务提交后发布事件

比如，用户注册成功后给用户发送成功短信，那么注册成功必然是注册方法事务提交成功后才代表成功。

Spring提供了注解@TransactionalEventListener监听事务事件，在@EventListener基础上增加了属性phase，包含以下四个值：

1、自定义事务处理事件

public class RegisterCommitEvent extends ApplicationEvent {    @Getter    @Setter    private String msg;    @Getter    @Setter    private String name;    public RegisterCommitEvent(UserEntity source) {        super(source);        this.msg = source.getMsg();        this.name = source.getName();    }}

2、在处理方法上添加事务注解，@Transactional

@Override@Transactionalpublic void registerCommit(String name) {    UserEntity entity = new UserEntity();    entity.setName(name);    entity.setMsg("新用户注册事务提交事件");    RegisterCommitEvent registerEvent = new RegisterCommitEvent(entity);    userDao.save(entity);    // 发送事件    applicationEventPublisher.publishEvent(registerEvent);}

3、添加事务事件监听

@Async@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)public void handlerEventCmmit(RegisterCommitEvent event) {    try {        TimeUnit.SECONDS.sleep(5);    } catch (InterruptedException e) {        e.printStackTrace();    }    log.info("handlerEventCmmit: {}", event);}

4、测试

@RequestMapping("test")@ResponseBodypublic void test(String name) {    registerService.registerCommit(name);    log.info("执行事务调用结束");}

控制台输出：

执行事务调用结束handlerEventCmmit: RegisterCommitEvent[source=UserEntity(id=0, name=nik, msg=新用户注册事务提交事件)]

总结

Spring ApplicationEvent事件处理机制使用起来简单方便，可以对程序进行有效解耦。

虽然可以发送任意类型的对象，但是在实际业务中容易产生混乱，建议根据实际业务，定义好各类事件，并在监听方法中实现异步处理。

关键词：