如何使用Spring監(jiān)控事務(wù)事件

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

成都創(chuàng)新互聯(lián)公司主要從事網(wǎng)站設(shè)計(jì)制作、做網(wǎng)站、網(wǎng)頁設(shè)計(jì)、企業(yè)做網(wǎng)站、公司建網(wǎng)站等業(yè)務(wù)。立足成都服務(wù)孝義,十多年網(wǎng)站建設(shè)經(jīng)驗(yàn),價(jià)格優(yōu)惠、服務(wù)專業(yè),歡迎來電咨詢建站服務(wù):13518219792

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

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

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

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

這里我們假設(shè)數(shù)據(jù)庫有一個(gè)user表，對(duì)應(yīng)的有一個(gè)UserService和User的model，用于往該表中插入數(shù)據(jù)，并且插入動(dòng)作時(shí)使用注解標(biāo)注目標(biāo)方法。如下是這幾個(gè)類的聲明：

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);
 }
}

上述代碼中有一點(diǎn)需要注意的是，對(duì)于需要監(jiān)控事務(wù)事件的方法，在目標(biāo)方法執(zhí)行的時(shí)候需要使用

ApplicationEventPublisher發(fā)布相應(yīng)的事件消息。如下是對(duì)上述消息進(jìn)行監(jiān)控的程序：

@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());
 }
}

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

<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;
 }
}

運(yùn)行上述程序，其執(zhí)行結(jié)果如下：

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

可以看到，這里確實(shí)成功監(jiān)聽了目標(biāo)程序的相關(guān)事務(wù)行為。

2. 實(shí)現(xiàn)原理

關(guān)于事務(wù)的實(shí)現(xiàn)原理，這里其實(shí)是比較簡單的，在前面的文章中，我們講解到，Spring對(duì)事務(wù)監(jiān)控的處理邏輯在TransactionSynchronization中，如下是該接口的聲明：

public interface TransactionSynchronization extends Flushable {

  // 在當(dāng)前事務(wù)掛起時(shí)執(zhí)行
	default void suspend() {
	}

  // 在當(dāng)前事務(wù)重新加載時(shí)執(zhí)行
	default void resume() {
	}

  // 在當(dāng)前數(shù)據(jù)刷新到數(shù)據(jù)庫時(shí)執(zhí)行
	default void flush() {
	}

  // 在當(dāng)前事務(wù)commit之前執(zhí)行
	default void beforeCommit(boolean readOnly) {
	}

  // 在當(dāng)前事務(wù)completion之前執(zhí)行
	default void beforeCompletion() {
	}
  
  // 在當(dāng)前事務(wù)commit之后實(shí)質(zhì)性
	default void afterCommit() {
	}

  // 在當(dāng)前事務(wù)completion之后執(zhí)行
	default void afterCompletion(int status) {
	}
}

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

ublic class TransactionalEventListenerFactory implements EventListenerFactory, Ordered {

  // 指定當(dāng)前監(jiān)聽器的順序
  private int order = 50;

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

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


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

  // 為目標(biāo)方法生成一個(gè)事務(wù)事件監(jiān)聽器，這里ApplicationListenerMethodTransactionalAdapter實(shí)現(xiàn)了
  // ApplicationEvent接口
  @Override
  public ApplicationListener<?> createApplicationListener(String beanName, Class<?> type, Method method) {
    return new ApplicationListenerMethodTransactionalAdapter(beanName, type, method);
  }

}

這里關(guān)于事務(wù)事件監(jiān)聽的邏輯其實(shí)已經(jīng)比較清楚了。ApplicationListenerMethodTransactionalAdapter本質(zhì)上是實(shí)現(xiàn)了ApplicationListener接口的，也就是說，其是Spring的一個(gè)事件監(jiān)聽器，這也就是為什么進(jìn)行事務(wù)處理時(shí)需要使用ApplicationEventPublisher.publish()方法發(fā)布一下當(dāng)前事務(wù)的事件。

ApplicationListenerMethodTransactionalAdapter在監(jiān)聽到發(fā)布的事件之后會(huì)生成一個(gè)TransactionSynchronization對(duì)象，并且將該對(duì)象注冊(cè)到當(dāng)前事務(wù)邏輯中，如下是監(jiān)聽事務(wù)事件的處理邏輯：

