optimize: add tcc fence hook function (apache#6731)

iAmClever · Aug 19, 2024 · e1e4ff0 · e1e4ff0
1 parent 1c0a442
commit e1e4ff0
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/integration-tx-api/src/main/java/org/apache/seata/integration/tx/api/fence/FenceHandler.java b/integration-tx-api/src/main/java/org/apache/seata/integration/tx/api/fence/FenceHandler.java
@@ -23,12 +23,17 @@
 
 
 public interface FenceHandler {
-
+    default void beforePrepareFence(String xid, Long branchId, String actionName){}
     Object prepareFence(String xid, Long branchId, String actionName, Callback<Object> targetCallback);
+    default void afterPrepareFence(String xid, Long branchId, String actionName){}
 
+    default void beforeCommitFence(String xid, Long branchId){}
     boolean commitFence(Method commitMethod, Object targetTCCBean, String xid, Long branchId, Object[] args);
+    default void afterCommitFence(String xid, Long branchId){}
 
+    default void beforeRollbackFence(String xid, Long branchId, String actionName){}
     boolean rollbackFence(Method rollbackMethod, Object targetTCCBean, String xid, Long branchId, Object[] args, String actionName);
+    default void afterRollbackFence(String xid, Long branchId, String actionName){}
 
     int deleteFenceByDate(Date datetime);
 

diff --git a/spring/src/main/java/org/apache/seata/rm/fence/SpringFenceHandler.java b/spring/src/main/java/org/apache/seata/rm/fence/SpringFenceHandler.java
@@ -108,6 +108,7 @@ public static void setTransactionTemplate(TransactionTemplate transactionTemplat
      */
     @Override
     public Object prepareFence(String xid, Long branchId, String actionName, Callback<Object> targetCallback) {
+        executeWithHandling(() -> beforePrepareFence(xid, branchId, actionName), xid, branchId, "beforePrepareFence");
         return transactionTemplate.execute(status -> {
             try {
                 Connection conn = DataSourceUtils.getConnection(dataSource);
@@ -129,10 +130,27 @@ public Object prepareFence(String xid, Long branchId, String actionName, Callbac
             } catch (Throwable t) {
                 status.setRollbackOnly();
                 throw new SkipCallbackWrapperException(t);
+            } finally {
+                executeWithHandling(() -> afterPrepareFence(xid, branchId, actionName), xid, branchId,"afterPrepareFence");
             }
         });
     }
 
+    /**
+     * This method executes a Runnable with transaction context and logs any exceptions that occur without allowing them to propagate.
+     * @param runnable       the runnable
+     * @param xid            the global transaction id
+     * @param branchId       the branch transaction id
+     * @param methodName     the runnable name
+     */
+    private void executeWithHandling(Runnable runnable, String xid, Long branchId, String methodName) {
+        try {
+            runnable.run();
+        } catch (Exception e) {
+            LOGGER.warn("Tcc fence Exception in {}, xid: {}, branchId: {}", methodName, xid, branchId, e);
+        }
+    }
+
     /**
      * common commit method enhanced
      *
@@ -146,6 +164,7 @@ public Object prepareFence(String xid, Long branchId, String actionName, Callbac
     @Override
     public boolean commitFence(Method commitMethod, Object targetTCCBean,
                                       String xid, Long branchId, Object[] args) {
+        executeWithHandling(() -> beforeCommitFence(xid, branchId), xid, branchId, "beforeCommitFence");
         return transactionTemplate.execute(status -> {
             try {
                 Connection conn = DataSourceUtils.getConnection(dataSource);
@@ -170,6 +189,8 @@ public boolean commitFence(Method commitMethod, Object targetTCCBean,
             } catch (Throwable t) {
                 status.setRollbackOnly();
                 throw new SkipCallbackWrapperException(t);
+            } finally {
+                executeWithHandling(() -> afterCommitFence(xid, branchId), xid, branchId, "afterCommitFence");
             }
         });
     }
@@ -188,6 +209,7 @@ public boolean commitFence(Method commitMethod, Object targetTCCBean,
     @Override
     public boolean rollbackFence(Method rollbackMethod, Object targetTCCBean,
                                         String xid, Long branchId, Object[] args, String actionName) {
+        executeWithHandling(() -> beforeRollbackFence(xid, branchId, actionName), xid, branchId,"beforeRollbackFence");
         return transactionTemplate.execute(status -> {
             try {
                 Connection conn = DataSourceUtils.getConnection(dataSource);
@@ -219,6 +241,8 @@ public boolean rollbackFence(Method rollbackMethod, Object targetTCCBean,
             } catch (Throwable t) {
                 status.setRollbackOnly();
                 throw new SkipCallbackWrapperException(t);
+            } finally {
+                executeWithHandling(() -> afterRollbackFence(xid, branchId, actionName), xid, branchId, "afterRollbackFence");
             }
         });
     }