如何使用Spring監控事務事件

今天就跟大家聊聊有關如何使用Spring監控事務事件，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結了以下內容，希望大家根據這篇文章可以有所收獲。

對于事務事件，Spring提供了一個注解@TransactionEventListener，將這個注解標注在某個方法上，那么就將這個方法聲明為了一個事務事件處理器，而具體的事件類型則是由TransactionalEventListener.phase屬性進行定義的。如下是TransactionalEventListener的聲明：

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@EventListener
public @interface TransactionalEventListener {
  // 指定當前標注方法處理事務的類型
	TransactionPhase phase() default TransactionPhase.AFTER_COMMIT;
  // 用于指定當前方法如果沒有事務，是否執行相應的事務事件監聽器
	boolean fallbackExecution() default false;
  // 與classes屬性一樣，指定了當前事件傳入的參數類型，指定了這個參數之后就可以在監聽方法上
  // 直接什么一個這個參數了
	@AliasFor(annotation = EventListener.class, attribute = "classes")
	Class<?>[] value() default {};
  // 作用于value屬性一樣，用于指定當前監聽方法的參數類型
	@AliasFor(annotation = EventListener.class, attribute = "classes")
	Class<?>[] classes() default {};
  // 這個屬性使用Spring Expression Language對目標類和方法進行匹配，對于不匹配的方法將會過濾掉
	String condition() default "";
}

關于這里的classes屬性需要說明一下，如果指定了classes屬性，那么當前監聽方法的參數類型就可以直接使用所發布的事件的參數類型，如果沒有指定，那么這里監聽的參數類型可以使用兩種：ApplicationEvent和PayloadApplicationEvent。對于ApplicationEvent類型的參數，可以通過其getSource()方法獲取發布的事件參數，只不過其返回值是一個Object類型的，如果想獲取具體的類型還需要進行強轉；對于PayloadApplicationEvent類型，其可以指定一個泛型參數，該泛型參數必須與發布的事件的參數類型一致，這樣就可以通過其getPayload()方法獲取事務事件發布的數據了。關于上述屬性中的TransactionPhase，其可以取如下幾個類型的值：

public enum TransactionPhase {
  // 指定目標方法在事務commit之前執行
	BEFORE_COMMIT,
  // 指定目標方法在事務commit之后執行
	AFTER_COMMIT,
  // 指定目標方法在事務rollback之后執行
	AFTER_ROLLBACK,
  // 指定目標方法在事務完成時執行，這里的完成是指無論事務是成功提交還是事務回滾了
	AFTER_COMPLETION
}

這里我們假設數據庫有一個user表，對應的有一個UserService和User的model，用于往該表中插入數據，并且插入動作時使用注解標注目標方法。如下是這幾個類的聲明：

public class User {
 private long id;
 private String name;
 private int age;
 // getter and setter...
}
@Service
@Transactional
public class UserServiceImpl implements UserService {
 @Autowired
 private JdbcTemplate jdbcTemplate;
 @Autowired
 private ApplicationEventPublisher publisher;
 @Override
 public void insert(User user) {
  jdbcTemplate.update("insert into user (id, name, age) value (?, ?, ?)", 
    user.getId(), user.getName(), user.getAge());
  publisher.publishEvent(user);
 }
}

上述代碼中有一點需要注意的是，對于需要監控事務事件的方法，在目標方法執行的時候需要使用

ApplicationEventPublisher發布相應的事件消息。如下是對上述消息進行監控的程序：

@Component
public class UserTransactionEventListener {
 @TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT)
 public void beforeCommit(PayloadApplicationEvent<User> event) {
  System.out.println("before commit, id: " + event.getPayload().getId());
 }
 @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
 public void afterCommit(PayloadApplicationEvent<User> event) {
  System.out.println("after commit, id: " + event.getPayload().getId());
 }
 @TransactionalEventListener(phase = TransactionPhase.AFTER_COMPLETION)
 public void afterCompletion(PayloadApplicationEvent<User> event) {
  System.out.println("after completion, id: " + event.getPayload().getId());
 }
 @TransactionalEventListener(phase = TransactionPhase.AFTER_ROLLBACK)
 public void afterRollback(PayloadApplicationEvent<User> event) {
  System.out.println("after rollback, id: " + event.getPayload().getId());
 }
}

這里對于事件的監控，只需要在監聽方法上添加@TransactionalEventListener注解即可。這里需要注意的一個問題，在實際使用過程中，對于監聽的事務事件，需要使用其他的參數進行事件的過濾，因為這里的監聽還是會監聽所有事件參數為User類型的事務，而無論其是哪個位置發出來的。如果需要對事件進行過濾，這里可以封裝一個UserEvent對象，其內保存一個類似EventType的屬性和一個User對象，這樣在發布消息的時候就可以指定EventType屬性，而在監聽消息的時候判斷當前方法監聽的事件對象的EventType是否為目標type，如果是，則對其進行處理，否則直接略過。下面是上述程序的xml文件配置和驅動程序：

