前面我們講到了Spring在進行事務邏輯織入的時候，無論是事務開始，提交或者回滾，都會觸發相應的事務事件。本文首先會使用實例進行講解Spring事務事件是如何使用的，然後會講解這種使用方式的實現原理。
1. 示例
對於事務事件，Spring提供了一個註解@TransactionEventListener，將這個註解標註在某個方法上，那麼就將這個方法聲明爲了一個事務事件處理器，而具體的事件類型則是由TransactionalEventListener.phase屬性進行定義的。如下是TransactionalEventListener的聲明：
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})@Retention(RetentionPolicy.RUNTIME)@Documented@EventListenerpublic@interfaceTransactionalEventListener {// 指定當前標註方法處理事務的類型TransactionPhasephase()defaultTransactionPhase.AFTER_COMMIT;// 用於指定當前方法如果沒有事務，是否執行相應的事務事件監聽器booleanfallbackExecution()defaultfalse;// 與classes屬性一樣，指定了當前事件傳入的參數類型，指定了這個參數之後就可以在監聽方法上// 直接什麼一個這個參數了@AliasFor(annotation = EventListener.class, attribute ="classes")Class[] value()default{};// 作用於value屬性一樣，用於指定當前監聽方法的參數類型@AliasFor(annotation = EventListener.class, attribute ="classes")Class[] classes()default{};// 這個屬性使用Spring Expression Language對目標類和方法進行匹配，對於不匹配的方法將會過濾掉Stringcondition()default"";}
關於這裏的classes屬性需要說明一下，如果指定了classes屬性，那麼當前監聽方法的參數類型就可以直接使用所發佈的事件的參數類型，如果沒有指定，那麼這裏監聽的參數類型可以使用兩種：ApplicationEvent和PayloadApplicationEvent。對於ApplicationEvent類型的參數，可以通過其getSource()方法獲取發佈的事件參數，只不過其返回值是一個Object類型的，如果想獲取具體的類型還需要進行強轉；對於PayloadApplicationEvent類型，其可以指定一個泛型參數，該泛型參數必須與發佈的事件的參數類型一致，這樣就可以通過其getPayload()方法獲取事務事件發佈的數據了。關於上述屬性中的TransactionPhase，其可以取如下幾個類型的值：
publicenumTransactionPhase {// 指定目標方法在事務commit之前執行BEFORE_COMMIT,// 指定目標方法在事務commit之後執行AFTER_COMMIT,// 指定目標方法在事務rollback之後執行AFTER_ROLLBACK,// 指定目標方法在事務完成時執行，這裏的完成是指無論事務是成功提交還是事務回滾了AFTER_COMPLETION}
這裏我們假設數據庫有一個user表，對應的有一個UserService和User的model，用於往該表中插入數據，並且插入動作時使用註解標註目標方法。如下是這幾個類的聲明：
publicclassUser{privatelongid;privateString name;privateintage;// getter and setter...}
@Service@TransactionalpublicclassUserServiceImplimplementsUserService{@AutowiredprivateJdbcTemplate jdbcTemplate;@AutowiredprivateApplicationEventPublisher publisher;@Overridepublicvoidinsert(User user){ jdbcTemplate.update("insert into user (id, name, age) value (?, ?, ?)", user.getId(), user.getName(), user.getAge()); publisher.publishEvent(user); }}
上述代碼中有一點需要注意的是，對於需要監控事務事件的方法，在目標方法執行的時候需要使用ApplicationEventPublisher發佈相應的事件消息。如下是對上述消息進行監控的程序：
@ComponentpublicclassUserTransactionEventListener{@TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT)publicvoidbeforeCommit(PayloadApplicationEvent event){ System.out.println("before commit, id: "+ event.getPayload().getId()); }@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)publicvoidafterCommit(PayloadApplicationEvent event){ System.out.println("after commit, id: "+ event.getPayload().getId()); }@TransactionalEventListener(phase = TransactionPhase.AFTER_COMPLETION)publicvoidafterCompletion(PayloadApplicationEvent event){ System.out.println("after completion, id: "+ event.getPayload().getId()); }@TransactionalEventListener(phase = TransactionPhase.AFTER_ROLLBACK)publicvoidafterRollback(PayloadApplicationEvent event){ System.out.println("after rollback, id: "+ event.getPayload().getId()); }}
這裏對於事件的監控，只需要在監聽方法上添加@TransactionalEventListener註解即可。這裏需要注意的一個問題，在實際使用過程中，對於監聽的事務事件，需要使用其他的參數進行事件的過濾，因爲這裏的監聽還是會監聽所有事件參數爲User類型的事務，而無論其是哪個位置發出來的。如果需要對事件進行過濾，這裏可以封裝一個UserEvent對象，其內保存一個類似EventType的屬性和一個User對象，這樣在發佈消息的時候就可以指定EventType屬性，而在監聽消息的時候判斷當前方法監聽的事件對象的EventType是否爲目標type，如果是，則對其進行處理，否則直接略過。下面是上述程序的xml文件配置和驅動程序：
publicclassTransactionApp{@TestpublicvoidtestTransaction(){ ApplicationContext ac =newClassPathXmlApplicationContext("applicationContext.xml"); UserService userService = context.getBean(UserService.class); User user = getUser(); userService.insert(user); }privateUsergetUser(){intid =newRandom() .nextInt(1000000); User user =newUser(); user.setId(id); user.setName("Mary"); user.setAge(27);returnuser; }}
運行上述程序，其執行結果如下：
before commit, id:935052after commit, id:935052after completion, id:935052
可以看到，這裏確實成功監聽了目標程序的相關事務行爲。
2. 實現原理
關於事務的實現原理，這裏其實是比較簡單的，在前面的文章中，我們講解到，Spring對事務監控的處理邏輯在TransactionSynchronization中，如下是該接口的聲明：
publicinterfaceTransactionSynchronizationextendsFlushable{// 在當前事務掛起時執行defaultvoidsuspend(){}// 在當前事務重新加載時執行defaultvoidresume(){}// 在當前數據刷新到數據庫時執行defaultvoidflush(){}// 在當前事務commit之前執行defaultvoidbeforeCommit(booleanreadOnly){}// 在當前事務completion之前執行defaultvoidbeforeCompletion(){}// 在當前事務commit之後實質性defaultvoidafterCommit(){}// 在當前事務completion之後執行defaultvoidafterCompletion(intstatus){}}
很明顯，這裏的TransactionSynchronization接口只是抽象了一些行爲，用於事務事件發生時觸發，這些行爲在Spring事務中提供了內在支持，即在相應的事務事件時，其會獲取當前所有註冊的TransactionSynchronization對象，然後調用其相應的方法。那麼這裏TransactionSynchronization對象的註冊點對於我們瞭解事務事件觸發有至關重要的作用了。這裏我們首先回到事務標籤的解析處，在前面講解事務標籤解析時，我們講到Spring會註冊一個TransactionalEventListenerFactory類型的bean到Spring容器中，這裏關於標籤的解析讀者可以閱讀本人前面的文章Spring事務用法示例與實現原理。這裏註冊的TransactionalEventListenerFactory實現了EventListenerFactory接口，這個接口的主要作用是先判斷目標方法是否是某個監聽器的類型，然後爲目標方法生成一個監聽器，其會在某個bean初始化之後由Spring調用其方法用於生成監聽器。如下是該類的實現：
publicclassTransactionalEventListenerFactoryimplementsEventListenerFactory,Ordered{// 指定當前監聽器的順序privateintorder =50;publicvoidsetOrder(intorder){this.order = order; }@OverridepublicintgetOrder(){returnthis.order; }// 指定目標方法是否是所支持的監聽器的類型，這裏的判斷邏輯就是如果目標方法上包含有// TransactionalEventListener註解，則說明其是一個事務事件監聽器@OverridepublicbooleansupportsMethod(Method method){return(AnnotationUtils.findAnnotation(method, TransactionalEventListener.class) !=null); }// 爲目標方法生成一個事務事件監聽器，這裏ApplicationListenerMethodTransactionalAdapter實現了// ApplicationEvent接口@OverridepublicApplicationListener createApplicationListener(String beanName, Class type, Method method) {returnnewApplicationListenerMethodTransactionalAdapter(beanName, type, method); }}
這裏關於事務事件監聽的邏輯其實已經比較清楚了。ApplicationListenerMethodTransactionalAdapter本質上是實現了ApplicationListener接口的，也就是說，其是Spring的一個事件監聽器，這也就是爲什麼進行事務處理時需要使用ApplicationEventPublisher.publish()方法發佈一下當前事務的事件。
ApplicationListenerMethodTransactionalAdapter在監聽到發佈的事件之後會生成一個TransactionSynchronization對象，並且將該對象註冊到當前事務邏輯中，如下是監聽事務事件的處理邏輯：
@OverridepublicvoidonApplicationEvent(ApplicationEvent event){// 如果當前TransactionManager已經配置開啓事務事件監聽，// 此時纔會註冊TransactionSynchronization對象if(TransactionSynchronizationManager.isSynchronizationActive()) {// 通過當前事務事件發佈的參數，創建一個TransactionSynchronization對象TransactionSynchronization transactionSynchronization = createTransactionSynchronization(event);// 註冊TransactionSynchronization對象到TransactionManager中TransactionSynchronizationManager .registerSynchronization(transactionSynchronization); }elseif(this.annotation.fallbackExecution()) {// 如果當前TransactionManager沒有開啓事務事件處理，但是當前事務監聽方法中配置了// fallbackExecution屬性爲true，說明其需要對當前事務事件進行監聽，無論其是否有事務if(this.annotation.phase() == TransactionPhase.AFTER_ROLLBACK && logger.isWarnEnabled()) { logger.warn("Processing "+ event +" as a fallback execution on AFTER_ROLLBACK phase"); } processEvent(event); }else{// 走到這裏說明當前是不需要事務事件處理的，因而直接略過if(logger.isDebugEnabled()) { logger.debug("No transaction is active - skipping "+ event); } }}
這裏需要說明的是，上述annotation屬性就是在事務監聽方法上解析的TransactionalEventListener註解中配置的屬性。可以看到，對於事務事件的處理，這裏創建了一個TransactionSynchronization對象，其實主要的處理邏輯就是在返回的這個對象中，而createTransactionSynchronization()方法內部只是創建了一個TransactionSynchronizationEventAdapter對象就返回了。這裏我們直接看該對象的源碼：
privatestaticclassTransactionSynchronizationEventAdapterextendsTransactionSynchronizationAdapter{privatefinalApplicationListenerMethodAdapter listener;privatefinalApplicationEvent event;privatefinalTransactionPhase phase;publicTransactionSynchronizationEventAdapter(ApplicationListenerMethodAdapter
listener, ApplicationEvent event, TransactionPhase phase){this.listener = listener;this.event = event;this.phase = phase; }@OverridepublicintgetOrder(){returnthis.listener.getOrder(); }// 在目標方法配置的phase屬性爲BEFORE_COMMIT時，處理before commit事件publicvoidbeforeCommit(booleanreadOnly){if(this.phase == TransactionPhase.BEFORE_COMMIT) { processEvent(); } }// 這裏對於after completion事件的處理，雖然分爲了三個if分支，但是實際上都是執行的processEvent()// 方法，因爲after completion事件是事務事件中一定會執行的，因而這裏對於commit，// rollback和completion事件都在當前方法中處理也是沒問題的publicvoidafterCompletion(intstatus){if(this.phase == TransactionPhase.AFTER_COMMIT && status == STATUS_COMMITTED) { processEvent(); }elseif(this.phase == TransactionPhase.AFTER_ROLLBACK && status == STATUS_ROLLED_BACK) { processEvent(); }elseif(this.phase == TransactionPhase.AFTER_COMPLETION) { processEvent(); } }// 執行事務事件protectedvoidprocessEvent(){this.listener.processEvent(this.event); }}
可以看到，對於事務事件的處理，最終都是委託給了ApplicationListenerMethodAdapter.processEvent()方法進行的。如下是該方法的源碼：
publicvoidprocessEvent(ApplicationEvent event){// 處理事務事件的相關參數，這裏主要是判斷TransactionalEventListener註解中是否配置了value// 或classes屬性，如果配置了，則將方法參數轉換爲該指定類型傳給監聽的方法；如果沒有配置，則判斷// 目標方法是ApplicationEvent類型還是PayloadApplicationEvent類型，是則轉換爲該類型傳入Object[] args = resolveArguments(event);// 這裏主要是獲取TransactionalEventListener註解中的condition屬性，然後通過// Spring expression language將其與目標類和方法進行匹配if(shouldHandle(event, args)) {// 通過處理得到的參數藉助於反射調用事務監聽方法Object result = doInvoke(args);if(result !=null) {// 對方法的返回值進行處理handleResult(result); }else{ logger.trace("No result object given - no result to handle"); } }}// 處理事務監聽方法的參數protectedObject[] resolveArguments(ApplicationEvent event) {// 獲取發佈事務事件時傳入的參數類型ResolvableType declaredEventType = getResolvableType(event);if(declaredEventType ==null) {returnnull; }// 如果事務監聽方法的參數個數爲0，則直接返回if(this.method.getParameterCount() ==0) {returnnewObject[0]; }// 如果事務監聽方法的參數不爲ApplicationEvent或PayloadApplicationEvent，則直接將發佈事務// 事件時傳入的參數當做事務監聽方法的參數傳入。從這裏可以看出，如果事務監聽方法的參數不是// ApplicationEvent或PayloadApplicationEvent類型，那麼其參數必須只能有一個，並且這個// 參數必須與發佈事務事件時傳入的參數一致Class eventClass = declaredEventType.getRawClass();if((eventClass ==null|| !ApplicationEvent.class.isAssignableFrom(eventClass)) && eventinstanceofPayloadApplicationEvent) {returnnewObject[] {((PayloadApplicationEvent) event).getPayload()}; }else{// 如果參數類型爲ApplicationEvent或PayloadApplicationEvent，則直接將其傳入事務事件方法returnnewObject[] {event}; }}// 判斷事務事件方法方法是否需要進行事務事件處理privatebooleanshouldHandle(ApplicationEvent event, @Nullable Object[] args){if(args ==null) {returnfalse; } String condition = getCondition();if(StringUtils.hasText(condition)) { Assert.notNull(this.evaluator,"EventExpressionEvaluator must no be null"); EvaluationContext evaluationContext =this.evaluator.createEvaluationContext( event,this.targetClass,this.method, args,this.applicationContext);returnthis.evaluator.condition(condition,this.methodKey, evaluationContext); }returntrue;}// 對事務事件方法的返回值進行處理，這裏的處理方式主要是將其作爲一個事件繼續發佈出去，這樣就可以在// 一個統一的位置對事務事件的返回值進行處理protectedvoidhandleResult(Object result){// 如果返回值是數組類型，則對數組元素一個一個進行發佈if(result.getClass().isArray()) { Object[] events = ObjectUtils.toObjectArray(result);for(Object event : events) { publishEvent(event); } }elseif(resultinstanceofCollection) {// 如果返回值是集合類型，則對集合進行遍歷，並且發佈集合中的每個元素Collection events = (Collection) result;for(Object event : events) { publishEvent(event); } }else{// 如果返回值是一個對象，則直接將其進行發佈publishEvent(result); }}
對於事務事件的處理，總結而言，就是爲每個事務事件監聽方法創建了一個TransactionSynchronizationEventAdapter對象，通過該對象在發佈事務事件的時候，會在當前線程中註冊該對象，這樣就可以保證每個線程每個監聽器中只會對應一個TransactionSynchronizationEventAdapter對象。在Spring進行事務事件的時候會調用該對象對應的監聽方法，從而達到對事務事件進行監聽的目的。
3. 小結
本文首先對事務事件監聽程序的使用方式進行了講解，然後在源碼層面講解了Spring事務監聽器是如何實現的。在Spring事務監聽器使用過程中，需要注意的是要對當前接收到的事件類型進行判斷，因爲不同的事務可能會發布同樣的消息對象過來。
Java工程化、高性能及分佈式、高性能、深入淺出。高架構。性能調優、Spring，MyBatis，Netty源碼分析和大數據等多個知識點加q羣號爲：856443934