Spring Event事件发布机制

使用Spring Event优雅实现业务需求。

文章目录

• 一. 什么是Spring Event
• 二. 为什么要用Spring Event
• 三. 使用Spring Event实现邮件发送

一. 什么是Spring Event

从英文释义来看，Event=事件，Spring即在Spring框架下。那么这就是一个Spring框架事件，结合生活实际来看，发生了一个事件需要被应急响应。

举个例子，我们发生了火灾事件，那么该事件需要被火警接线员知情（即有人拨打119电话告诉一声），出警（接线员通知消防员进行响应），灭火（消防员实际需要做的事情），善后（做完最主要的动作之后需要做的事情），最后撤退（结束）。

这里的每一件事都是关联在一起的，而对于第一个发现火情的人需要参与每一个环节吗，答案是不需要，他只需要拿起电话拨打119并告诉接线员发生火情的地点，后续的事情就开始运转起来了。

这就是Spring Event事件通知机制的原理：

1. 定义一个事件
2. 定义一个事件监听
3. 定义一个事件推送

二. 为什么要用Spring Event

假设我们推翻Event事件通知机制，继续回到我们上述的火警事件中，没有火警接线员（没有事件监听），发现火情的人打119发现没有人接听了，这个时候就需要让发现火情的人吭哧吭哧跑到消防队办公室，大喊一声哪里有火情快去灭火。

这里就会引申出两个问题：

1. 事件发现者除了发现火情，还需要关注实际处理问题的人住处在哪里
2. 等到通知消防队员，火情可能都已经过去了

回到我们写代码的设计模式原则，我们知道代码之间需要高内聚低耦合。所以解耦是很重要的，即多方之间互不影响。而引入事件机制就只需要关注事件本身，至于具体谁去处理，谁去处理就让后续流程来决定。

三. 使用Spring Event实现邮件发送

1. 自定义邮箱事件：定义相关事件所需要的属性

   /**

   • <自定义邮箱事件>
     */
     public class EmailEvent extends ApplicationEvent {
     // 标题
     private String subject;
     // 内容
     private String content;
     // 发件人
     private String sender;
     // 授权码
     private String authorizationCode;
     // 收件人
     private String receiver;

     /**

     • @param source
       */
       public EmailEvent(Object source) {
       super(source);

     }

     public EmailEvent(Object source,String subject, String content, String receiver) {
     super(source);
     this.subject = subject;
     this.content = content;
     this.receiver = receiver;
     }

     public String getSubject() {
     return subject;
     }

     public void setSubject(String subject) {
     this.subject = subject;
     }

     public String getContent() {
     return content;
     }

     public void setContent(String content) {
     this.content = content;
     }

     public String getAuthorizationCode() {
     return authorizationCode;
     }

     public void setAuthorizationCode(String authorizationCode) {
     this.authorizationCode = authorizationCode;
     }

     public String getSender() {
     return sender;
     }

     public void setSender(String sender) {
     this.sender = sender;
     }

     public String getReceiver() {
     return receiver;
     }

     public void setReceiver(String receiver) {
     this.receiver = receiver;
     }

   }

2. 设置事件推送（这里使用了异步非阻塞发送，详见监听器）

   /**

   • ApplicationEventPublisher邮件推送
     */
     @Component
     public class SendmaillEventPublisher {

     @Autowired
     private ApplicationEventPublisher publisher;

     public void sendMailAsync(String subject, String content, String email) {
     publisher.publishEvent(new EmailEvent(this,subject, content, email));

     }

   }

3. 事件监听器（使用@Async(“taskExecutor”)注解实现异步）

   /**

   • 〈邮箱发送〉

   • 发送邮件
     */
     @Component
     public class SendmailListener implements ApplicationListener {

     @Override
     @Async(“taskExecutor”)
     public void onApplicationEvent(EmailEvent emailEvent) {
     if (emailEvent == null) {
     return ;
     }
     System.out.println(“开始发送邮件…” + emailEvent.getContent());
     // 除了发送邮件支持做一些其他的事情…模拟长时间处理事务
     try {
     Thread.sleep(2000);
     } catch (InterruptedException e) {
     e.printStackTrace();
     }
     System.out.println(“发送邮件结束…” + emailEvent.getContent());
     }
     }

4. 测试事件发布

   @RestController
   public class MailEventController {

   @Autowired
   SendmaillEventPublisher publisher;
   
   /**
    * 异步邮件发送
    * @return
    */
   @GetMapping("sendMailAsync")
   public String sendMailAsync(String content){
       publisher.sendMailAsync("subject", content, "xxx@xxx.com");
       publisher.sendMailAsync("subject", content, "xxx@xxx.com");
       return "success";
   }
   

   }

以上就是一个简单的事件发布实现。

参考资料：

• Spring Event的同步和异步，以及实现机制
• Spring event 使用指南
• SpringBoot使用ApplicationEvent&Listener完成业务解耦
• 邮件发送spring boot+ApplicationEventPublisher+线程池异步实现邮件发送
• 接口回调

先自我介绍一下，小编13年上师交大毕业，曾经在小公司待过，去过华为OPPO等大厂，18年进入阿里，直到现在。深知大多数初中级java工程师，想要升技能，往往是需要自己摸索成长或是报班学习，但对于培训机构动则近万元的学费，着实压力不小。自己不成体系的自学效率很低又漫长，而且容易碰到天花板技术停止不前。因此我收集了一份《java开发全套学习资料》送给大家，初衷也很简单，就是希望帮助到想自学又不知道该从何学起的朋友，同时减轻大家的负担。添加下方名片，即可获取全套学习资料哦