<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource">
  <property name="url" value="jdbc:mysql://localhost/test?useUnicode=true"/>
  <property name="driverClassName" value="com.mysql.jdbc.Driver"/>
  <property name="username" value="******"/>
  <property name="password" value="******"/>
</bean>

<bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
  <property name="dataSource" ref="dataSource"/>
</bean>

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource"/>
</bean>

<context:component-scan base-package="com.transaction"/>
<tx:annotation-driven/>
public class TransactionApp {
 @Test
 public void testTransaction() {
  ApplicationContext ac = new ClassPathXmlApplicationContext("applicationContext.xml");
  UserService userService = context.getBean(UserService.class);
  User user = getUser();
  userService.insert(user);
 }

 private User getUser() {
  int id = new Random()
   .nextInt(1000000);
  User user = new User();
  user.setId(id);
  user.setName("Mary");
  user.setAge(27);
  return user;
 }
}

運行上述程序，其執行結果如下：

before commit, id: 935052
after commit, id: 935052
after completion, id: 935052

可以看到，這里確實成功監聽了目標程序的相關事務行為。

2. 實現原理

關于事務的實現原理，這里其實是比較簡單的，在前面的文章中，我們講解到，Spring對事務監控的處理邏輯在TransactionSynchronization中，如下是該接口的聲明：

public interface TransactionSynchronization extends Flushable {

  // 在當前事務掛起時執行
	default void suspend() {
	}

  // 在當前事務重新加載時執行
	default void resume() {
	}

  // 在當前數據刷新到數據庫時執行
	default void flush() {
	}

  // 在當前事務commit之前執行
	default void beforeCommit(boolean readOnly) {
	}

  // 在當前事務completion之前執行
	default void beforeCompletion() {
	}
  
  // 在當前事務commit之后實質性
	default void afterCommit() {
	}

  // 在當前事務completion之后執行
	default void afterCompletion(int status) {
	}
}

很明顯，這里的TransactionSynchronization接口只是抽象了一些行為，用于事務事件發生時觸發，這些行為在Spring事務中提供了內在支持，即在相應的事務事件時，其會獲取當前所有注冊的TransactionSynchronization對象，然后調用其相應的方法。那么這里TransactionSynchronization對象的注冊點對于我們了解事務事件觸發有至關重要的作用了。這里我們首先回到事務標簽的解析處，在前面講解事務標簽解析時，我們講到Spring會注冊一個TransactionalEventListenerFactory類型的bean到Spring容器中，這里關于標簽的解析讀者可以閱讀本人前面的文章Spring事務用法示例與實現原理。這里注冊的TransactionalEventListenerFactory實現了EventListenerFactory接口，這個接口的主要作用是先判斷目標方法是否是某個監聽器的類型，然后為目標方法生成一個監聽器，其會在某個bean初始化之后由Spring調用其方法用于生成監聽器。如下是該類的實現：

ublic class TransactionalEventListenerFactory implements EventListenerFactory, Ordered {

  // 指定當前監聽器的順序
  private int order = 50;

  public void setOrder(int order) {
    this.order = order;
  }

  @Override
  public int getOrder() {
    return this.order;
  }


  // 指定目標方法是否是所支持的監聽器的類型，這里的判斷邏輯就是如果目標方法上包含有
  // TransactionalEventListener注解，則說明其是一個事務事件監聽器
  @Override
  public boolean supportsMethod(Method method) {
    return (AnnotationUtils.findAnnotation(method, TransactionalEventListener.class) != null);
  }

  // 為目標方法生成一個事務事件監聽器，這里ApplicationListenerMethodTransactionalAdapter實現了
  // ApplicationEvent接口
  @Override
  public ApplicationListener<?> createApplicationListener(String beanName, Class<?> type, Method method) {
    return new ApplicationListenerMethodTransactionalAdapter(beanName, type, method);
  }

}

這里關于事務事件監聽的邏輯其實已經比較清楚了。ApplicationListenerMethodTransactionalAdapter本質上是實現了ApplicationListener接口的，也就是說，其是Spring的一個事件監聽器，這也就是為什么進行事務處理時需要使用ApplicationEventPublisher.publish()方法發布一下當前事務的事件。

ApplicationListenerMethodTransactionalAdapter在監聽到發布的事件之后會生成一個TransactionSynchronization對象，并且將該對象注冊到當前事務邏輯中，如下是監聽事務事件的處理邏輯：

