介紹

在應用程序內交換事件已成為許多應用程序中必不可少的部分，幸運的是，Spring為瞬態(tài)事件（*）提供了完整的基礎結構。 最近對事務綁定事件的重構為我提供了一個借口，以在實踐中檢查Spring 4.2中引入的新的注釋驅動事件監(jiān)聽器。 讓我們看看可以得到什么。

（*）–對于基于Spring的應用程序中的持續(xù)事件， Duramen是一個值得一看的解決方案

舊的方式

要獲取有關事件（Spring事件和自定義域事件）的onApplicationEvent ，必須創(chuàng)建一個使用onApplicationEvent實現(xiàn)ApplicationListener的組件。

@Component class OldWayBlogModifiedEventListener implementsApplicationListener<OldWayBlogModifiedEvent> {(...)@Overridepublic void onApplicationEvent(OldWayBlogModifiedEvent event) {externalNotificationSender.oldWayBlogModified(event);} }

它可以正常工作，但是對于每個事件，都必須創(chuàng)建一個新類來生成樣板代碼。

另外，我們的事件必須擴展ApplicationEvent類-Spring中所有應用程序事件的基類。

class OldWayBlogModifiedEvent extends ApplicationEvent {public OldWayBlogModifiedEvent(Blog blog) {super(blog);}public Blog getBlog() {return (Blog)getSource();} }

請注意 ，在事件中使用域對象有明顯的缺點，在許多情況下也不是最好的主意。 代碼示例中的偽域對象用于不引入不必要的復雜性。

順便說一句，在此示例中， ExternalNotificationSender是類的實例，該類向注冊用戶發(fā)送外部通知（例如，通過電子郵件，SMS或Slack）。

注釋驅動的事件偵聽器

從Spring 4.2開始，要得到有關新事件的通知，它足以在任何帶有@EventListener注釋的Spring組件中注釋一個方法。

@EventListenerpublic void blogModified(BlogModifiedEvent blogModifiedEvent) {externalNotificationSender.blogModified(blogModifiedEvent);}

在幕后，Spring將為事件創(chuàng)建一個ApplicationListener實例，該實例的類型來自方法參數(shù)。 一類中帶注釋的方法的數(shù)量沒有限制-所有相關的事件處理程序都可以分組為一個類。

條件事件處理

為了使@EventListener更加有趣，可以處理僅滿足SpEL編寫的給定條件的給定類型的那些事件。 讓我們假設以下事件類：

public class BlogModifiedEvent {private final Blog blog;private final boolean importantChange;public BlogModifiedEvent(Blog blog) {this(blog, false);}public BlogModifiedEvent(Blog blog, boolean importantChange) {this.blog = blog;this.importantChange = importantChange;}public Blog getBlog() {return blog;}public boolean isImportantChange() {return importantChange;} }

請注意，在實際的應用程序中，可能會存在Blog相關事件的層次結構。
另請注意，在Groovy中，該類要簡單得多。

要僅針對重要更改生成事件，可以使用condition參數(shù)：

@EventListener(condition = "#blogModifiedEvent.importantChange")public void blogModifiedSpEL(BlogModifiedEvent blogModifiedEvent) {externalNotificationSender.blogModifiedSpEL(blogModifiedEvent);}

寬松的事件類型層次結構

從歷史上看， ApplicationEventPublisher僅具有發(fā)布在ApplicationEvent之后繼承的對象的功能。 從Spring 4.2開始，接口已擴展為支持任何對象類型。 在這種情況下，對象將包裝在PayloadApplicationEvent并通過發(fā)送。

//base class with Blog field - no need to extend `ApplicationEvent` class BaseBlogEvent {}class BlogModifiedEvent extends BaseBlogEvent {}//somewhere in the code ApplicationEventPublisher publisher = (...); //injectedpublisher.publishEvent(new BlogModifiedEvent(blog)); //just plain instance of the event

這種變化使發(fā)布事件變得更加容易。 但是，另一方面，如果沒有內部責任感（例如，針對我們所有域事件的標記接口），則事件跟蹤會變得更加困難，尤其是在大型應用程序中。

發(fā)布事件以響應

@EventListener另一個@EventListener是，在非無效返回類型的情況下，Spring會自動發(fā)布返回的事件。

@EventListenerpublic BlogModifiedResponseEvent blogModifiedWithResponse(BlogModifiedEvent blogModifiedEvent) {externalNotificationSender.blogModifiedWithResponse(blogModifiedEvent);return new BlogModifiedResponseEvent(blogModifiedEvent.getBlog(), BlogModifiedResponseEvent.Status.OK);}

異步事件處理

已更新 。 正如RadekGr?bski正確建議的那樣 ，還值得一提的是@EventListener可以與@Async批注輕松組合以提供異步事件處理。 特定事件偵聽器中的代碼不會阻止主代碼執(zhí)行，也不會阻止其他偵聽器進行處理。

@Async //Remember to enable asynchronous method execution //in your application with @EnableAsync@EventListenerpublic void blogAddedAsync(BlogAddedEvent blogAddedEvent) {externalNotificationSender.blogAdded(blogAddedEvent);}

為了使其正常工作，通常只需要使用@EnableAsync在Spring上下文/應用程序中啟用異步方法執(zhí)行@EnableAsync 。

摘要

Spring 4.2中引入的由注釋驅動的事件偵聽器繼續(xù)保持減少基于Spring（引導）應用程序中樣板代碼的趨勢。 這種新方法看起來很有趣，特別是對于具有少量事件且維護開銷較低的小型應用程序。 在無處不在的Spring（Boot）魔術世界中，更值得記住的是，強大的力量伴隨著巨大的責任。

在下一篇博客文章中，我將寫出如何將新機制也用于簡化事務綁定事件的處理。

請注意 ，Spring Framework 4.2是Spring Boot 1.3的默認依賴項（在編寫1.3.0.M5時可用）。 另外，也可以在Gradle / Maven中為Spring Boot 1.2.5手動升級Spring Framework版本–在大多數(shù)情況下應該可以使用。

翻譯自: https://www.javacodegeeks.com/2015/10/annotation-driven-event-listeners-in-spring-4-2-2.html

總結

以上是生活随笔為你收集整理的Spring 4.2中由注释驱动的事件侦听器的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。