SpringBoot如何發布ApplicationEventPublisher和監聽ApplicationEvent事件

這篇文章給大家分享的是有關SpringBoot如何發布ApplicationEventPublisher和監聽ApplicationEvent事件的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

實現方法

1. 自定義需要發布的事件類，需要繼承ApplicationEvent類或PayloadApplicationEvent<T>(該類也僅僅是對ApplicationEvent的一層封裝)

2. 使用@EventListener來監聽事件

3. 使用ApplicationEventPublisher來發布自定義事件（@Autowired注入即可）

/**
 * 自定義保存事件
 * @author peter
 * 2019/1/27 14:59
 */
public class PersonSaveEvent<DATA> extends ApplicationEvent {
  private DATA data;

  public PersonSaveEvent(DATA source) {
    super(source);
    this.data = source;
  }

  public DATA getData() {
    return data;
  }
}

//發布事件
public void savePerson(Person person){
  personDao.save(person);
  publisher.publishEvent(new PersonSaveEvent<>(1));
}
//監聽事件
@EventListener
public void listenEvent(PersonSaveEvent<Integer> event) {
   System.out.println("監聽到PersonSaveEvent事件; 接收到的值：" + event.getData() + "；發布的時間為" + Instant.ofEpochMilli(event.getTimestamp()));
}

好處

可以使核心業務與子業務進行解耦，也方便后期的業務的擴展。如新用戶注冊之后，需要發放優惠券，此時可以在保存用戶之后，發布一個新用戶的注冊成功事件，通過監聽該事件來實現發放優惠券的功能。后期新增一個對新用戶進行xxx功能，此時可以新寫一個監聽注冊成功事件的監聽器，來處理新的業務邏輯，而不需要修改之前的注冊邏輯。

注意事項

1、監聽器方法中一定要try-catch異常，否則會造成發布事件(有事物的)的方法進行回滾
2、可以使用@Order注解來控制多個監聽器的執行順序，@Order傳入的值越小，執行順序越高
3、對于需要進行事物監聽或不想try-catch runtime異常，可以使用@TransactionalEventListener注解

@TransactionalEventListener 監聽器

在該注解的源碼中：

 * <p>If the event is not published within the boundaries of a managed transaction, the
 * event is discarded unless the {@link #fallbackExecution} flag is explicitly set. If a
 * transaction is running, the event is processed according to its {@code TransactionPhase}.

大意是：如果事件的發布不是在事物（@Transactional）范圍內，則監聽不到該事件，除非將fallbackExecution標志設置為true（@TransactionalEventListener(fallbackExecution = true)）;如果在事物中，可以選擇在事物的哪個階段來監聽事件，默認在事物提交后監聽。

修改監聽事物的范圍：@TransactionalEventListener(phase = TransactionPhase.AFTER_COMPLETION)

在監聽器中重新開一個事物

 @TransactionalEventListener(phase = TransactionPhase.AFTER_COMPLETION)
  public void listenEvent1(PersonSaveEvent<Integer> event) {
    divide(event);
  }
  @Transactional(propagation = Propagation.REQUIRES_NEW)
  public void divide(PersonSaveEvent<Integer> event) {
    System.out.println("監聽到PersonSaveEvent事件; 接收到的值：" + event.getData() + "；接受的時間為" + Instant.ofEpochMilli(event.getTimestamp()));
  }

以上事件都是同步，如果需要異步則需要開啟異步支持，在監聽器方法加上@Async 注解即可。

/**
 * @author peter
 * @version 1.0
 * @date 2019/04/18 08:47
 */
@Configuration
@EnableAsync
public class AsyncEventConfiguration implements AsyncConfigurer {
  @Override
  public Executor getAsyncExecutor() {
    return Executors.newCachedThreadPool();
  }
}

一旦開始異步執行，方法的異常將不會拋出，只能在方法內部處理。

感謝各位的閱讀！關于“SpringBoot如何發布ApplicationEventPublisher和監聽ApplicationEvent事件”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！