@Override
public void onApplicationEvent(ApplicationEvent event) {
  // 如果當前TransactionManager已經配置開啟事務事件監聽，
  // 此時才會注冊TransactionSynchronization對象
  if (TransactionSynchronizationManager.isSynchronizationActive()) {
    // 通過當前事務事件發布的參數，創建一個TransactionSynchronization對象
    TransactionSynchronization transactionSynchronization = 
      createTransactionSynchronization(event);
    // 注冊TransactionSynchronization對象到TransactionManager中
    TransactionSynchronizationManager
      .registerSynchronization(transactionSynchronization);
  } else if (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對象就返回了。這里我們直接看該對象的源碼：

private static class TransactionSynchronizationEventAdapter 
    extends TransactionSynchronizationAdapter {

  private final ApplicationListenerMethodAdapter listener;
  private final ApplicationEvent event;
  private final TransactionPhase phase;

  public TransactionSynchronizationEventAdapter(ApplicationListenerMethodAdapter 
    listener, ApplicationEvent event, TransactionPhase phase) {
    this.listener = listener;
    this.event = event;
    this.phase = phase;
  }

  @Override
  public int getOrder() {
    return this.listener.getOrder();
  }

  // 在目標方法配置的phase屬性為BEFORE_COMMIT時，處理before commit事件
  public void beforeCommit(boolean readOnly) {
    if (this.phase == TransactionPhase.BEFORE_COMMIT) {
      processEvent();
    }
  }

  // 這里對于after completion事件的處理，雖然分為了三個if分支，但是實際上都是執行的processEvent()
  // 方法，因為after completion事件是事務事件中一定會執行的，因而這里對于commit，
  // rollback和completion事件都在當前方法中處理也是沒問題的
  public void afterCompletion(int status) {
    if (this.phase == TransactionPhase.AFTER_COMMIT && status == STATUS_COMMITTED) {
      processEvent();
    } else if (this.phase == TransactionPhase.AFTER_ROLLBACK 
          && status == STATUS_ROLLED_BACK) {
      processEvent();
    } else if (this.phase == TransactionPhase.AFTER_COMPLETION) {
      processEvent();
    }
  }

  // 執行事務事件
  protected void processEvent() {
    this.listener.processEvent(this.event);
  }
}

可以看到，對于事務事件的處理，最終都是委托給了ApplicationListenerMethodAdapter.processEvent()方法進行的。如下是該方法的源碼：

public void processEvent(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");
    }
  }
}

// 處理事務監聽方法的參數
protected Object[] resolveArguments(ApplicationEvent event) {
  // 獲取發布事務事件時傳入的參數類型
  ResolvableType declaredEventType = getResolvableType(event);
  if (declaredEventType == null) {
    return null;
  }
  
  // 如果事務監聽方法的參數個數為0，則直接返回
  if (this.method.getParameterCount() == 0) {
    return new Object[0];
  }
  
  // 如果事務監聽方法的參數不為ApplicationEvent或PayloadApplicationEvent，則直接將發布事務
  // 事件時傳入的參數當做事務監聽方法的參數傳入。從這里可以看出，如果事務監聽方法的參數不是
  // ApplicationEvent或PayloadApplicationEvent類型，那么其參數必須只能有一個，并且這個
  // 參數必須與發布事務事件時傳入的參數一致
  Class<?> eventClass = declaredEventType.getRawClass();
  if ((eventClass == null || !ApplicationEvent.class.isAssignableFrom(eventClass)) &&
    event instanceof PayloadApplicationEvent) {
    return new Object[] {((PayloadApplicationEvent) event).getPayload()};
  } else {
    // 如果參數類型為ApplicationEvent或PayloadApplicationEvent，則直接將其傳入事務事件方法
    return new Object[] {event};
  }
}

// 判斷事務事件方法方法是否需要進行事務事件處理
private boolean shouldHandle(ApplicationEvent event, @Nullable Object[] args) {
  if (args == null) {
    return false;
  }
  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);
    return this.evaluator.condition(condition, this.methodKey, evaluationContext);
  }
  return true;
}

// 對事務事件方法的返回值進行處理，這里的處理方式主要是將其作為一個事件繼續發布出去，這樣就可以在
// 一個統一的位置對事務事件的返回值進行處理
protected void handleResult(Object result) {
  // 如果返回值是數組類型，則對數組元素一個一個進行發布
  if (result.getClass().isArray()) {
    Object[] events = ObjectUtils.toObjectArray(result);
    for (Object event : events) {
      publishEvent(event);
    }
  } else if (result instanceof Collection<?>) {
    // 如果返回值是集合類型，則對集合進行遍歷，并且發布集合中的每個元素
    Collection<?> events = (Collection<?>) result;
    for (Object event : events) {
      publishEvent(event);
    }
  } else {
    // 如果返回值是一個對象，則直接將其進行發布
    publishEvent(result);
  }
}

對于事務事件的處理，總結而言，就是為每個事務事件監聽方法創建了一個TransactionSynchronizationEventAdapter對象，通過該對象在發布事務事件的時候，會在當前線程中注冊該對象，這樣就可以保證每個線程每個監聽器中只會對應一個TransactionSynchronizationEventAdapter對象。在Spring進行事務事件的時候會調用該對象對應的監聽方法，從而達到對事務事件進行監聽的目的。

看完上述內容，你們對如何使用Spring監控事務事件有進一步的了解嗎？如果還想了解更多知識或者相關內容，請關注億速云行業資訊頻道，感謝大家的支持。