@Override
public void onApplicationEvent(ApplicationEvent event) {
  // 如果當(dāng)前TransactionManager已經(jīng)配置開啟事務(wù)事件監(jiān)聽，
  // 此時(shí)才會(huì)注冊(cè)TransactionSynchronization對(duì)象
  if (TransactionSynchronizationManager.isSynchronizationActive()) {
    // 通過當(dāng)前事務(wù)事件發(fā)布的參數(shù)，創(chuàng)建一個(gè)TransactionSynchronization對(duì)象
    TransactionSynchronization transactionSynchronization = 
      createTransactionSynchronization(event);
    // 注冊(cè)TransactionSynchronization對(duì)象到TransactionManager中
    TransactionSynchronizationManager
      .registerSynchronization(transactionSynchronization);
  } else if (this.annotation.fallbackExecution()) {
    // 如果當(dāng)前TransactionManager沒有開啟事務(wù)事件處理，但是當(dāng)前事務(wù)監(jiān)聽方法中配置了
    // fallbackExecution屬性為true，說明其需要對(duì)當(dāng)前事務(wù)事件進(jìn)行監(jiān)聽，無論其是否有事務(wù)
    if (this.annotation.phase() == TransactionPhase.AFTER_ROLLBACK 
      && logger.isWarnEnabled()) {
      logger.warn("Processing " 
            + event + " as a fallback execution on AFTER_ROLLBACK phase");
    }
    processEvent(event);
  } else {
    // 走到這里說明當(dāng)前是不需要事務(wù)事件處理的，因而直接略過
    if (logger.isDebugEnabled()) {
      logger.debug("No transaction is active - skipping " + event);
    }
  }
}

這里需要說明的是，上述annotation屬性就是在事務(wù)監(jiān)聽方法上解析的TransactionalEventListener注解中配置的屬性?？梢钥吹剑瑢?duì)于事務(wù)事件的處理，這里創(chuàng)建了一個(gè)TransactionSynchronization對(duì)象，其實(shí)主要的處理邏輯就是在返回的這個(gè)對(duì)象中，而createTransactionSynchronization()方法內(nèi)部只是創(chuàng)建了一個(gè)TransactionSynchronizationEventAdapter對(duì)象就返回了。這里我們直接看該對(duì)象的源碼：

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();
  }

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

  // 這里對(duì)于after completion事件的處理，雖然分為了三個(gè)if分支，但是實(shí)際上都是執(zhí)行的processEvent()
  // 方法，因?yàn)閍fter completion事件是事務(wù)事件中一定會(huì)執(zhí)行的，因而這里對(duì)于commit，
  // rollback和completion事件都在當(dāng)前方法中處理也是沒問題的
  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();
    }
  }

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

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

public void processEvent(ApplicationEvent event) {
  // 處理事務(wù)事件的相關(guān)參數(shù)，這里主要是判斷TransactionalEventListener注解中是否配置了value
  // 或classes屬性，如果配置了，則將方法參數(shù)轉(zhuǎn)換為該指定類型傳給監(jiān)聽的方法；如果沒有配置，則判斷
  // 目標(biāo)方法是ApplicationEvent類型還是PayloadApplicationEvent類型，是則轉(zhuǎn)換為該類型傳入
  Object[] args = resolveArguments(event);
  // 這里主要是獲取TransactionalEventListener注解中的condition屬性，然后通過
  // Spring expression language將其與目標(biāo)類和方法進(jìn)行匹配
  if (shouldHandle(event, args)) {
    // 通過處理得到的參數(shù)借助于反射調(diào)用事務(wù)監(jiān)聽方法
    Object result = doInvoke(args);
    if (result != null) {
      // 對(duì)方法的返回值進(jìn)行處理
      handleResult(result);
    } else {
      logger.trace("No result object given - no result to handle");
    }
  }
}

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

// 判斷事務(wù)事件方法方法是否需要進(jìn)行事務(wù)事件處理
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;
}

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

對(duì)于事務(wù)事件的處理，總結(jié)而言，就是為每個(gè)事務(wù)事件監(jiān)聽方法創(chuàng)建了一個(gè)TransactionSynchronizationEventAdapter對(duì)象，通過該對(duì)象在發(fā)布事務(wù)事件的時(shí)候，會(huì)在當(dāng)前線程中注冊(cè)該對(duì)象，這樣就可以保證每個(gè)線程每個(gè)監(jiān)聽器中只會(huì)對(duì)應(yīng)一個(gè)TransactionSynchronizationEventAdapter對(duì)象。在Spring進(jìn)行事務(wù)事件的時(shí)候會(huì)調(diào)用該對(duì)象對(duì)應(yīng)的監(jiān)聽方法，從而達(dá)到對(duì)事務(wù)事件進(jìn)行監(jiān)聽的目的。

看完上述內(nèi)容，你們對(duì)如何使用Spring監(jiān)控事務(wù)事件有進(jìn)一步的了解嗎？如果還想了解更多知識(shí)或者相關(guān)內(nèi)容，請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道，感謝大家的支持。

當(dāng)前名稱：如何使用Spring監(jiān)控事務(wù)事件
本文鏈接：http://muchs.cn/article16/gdehgg.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供App開發(fā)、App設(shè)計(jì)、域名注冊(cè)、定制網(wǎng)站、電子商務(wù)、網(wǎng)站內(nèi)鏈

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)