使用Spring事件機制實現(xiàn)異步的方法

更新時間：2018年06月21日 10:37:44 作者：Joepis

這篇文章主要介紹了使用Spring事件機制實現(xiàn)異步的方法，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

當把一個事件發(fā)布到Spring提供的ApplicationContext中，被監(jiān)聽器偵測到，就會執(zhí)行對應的處理方法。

事件本身
事件是一個自定義的類，需要繼承Spring提供的ApplicationEvent。

@Data
public class MyEvent extends ApplicationEvent {
  private String msg;

  public MyEvent(Object source, String msg) {
    super(source);
    this.msg = msg;
  }
}

事件監(jiān)聽

基本方法是實現(xiàn)ApplicationListener接口，自定義一個監(jiān)聽器，實現(xiàn)onApplicationEvent()方法，然后添加到ApplicationContext。

比如：

public class MyListener implements ApplicationListener<MyEvent> { 

  @Override 
  public void onApplicationEvent(MyEvent event) { 
    System.out.print("監(jiān)聽到MyEvent事件"); 
  } 
} 
...
// SpringBoot的啟動類中添加監(jiān)聽器
    public static void main(String[] args) {
    SpringApplication application = new SpringApplication(MyApplication.class);
    application.addListeners(new MyListener());
    application.run(args);
  }

也可以使用注解@EventListener（推薦）：原理就是通過掃描這個注解，創(chuàng)建監(jiān)聽器并添加到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();
    }
  }

}

事件發(fā)布

可以通過上下文對象的發(fā)布方法ConfigurableApplicationContext::publishEvent()來發(fā)布。

也可以實現(xiàn)ApplicationEventPublisherAware接口來發(fā)布（推薦）。

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

注意

如果2個事件之間是繼承關系，會先監(jiān)聽到子類事件，處理完再監(jiān)聽父類。

// 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時，日志如下：