美文网首页SpringFrameworkSpring Bootspring boot
使用Spring事件机制实现异步

使用Spring事件机制实现异步

作者: Joepis | 来源:发表于2018-06-16 09:55 被阅读138次

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

    事件本身

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

    @Data
    public class MyEvent extends ApplicationEvent {
        private String msg;
    
        public MyEvent(Object source, String msg) {
            super(source);
            this.msg = msg;
        }
    }
    

    事件监听

    基本方法是实现ApplicationListener接口,自定义一个监听器,实现onApplicationEvent()方法,然后添加到ApplicationContext
    比如:

    public class MyListener implements ApplicationListener<MyEvent> {  
    
        @Override  
        public void onApplicationEvent(MyEvent event) {  
            System.out.print("监听到MyEvent事件");  
        }  
    }  
    ...
    // SpringBoot的启动类中添加监听器
            public static void main(String[] args) {
            SpringApplication application = new SpringApplication(MyApplication.class);
            application.addListeners(new MyListener());
            application.run(args);
        }
    

    也可以使用注解@EventListener(推荐):原理就是通过扫描这个注解,创建监听器并添加到ApplicationContext

    @Component
    @Slf4j
    public class MyEventHandler {
    
        @EventListener
        public void handleEvent(MyEvent event) {
            log.info("------------处理事件:{}", event.getMsg());
            try {
                Thread.sleep(5 * 1000L);
                log.info("事件1(5s)处理完成");
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    
    }
    

    事件发布

    可以通过上下文对象的发布方法ConfigurableApplicationContext::publishEvent()来发布。
    也可以实现ApplicationEventPublisherAware接口来发布(推荐)。

    @Component
    @Slf4j
    public class EventService implements ApplicationEventPublisherAware {
        public ApplicationEventPublisher publisher;
    
        @Override
        public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
            this.publisher = applicationEventPublisher;
        }
    
        public String doEventWork(String msg) {
            log.info("------------publish event:" + msg);
            MyEvent event = new MyEvent(this, msg);
            publisher.publishEvent(event);
            return "OK";
        }
    }
    

    测试代码

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

    注意

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

    // MyEvent2 extends MyEvent
    
    @Component
    @Slf4j
    public class MyEventHandler {
    
        @EventListener
        public void handleEvent(MyEvent event) {
            log.info("------------处理事件:{}", event.getMsg());
            try {
                Thread.sleep(5 * 1000L);
                log.info("事件1(5s)处理完成");
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    
        @EventListener
        public void handleEvent2(MyEvent2 event) {
            log.info("------------处理事件2:{}", event.getMsg());
            try {
                Thread.sleep(10 * 1000L);
                log.info("事件2(10s)处理完成");
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
        }
    }
    

    当我publish一个子类事件MyEvent2时,日志如下:


    image

    相关文章

      网友评论

      • 淡看江湖等雨:怎么看出这是异步的?
        Joepis:默认事件是同步的,需要开启异步功能,并在需要异步的方法上使用`@Async`才会异步。
        不好意思,多谢你的提醒。:+1:

      本文标题:使用Spring事件机制实现异步

      本文链接:https://www.haomeiwen.com/subject/hjoveftx.html