SpringBoot 异步事件实现异步（ApplicationEventPublisher、ApplicationEvent)

左手的ㄟ右手 2021-09-03 09:39 2023阅读 1赞

demo参考：[https://blog.csdn.net/qq\_28060549/article/details/81073001][https_blog.csdn.net_qq_28060549_article_details_81073001]

内置事件参考：[https://blog.csdn.net/liyantianmin/article/details/81017960][https_blog.csdn.net_liyantianmin_article_details_81017960]

<table> 
 <tbody> 
 <tr> 
 <th>序号</th> 
 <th>Spring 内置事件 &amp; 描述</th> 
 </tr> 
 <tr> 
 <td>1</td> 
 <td> ContextRefreshedEvent ApplicationContext&nbsp;被初始化或刷新时，该事件被发布。这也可以在&nbsp;ConfigurableApplicationContext接口中使用 refresh() 方法来发生。此处的初始化是指：所有的Bean被成功装载，后处理Bean被检测并激活，所有Singleton Bean 被预实例化，ApplicationContext容器已就绪可用 </td> 
 </tr> 
 <tr> 
 <td>2</td> 
 <td> ContextStartedEvent 当使用&nbsp;ConfigurableApplicationContext&nbsp;（ApplicationContext子接口）接口中的 start() 方法启动&nbsp;ApplicationContext&nbsp;时，该事件被发布。你可以调查你的数据库，或者你可以在接受到这个事件后重启任何停止的应用程序。 </td> 
 </tr> 
 <tr> 
 <td>3</td> 
 <td> ContextStoppedEvent 当使用&nbsp;ConfigurableApplicationContext&nbsp;接口中的 stop() 停止&nbsp;ApplicationContext&nbsp;时，发布这个事件。你可以在接受到这个事件后做必要的清理的工作。 </td> 
 </tr> 
 <tr> 
 <td>4</td> 
 <td> ContextClosedEvent 当使用&nbsp;ConfigurableApplicationContext&nbsp;接口中的 close() 方法关闭&nbsp;ApplicationContext&nbsp;时，该事件被发布。一个已关闭的上下文到达生命周期末端；它不能被刷新或重启。 </td> 
 </tr> 
 <tr> 
 <td>5</td> 
 <td> RequestHandledEvent 这是一个 web-specific 事件，告诉所有 bean HTTP 请求已经被服务。只能应用于使用DispatcherServlet的Web应用。在使用Spring作为前端的MVC控制器时，当Spring处理用户请求结束后，系统会自动触发该事件。 </td> 
 </tr> 
 </tbody> 
</table>

## SpringBoot 异步事件实现异步（ApplicationEventPublisher、ApplicationEvent) ##

当把一个事件发布到Spring提供的`ApplicationContext`中，被监听器侦测到，就会执行对应的处理方法。

实现步骤：

*  自定义发布的事件类，需要继承 ApplicationEvent 或者PayloadApplicationEvent(该类也仅仅是对ApplicationEvent的一层封装)
 *  监听事件 使用注解 @EventListener 或者 自定义监听器在主函数添加监听器
 *  s使用ApplicationEventPublisher 或者 实现其接口的子类 发布自定义事件 （@Autowired注入即可）

# 一、事件本身 ApplicationEvent #

事件是一个自定义的类，需要继承Spring提供的`ApplicationEvent`。

import com.alibaba.fastjson.JSONObject;
    import org.springframework.context.ApplicationEvent;
    
    /**
     * 自定义 事件
     * @author 王泽华
     * 2019/10/22 14:59
     */
    public class EsSaveEvent extends ApplicationEvent {
    
        private JSONObject data;
    
        public EsSaveEvent(JSONObject source) {
            super(source);
            this.data = source;
        }
    
        public JSONObject getData() {
            return data;
        }
    }

# 二、事件监听 #

## 1、自定义监听器 ##

基本方法是实现`ApplicationListener`接口，自定义一个监听器，实现`onApplicationEvent()`方法，然后添加到`ApplicationContext`。

import org.springframework.context.ApplicationListener;
 
 public class MyListener implements ApplicationListener<EsSaveEvent> {
 
 @Override 
 public void onApplicationEvent(EsSaveEvent event) {
 //事件处理
 System.out.print("监听到MyEvent事件"); 
 } 
 }

注意：需要在springboot 启动类添加监听器，如下所示：

public static void main(String[] args) {
        SpringApplication application = new SpringApplication(MyApplication.class);
        SpringBoot的启动类中添加监听器
        application.addListeners(new MyListener());
        application.run(args);
     }

## 2、使用注解`@EventListener`（推荐）： ##

原理就是通过扫描这个注解，创建监听器并添加到`ApplicationContext`。

import com.alibaba.fastjson.JSONObject;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    import org.springframework.transaction.annotation.Propagation;
    import org.springframework.transaction.annotation.Transactional;
    
    import java.util.Arrays;
    import java.util.List;
    
    /**
     * @author :王泽华
     * @Title: EventListener
     * @date 2019/10/2214:18
     */
    @Component
    public class EventListener {
    
        //监听事件
        @org.springframework.context.event.EventListener
        public void listenEvent(EsSaveEvent  event) {
            //可以添加事务处理
            //divide(event);
            JSONObject object = event.getData();
            //对数据进行处理
             System.out.println("data:"+object.toJSONString());
            }
    
        }
    
        //在监听器中重新开一个事务（可选）
        @Transactional(propagation = Propagation.REQUIRES_NEW)
        public void divide(EsSaveEvent event) {
            System.out.println("事务处理");
        }
    
    
    }

# 三、事件发布 #

事件发布可以用springboot内部类 也可以自定义

## 1、直接注入 ApplicationEventPublisher ##

使用 ApplicationEventPublisher，注入ApplicationEventPublisher接口，调用publisher.publishEvent(new EsSaveEvent(data)) 发布事件。

@Autowired
    private ApplicationEventPublisher publisher;
    
    public test(){
    	JSONObject data=new JSONObject();
        publisher.publishEvent(new EsSaveEvent(data));
    }

## 2、自定义事件发布类(继承ApplicationEventPublisher) ##

A、实现 ApplicationEventPublisher

import com.alibaba.fastjson.JSONObject;
    import org.springframework.context.ApplicationEventPublisher;
    import org.springframework.context.ApplicationEventPublisherAware;
    import org.springframework.stereotype.Component;
    
    @Component
    public class EventService implements ApplicationEventPublisherAware {    
        public ApplicationEventPublisher publisher;    
        @Override
        public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
            this.publisher = applicationEventPublisher;
        }
        public String doEventWork(String msg) {
            JSONObject data=new JSONObject();
            data.put("message","------------publish event:" + msg);
            EsSaveEvent event = new EsSaveEvent(data);
            publisher.publishEvent(event);
            return "OK";
        }
    }

B、测试

@SpringBootTest
    @RunWith(SpringRunner.class)
    public class EventServiceTest {
        @Autowired
        private EventService service;
        @Test
        public void eventTest() {
            String msg="Java Code";
            service.doEventWork(msg);
        }
    }

# 四、注意事项： #

1、如果2个事件之间是继承关系，会先监听到子类事件，处理完再监听父类。

2、监听器方法一定要try-catchy异常，否则会造成发布事件（有事务的）的方法进行回滚

3、可以使用@Order注解控制多个监听器的执行顺序，@Order 传入的值越小，执行顺序越高

[https_blog.csdn.net_qq_28060549_article_details_81073001]: https://blog.csdn.net/qq_28060549/article/details/81073001
[https_blog.csdn.net_liyantianmin_article_details_81017960]: https://blog.csdn.net/liyantianmin/article/details/81017960