使用Spring的ApplicationEvent实现本地事件驱动的实现方法

更新时间：2023年04月26日 09:56:11 作者：顽石九变

本文介绍了如何使用Spring的ApplicationEvent实现本地事件驱动，通过自定义事件和监听器，实现模块之间的松耦合，提升代码的可维护性和扩展性。同时还介绍了异步事件和事件传递的相关知识

一、介绍

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

ApplicationEvent，具体事件内容，事件抽象基类，可继承该类自定义具体事件
ApplicationEventPublisher，事件发布器，可以发布ApplicationEvent，也可以发布普通的Object对象
ApplicationListener，事件监听器，可以使用注解@EventListener
TransactionalEventListener，事务事件监听，可监听事务提交前、提交后、事务回滚、事务完成（成功或失败）

二、使用示例

不定义事件，直接发布Object对象，同步

1、定义发送事件对象

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

2、定义事件监听器

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

@Slf4j
@Component
public 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);
}

@Service
public 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
@Controller
public 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中添加异步发送方法

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

4、测试

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

控制台输出：

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

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

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

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

AFTER_COMMIT，事务提交成功后，默认
BEFORE_COMMIT，事务提交前
AFTER_ROLLBACK，事务回滚后
AFTER_COMPLETION，事务完成，AFTER_COMMIT 或 AFTER_ROLLBACK

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
@Transactional
public 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")
@ResponseBody
public void test(String name) {
    registerService.registerCommit(name);
    log.info("执行事务调用结束");
}

控制台输出：

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

总结

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

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

到此这篇关于使用Spring的ApplicationEvent实现本地事件驱动的实现方法的文章就介绍到这了,更多相关Spring ApplicationEvent本地事件驱动内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

java使用poi在excel单元格添加超链接设置字体颜色的方法
这篇文章主要介绍了java使用poi在excel单元格添加超链接，设置字体颜色,poi功能还是很强大的，基本能想到的功能都能通过poi实现，本文结合实例代码给大家介绍的非常详细，需要的朋友可以参考下
2023-09-09
Java基础教程之基本类型数据类型、包装类及自动拆装箱
这篇文章主要给大家介绍了关于Java基础教程之基本类型数据类型、包装类及自动拆装箱的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-06-06
Java使用Tessdata做OCR图片文字识别的详细思路
这篇文章主要介绍了Java使用Tessdata做OCR图片文字识别的详细思路,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-07-07
JetBrains 发布下一代 IDE无比轻量几秒就能启动干活
虽然 JetBrains 公司说 Fleet 的定位和目标并不是代替其他 IDE，但个人觉得，如果 Fleet 火起来了，其他 IDE 就会黯然失色，特别是多语言开发者，谁愿意装多个 IDE 呢？到时候，可能 JetBrains 以后的所有 IDE 要一统江湖了
2021-12-12
SpringBoot使用protobuf格式的接口方式
这篇文章主要介绍了SpringBoot使用protobuf格式的接口方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
SpringBoot之自定义Filter获取请求参数与响应结果案例详解
这篇文章主要介绍了SpringBoot之自定义Filter获取请求参数与响应结果案例详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
2021-09-09
java中1+1d/5和1+1/5的区别说明
这篇文章主要介绍了java中1+1d/5和1+1/5的区别说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10
springboot2中HikariCP连接池的相关配置问题
这篇文章主要介绍了springboot2中HikariCP连接池的相关配置问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-12-12
基于JavaMail实现邮件发送
这篇文章主要为大家详细介绍了基于JavaMail实现邮件发送功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2018-03-03
Java中LinkedHashSet的实现原理详解
这篇文章主要介绍了Java中LinkedHasSet的实现原理详解,LinkedHashSet 是具有可预知迭代顺序的 Set 接口的哈希表和链接列表实现,此实现与HashSet 的不同之处在于,后者维护着一个运行于所有条目的双重链接列表,需要的朋友可以参考下
2023-09-09