Spring Boot應用程式事件教程 - reflectoring

事件與直接方法呼叫
事件和直接方法呼叫都適合於不同的情況。對於方法呼叫，這就像斷言一樣，無論傳送和接收模組的狀態如何，他們都需要知道此事件的發生。
另一方面，對於事件，我們只是說發生了一個事件，並且通知了哪些模組不是我們關心的問題。當我們想將處理傳遞給另一個執行緒時，最好使用事件（例如：在完成某些任務時傳送電子郵件）。同樣，事件對於測試驅動的開發非常有用。

事件用於在松耦合的元件之間交換資訊。由於釋出者和訂閱者之間沒有直接耦合，因此我們可以修改訂閱者而不影響釋出者，反之亦然。讓我們看看如何在Spring Boot應用程式中建立，釋出和收聽自定義事件。

1. 建立一個 ApplicationEvent
我們可以使用Spring Framework的事件釋出機制來發布應用程式事件。
讓我們建立一個UserCreatedEvent透過擴充套件呼叫的自定義事件ApplicationEvent：

class UserCreatedEvent extends ApplicationEvent {
  private String name;

  UserCreatedEvent(Object source, String name) {
    super(source);
    this.name = name;
  }
  ...
}

class UserRemovedEvent {
  private String name;

  UserRemovedEvent(String name) {
    this.name = name;
  }
  ...
}

@Component
class Publisher {
  
  private final ApplicationEventPublisher publisher;
    
    Publisher(ApplicationEventPublisher publisher) {
      this.publisher = publisher;
    }

  void publishEvent(final String name) {
    // Publishing event created by extending ApplicationEvent
    publisher.publishEvent(new UserCreatedEvent(this, name));
    // Publishing an object as an event
    publisher.publishEvent(new UserRemovedEvent(name));
  }
}

@Component
class UserRemovedListener {

  @EventListener
  ReturnedEvent handleUserRemovedEvent(UserRemovedEvent event) {
    // handle UserRemovedEvent ...
    return new ReturnedEvent();
  }

  @EventListener
  void handleReturnedEvent(ReturnedEvent event) {
        // handle ReturnedEvent ...
  }
  ...
}

@Component
class UserRemovedListener {

  @EventListener(condition = "event.name eq 'reflectoring'")
  void handleConditionalListener(UserRemovedEvent event) {
    // handle UserRemovedEvent
  }
}

@Component
class UserCreatedListener implements ApplicationListener<UserCreatedEvent> {

  @Override
  public void onApplicationEvent(UserCreatedEvent event) {
    // handle UserCreatedEvent
  }
}

非同步事件監聽器
預設情況下，spring事件是同步的，這意味著釋出者執行緒將阻塞，直到所有偵聽器都完成對事件的處理為止。
要使事件偵聽器以非同步模式執行，我們要做的就是@Async在該偵聽器上使用註釋：

@Component
class AsyncListener {

  @Async
  @EventListener
  void handleAsyncEvent(String event) {
    // handle event
  }
}

事務繫結事件
Spring允許我們將事件偵聽器繫結到當前事務的某個階段。噹噹前事務的結果對偵聽器很重要時，這使事件可以更靈活地使用。
當我們使用註釋我們的方法時@TransactionalEventListener，我們得到了一個擴充套件的事件監聽器，該監聽器知道事務：

@Component
class UserRemovedListener {

  @TransactionalEventListener(phase=TransactionPhase.AFTER_COMPLETION)
  void handleAfterUserRemoved(UserRemovedEvent event) {
    // handle UserRemovedEvent
  }
}

• AFTER_COMMIT：成功提交事務後，將處理該事件。如果事件偵聽器僅在當前事務成功時才執行，則可以使用此方法。
• AFTER_COMPLETION：在事務提交或回滾時將處理該事件。例如，我們可以使用它在事務完成後執行清理。
• AFTER_ROLLBACK：交易回滾後，將處理該事件。
• BEFORE_COMMIT：事件將在事務提交之前處理。例如，我們可以使用它來將事務性O / R對映會話重新整理到資料庫。

Spring Boot的應用程式事件
以上是Spring事件，Spring Boot提供了幾個預定義ApplicationEvent的，這些預定義繫結到SpringApplication生命週期。
在ApplicationContext建立之前會觸發一些事件，因此我們無法將這些事件註冊為@Bean。我們可以透過手動新增偵聽器來註冊這些事件的偵聽器：

@SpringBootApplication
public class EventsDemoApplication {

  public static void main(String[] args) {
    SpringApplication springApplication = 
        new SpringApplication(EventsDemoApplication.class);
    springApplication.addListeners(new SpringBuiltInEventsListener());
    springApplication.run(args);
  }

}

class SpringBuiltInEventsListener 
    implements ApplicationListener<SpringApplicationEvent>{

  @Override
  public void onApplicationEvent(SpringApplicationEvent event) {
    // handle event
  }
}

ApplicationStartingEvent
ApplicationStartingEvent在執行開始時但在任何處理之前都會觸發，除了偵聽器和初始化程式的註冊外。

ApplicationEnvironmentPreparedEvent
當Environment在上下文中是可用的，一個ApplicationEnvironmentPreparedEvent被觸發，由於此時Environment將準備就緒，因此我們可以在其他bean使用它之前對其進行檢查和修改。

ApplicationContextInitializedEvent
ApplicationContext已準備就緒時，一個ApplicationContextInitializedEvent觸發，ApplicationContextInitializers被稱為尚未載入bean定義。在bean初始化到Spring容器之前，我們可以使用它執行任務。

ApplicationPreparedEvent
當ApllicationContext準備就緒時，一個ApplicationPreparedEvent時會觸發，但不會重新整理。
在準備好的Environment和bean定義將被載入。

ContextRefreshedEvent
當ApplicationContext重新整理時，ContextRefreshedEvent會觸發。
ContextRefreshedEvent是直接來自Spring，而不是Spring Boot，並不繼承擴充套件SpringApplicationEvent。

WebServerInitializedEvent
如果我們使用的是Web伺服器，WebServerInitializedEvent則在Web伺服器準備就緒後會觸發a。ServletWebServerInitializedEvent和ReactiveWebServerInitializedEvent分別是servlet和反應式變數。
WebServerInitializedEvent不是繼承擴充套件SpringApplicationEvent。

ApplicationStartedEvent
上下文已被重新整理之後，一個ApplicationStartedEvent觸發，但在任何Spring boot應用程式和命令列執行都被呼叫前。

ApplicationReadyEvent
一個ApplicationReadyEvent觸發時就表示該應用程式已準備好服務請求。
建議此時不要修改內部狀態，因為所有初始化步驟都將完成。

ApplicationFailedEvent
一個ApplicationFailedEvent如果有異常，應用程式無法啟動點火。在啟動期間的任何時間都可能發生這種情況。我們可以使用它來執行一些任務，例如執行指令碼或在啟動失敗時發出通知。

結論
事件被設計為在同一應用程式上下文中在Spring bean之間進行簡單的通訊。從Spring 4.2開始，基礎結構已得到顯著改進，並提供了基於註釋的模型以及釋出任意事件的功能。
您可以在GitHub上找到示例程式碼。