SpringBoot中事件的使用

项目中很多场景可以使用事件来对系统进行解耦，让系统更便于维护和扩展。SpringBoot项目默认是支持事件的，我们只需要自定义事件，然后发布事件，之后监听事件处理业务逻辑即可。SpringBoot中我们会用到事件抽象类ApplicaltionEvent，事件监听接口ApplicationListener，事件发布接口ApplicationEventPublisher。

本文基于用户注册成功之后发送短信以及邮件功能作为业务场景，将用户注册成功作为事件，模拟发送短信以及发送邮件作为用户注册成功事件的监听器。

定义事件

首先定义注册用户成功事件UserRegisterEvent，该事件继承ApplicationEvent抽象类，事件中定义了用户信息，当监听器监听事件后可以直接使用事件中的用户信息，代码如下：

public class UserRegisterEvent extends ApplicationEvent {
    private static final long serialVersionUID = 1L;

    private UserModel user;

    public UserRegisterEvent(Object source, UserModel user) {
        super(source);
        this.user = user;
    }

    public UserModel getUser() {
        return user;
    }
}

定义事件监听器

用户注册成功之后，需要发送短信和邮件，发送短信和邮件我们分别定义不同的事件监听器处理各自的业务逻辑，这里我们使用实现接口ApplicationListener的方式作为监听器，SpringBoot中也可以使用@EventListener注解的方式。使用实现接口ApplicationListener的方式需要将实现类交给Spring管理，所以需要使用@Component注解进行注册。默认情况下使用的是同步的方式，如果需要启用异步需要在onApplicationEvent方法上加上@Async注解。

发送短信监听器的实现代码如下：

@Component
public class UserRegisterSendSMSListener implements ApplicationListener<UserRegisterEvent> {

    private static final Logger LOGGER = LoggerFactory.getLogger(UserRegisterSendSMSListener.class);

    @Override
    public void onApplicationEvent(UserRegisterEvent userRegisterEvent) {
        // 发送短信
        LOGGER.info("新注册用户 {} 短信发送成功", userRegisterEvent.getUser().getUserName());
    }
}

 发送邮件监听器的实现代码如下：

@Component
public class UserRegisterSendEmailListener implements ApplicationListener<UserRegisterEvent> {
    private static final Logger LOGGER = LoggerFactory.getLogger(UserRegisterSendEmailListener.class);

    @Override
    public void onApplicationEvent(UserRegisterEvent userRegisterEvent) {
        // 发送短信
        LOGGER.info("新注册用户 {} 邮件发送成功", userRegisterEvent.getUser().getUserName());
    }
}

用户注册成功之后发送短信和邮件，这里我们只是模拟在日志中打出想要的发送日志，真实业务可能需要调用第三方接口发送短信以及邮件。

发布事件

我们自定了用户注册事件，以及发送短信和发送邮件监听器。现在我们需要发用户注册事件发布出去，相应的监听器监听到用户注册成功事件后才能处理各自的业务（发送短信以及发送邮件）。使用SpringBoot提供的事件发布接口ApplicationEventPublisher，在用户注册成功后，直接将用户注册成功事件发布出去。代码如下：

@RestController
@RequestMapping("user")
public class UserController {

    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    @PostMapping
    public String register(@RequestBody UserModel model) {
        // 验证

        // 注册

        // 事件
        UserRegisterEvent userRegisterEvent = new UserRegisterEvent(this, model);
        applicationEventPublisher.publishEvent(userRegisterEvent);

        return Boolean.TRUE.toString();
    }
}

测试 

至此基于SpringBoot的自定义事件整个流程已经开发完成，运行项目调用注册接口，日志中分别打出了发送短信以及发送邮件的日志。

总结

本文基于真实的注册业务场景，使用SpringBoot事件进行模拟发送短信以及邮件进行代码实现，示例代码地址：https://gitee.com/flyduck128/springboot-demo/tree/master/flyduck-event。本文仅仅介绍了SpringBoot事件的使用层面，源码层面未做深入的研究。希望本问可以给其他小伙伴提供一些帮助，如果有描述错误的地方欢迎指正。

本文参考了博客https://blog.youkuaiyun.com/likun557/article/details/106045522。