You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by wu...@apache.org on 2021/08/29 15:47:52 UTC

[shardingsphere] branch master updated: Use RequiredSPIRegistry and TypedSPIRegistry to load XATransactionManagerProvider (#12094)

This is an automated email from the ASF dual-hosted git repository.

wuweijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git


The following commit(s) were added to refs/heads/master by this push:
     new 80fa063  Use RequiredSPIRegistry and TypedSPIRegistry to load XATransactionManagerProvider (#12094)
80fa063 is described below

commit 80fa0631fdf835343a84d5e7da5223c2fdec816b
Author: Liang Zhang <te...@163.com>
AuthorDate: Sun Aug 29 23:47:21 2021 +0800

    Use RequiredSPIRegistry and TypedSPIRegistry to load XATransactionManagerProvider (#12094)
    
    * Simplify xa transaction provider impl
    
    * Use RequiredSPIRegistry and TypedSPIRegistry to load XATransactionManagerProvider
---
 .../AtomikosTransactionManagerProvider.java        | 13 +++--
 .../BitronixXATransactionManagerProvider.java      |  8 +--
 .../xa/XAShardingSphereTransactionManager.java     |  4 +-
 .../xa/manager/XATransactionManagerLoader.java     | 64 ----------------------
 .../XATransactionManagerProviderLoader.java        | 60 ++++++++++++++++++++
 .../XATransactionManagerProviderLoaderTest.java    |  9 ++-
 .../src/test/resources/logback-test.xml            |  2 +-
 .../NarayanaXATransactionManagerProvider.java      |  7 +--
 .../xa/spi/XATransactionManagerProvider.java       |  3 +-
 9 files changed, 83 insertions(+), 87 deletions(-)

diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-atomikos/src/main/java/org/apache/shardingsphere/transaction/xa/atomikos/manager/AtomikosTransactionManagerProvider.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-atomikos/src/main/java/org/apache/shardingsphere/transaction/xa/atomikos/manager/AtomikosTransactionManagerProvider.java
index 34f0de2..d97541c 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-atomikos/src/main/java/org/apache/shardingsphere/transaction/xa/atomikos/manager/AtomikosTransactionManagerProvider.java
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-atomikos/src/main/java/org/apache/shardingsphere/transaction/xa/atomikos/manager/AtomikosTransactionManagerProvider.java
@@ -20,6 +20,7 @@ package org.apache.shardingsphere.transaction.xa.atomikos.manager;
 import com.atomikos.icatch.config.UserTransactionService;
 import com.atomikos.icatch.config.UserTransactionServiceImp;
 import com.atomikos.icatch.jta.UserTransactionManager;
+import lombok.Getter;
 import lombok.SneakyThrows;
 import org.apache.shardingsphere.transaction.xa.spi.SingleXAResource;
 import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider;
@@ -27,13 +28,13 @@ import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider
 import javax.sql.XADataSource;
 import javax.transaction.RollbackException;
 import javax.transaction.SystemException;
-import javax.transaction.TransactionManager;
 
 /**
  * Atomikos XA transaction manager provider.
  */
 public final class AtomikosTransactionManagerProvider implements XATransactionManagerProvider {
     
+    @Getter
     private UserTransactionManager transactionManager;
     
     private UserTransactionService userTransactionService;
@@ -62,11 +63,6 @@ public final class AtomikosTransactionManagerProvider implements XATransactionMa
     }
     
     @Override
-    public TransactionManager getTransactionManager() {
-        return transactionManager;
-    }
-    
-    @Override
     public void close() {
         userTransactionService.shutdown(true);
     }
@@ -75,4 +71,9 @@ public final class AtomikosTransactionManagerProvider implements XATransactionMa
     public String getType() {
         return "Atomikos";
     }
+    
+    @Override
+    public boolean isDefault() {
+        return true;
+    }
 }
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-bitronix/src/main/java/org/apache/shardingsphere/transaction/xa/bitronix/manager/BitronixXATransactionManagerProvider.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-bitronix/src/main/java/org/apache/shardingsphere/transaction/xa/bitronix/manager/BitronixXATransactionManagerProvider.java
index 65c8aa6..fb6acfa 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-bitronix/src/main/java/org/apache/shardingsphere/transaction/xa/bitronix/manager/BitronixXATransactionManagerProvider.java
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-bitronix/src/main/java/org/apache/shardingsphere/transaction/xa/bitronix/manager/BitronixXATransactionManagerProvider.java
@@ -21,6 +21,7 @@ import bitronix.tm.BitronixTransactionManager;
 import bitronix.tm.TransactionManagerServices;
 import bitronix.tm.recovery.RecoveryException;
 import bitronix.tm.resource.ResourceRegistrar;
+import lombok.Getter;
 import lombok.SneakyThrows;
 import org.apache.shardingsphere.transaction.xa.spi.SingleXAResource;
 import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider;
@@ -28,11 +29,11 @@ import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider
 import javax.sql.XADataSource;
 import javax.transaction.RollbackException;
 import javax.transaction.SystemException;
-import javax.transaction.TransactionManager;
 
 /**
  * Bitronix transaction manager provider.
  */
+@Getter
 public final class BitronixXATransactionManagerProvider implements XATransactionManagerProvider {
     
     private BitronixTransactionManager transactionManager;
@@ -60,11 +61,6 @@ public final class BitronixXATransactionManagerProvider implements XATransaction
     }
     
     @Override
-    public TransactionManager getTransactionManager() {
-        return transactionManager;
-    }
-    
-    @Override
     public void close() {
         transactionManager.shutdown();
     }
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/XAShardingSphereTransactionManager.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/XAShardingSphereTransactionManager.java
index dd5a1fd..148cb33 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/XAShardingSphereTransactionManager.java
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/XAShardingSphereTransactionManager.java
@@ -24,7 +24,7 @@ import org.apache.shardingsphere.transaction.core.TransactionType;
 import org.apache.shardingsphere.transaction.rule.TransactionRule;
 import org.apache.shardingsphere.transaction.spi.ShardingSphereTransactionManager;
 import org.apache.shardingsphere.transaction.xa.jta.datasource.XATransactionDataSource;
-import org.apache.shardingsphere.transaction.xa.manager.XATransactionManagerLoader;
+import org.apache.shardingsphere.transaction.xa.manager.XATransactionManagerProviderLoader;
 import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider;
 
 import javax.sql.DataSource;
@@ -51,7 +51,7 @@ public final class XAShardingSphereTransactionManager implements ShardingSphereT
     
     @Override
     public void init(final DatabaseType databaseType, final Collection<ResourceDataSource> resourceDataSources, final TransactionRule transactionRule) {
-        xaTransactionManagerProvider = XATransactionManagerLoader.getInstance().getXATransactionManager(transactionRule.getProps().getProperty("xa-transaction-manager-type"));
+        xaTransactionManagerProvider = XATransactionManagerProviderLoader.getInstance().getXATransactionManagerProvider(transactionRule.getProps().getProperty("xa-transaction-manager-type"));
         xaTransactionManagerProvider.init();
         resourceDataSources.forEach(each -> cachedDataSources.put(each.getOriginalName(), newXATransactionDataSource(databaseType, each)));
     }
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerLoader.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerLoader.java
deleted file mode 100644
index 28d539c..0000000
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerLoader.java
+++ /dev/null
@@ -1,64 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements.  See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License.  You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.shardingsphere.transaction.xa.manager;
-
-import lombok.AccessLevel;
-import lombok.NoArgsConstructor;
-import org.apache.shardingsphere.transaction.xa.atomikos.manager.AtomikosTransactionManagerProvider;
-import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider;
-
-import java.util.Iterator;
-import java.util.ServiceLoader;
-
-/**
- * XA transaction manager loader.
- */
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
-public final class XATransactionManagerLoader {
-    
-    private static final XATransactionManagerLoader INSTANCE = new XATransactionManagerLoader();
-    
-    /**
-     * Get instance of XA transaction manager SPI loader.
-     *
-     * @return instance of XA transaction manager SPI loader
-     */
-    public static XATransactionManagerLoader getInstance() {
-        return INSTANCE;
-    }
-    
-    /**
-     * Get XA transaction manager.
-     *
-     * @param type type
-     * @return XA transaction manager
-     */
-    public XATransactionManagerProvider getXATransactionManager(final String type) {
-        Iterator<XATransactionManagerProvider> xaTransactionManagers = ServiceLoader.load(XATransactionManagerProvider.class).iterator();
-        if (!xaTransactionManagers.hasNext()) {
-            return new AtomikosTransactionManagerProvider();
-        }
-        while (xaTransactionManagers.hasNext()) {
-            XATransactionManagerProvider result = xaTransactionManagers.next();
-            if (result.getType().equalsIgnoreCase(type)) {
-                return result;
-            }
-        }
-        return new AtomikosTransactionManagerProvider();
-    }
-}
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoader.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoader.java
new file mode 100644
index 0000000..f68aaf8
--- /dev/null
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/main/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoader.java
@@ -0,0 +1,60 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.shardingsphere.transaction.xa.manager;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.apache.shardingsphere.spi.ShardingSphereServiceLoader;
+import org.apache.shardingsphere.spi.required.RequiredSPIRegistry;
+import org.apache.shardingsphere.spi.typed.TypedSPIRegistry;
+import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider;
+
+import java.util.Properties;
+
+/**
+ * XA transaction manager provider loader.
+ */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class XATransactionManagerProviderLoader {
+    
+    private static final XATransactionManagerProviderLoader INSTANCE = new XATransactionManagerProviderLoader();
+    
+    static {
+        ShardingSphereServiceLoader.register(XATransactionManagerProvider.class);
+    }
+    
+    /**
+     * Get instance of XA transaction manager provider SPI loader.
+     *
+     * @return instance of XA transaction manager provider SPI loader
+     */
+    public static XATransactionManagerProviderLoader getInstance() {
+        return INSTANCE;
+    }
+    
+    /**
+     * Get XA transaction manager provider.
+     *
+     * @param type XA transaction manager provider type
+     * @return XA transaction manager provider
+     */
+    public XATransactionManagerProvider getXATransactionManagerProvider(final String type) {
+        return null == type
+                ? RequiredSPIRegistry.getRegisteredService(XATransactionManagerProvider.class) : TypedSPIRegistry.getRegisteredService(XATransactionManagerProvider.class, type, new Properties());
+    }
+}
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoaderTest.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoaderTest.java
index 4c336c5..a38b9e5 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoaderTest.java
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/java/org/apache/shardingsphere/transaction/xa/manager/XATransactionManagerProviderLoaderTest.java
@@ -29,7 +29,12 @@ import static org.junit.Assert.assertThat;
 public final class XATransactionManagerProviderLoaderTest {
     
     @Test
-    public void assertGetTransactionManager() {
-        assertThat(XATransactionManagerLoader.getInstance().getXATransactionManager("Atomikos"), instanceOf(AtomikosTransactionManagerProvider.class));
+    public void assertGetDefaultTransactionManagerProvider() {
+        assertThat(XATransactionManagerProviderLoader.getInstance().getXATransactionManagerProvider(null), instanceOf(AtomikosTransactionManagerProvider.class));
+    }
+    
+    @Test
+    public void assertGetTransactionManagerProvider() {
+        assertThat(XATransactionManagerProviderLoader.getInstance().getXATransactionManagerProvider("Atomikos"), instanceOf(AtomikosTransactionManagerProvider.class));
     }
 }
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/resources/logback-test.xml b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/resources/logback-test.xml
index fa6ea5b..bc05b3d 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/resources/logback-test.xml
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-core/src/test/resources/logback-test.xml
@@ -25,7 +25,7 @@
     <logger name="org.apache.shardingsphere" level="warn" additivity="false">
         <appender-ref ref="console" />
     </logger>
-    <logger name="org.apache.shardingsphere.transaction.xa.manager.XATransactionManagerLoader" level="off" />
+    <logger name="org.apache.shardingsphere.transaction.xa.manager.XATransactionManagerProviderLoader" level="off" />
     
     <root>
         <level value="error" />
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-narayana/src/main/java/org/apache/shardingsphere/transaction/xa/narayana/manager/NarayanaXATransactionManagerProvider.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-narayana/src/main/java/org/apache/shardingsphere/transaction/xa/narayana/manager/NarayanaXATransactionManagerProvider.java
index c0a5d53..5e2de81 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-narayana/src/main/java/org/apache/shardingsphere/transaction/xa/narayana/manager/NarayanaXATransactionManagerProvider.java
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-narayana/src/main/java/org/apache/shardingsphere/transaction/xa/narayana/manager/NarayanaXATransactionManagerProvider.java
@@ -21,6 +21,7 @@ import com.arjuna.ats.arjuna.recovery.RecoveryManager;
 import com.arjuna.ats.internal.jta.recovery.arjunacore.XARecoveryModule;
 import com.arjuna.ats.jbossatx.jta.RecoveryManagerService;
 import com.arjuna.ats.jta.common.jtaPropertyManager;
+import lombok.Getter;
 import lombok.SneakyThrows;
 import org.apache.shardingsphere.transaction.xa.spi.SingleXAResource;
 import org.apache.shardingsphere.transaction.xa.spi.XATransactionManagerProvider;
@@ -36,6 +37,7 @@ import java.util.Objects;
  */
 public final class NarayanaXATransactionManagerProvider implements XATransactionManagerProvider {
     
+    @Getter
     private TransactionManager transactionManager;
     
     private XARecoveryModule xaRecoveryModule;
@@ -73,11 +75,6 @@ public final class NarayanaXATransactionManagerProvider implements XATransaction
     }
     
     @Override
-    public TransactionManager getTransactionManager() {
-        return transactionManager;
-    }
-    
-    @Override
     public void close() throws Exception {
         recoveryManagerService.stop();
         recoveryManagerService.destroy();
diff --git a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-spi/src/main/java/org/apache/shardingsphere/transaction/xa/spi/XATransactionManagerProvider.java b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-spi/src/main/java/org/apache/shardingsphere/transaction/xa/spi/XATransactionManagerProvider.java
index b861fcf..5a0235a 100644
--- a/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-spi/src/main/java/org/apache/shardingsphere/transaction/xa/spi/XATransactionManagerProvider.java
+++ b/shardingsphere-transaction/shardingsphere-transaction-2pc/shardingsphere-transaction-xa/shardingsphere-transaction-xa-spi/src/main/java/org/apache/shardingsphere/transaction/xa/spi/XATransactionManagerProvider.java
@@ -17,6 +17,7 @@
 
 package org.apache.shardingsphere.transaction.xa.spi;
 
+import org.apache.shardingsphere.spi.required.RequiredSPI;
 import org.apache.shardingsphere.spi.typed.TypedSPI;
 
 import javax.sql.XADataSource;
@@ -25,7 +26,7 @@ import javax.transaction.TransactionManager;
 /**
  * XA transaction manager provider.
  */
-public interface XATransactionManagerProvider extends AutoCloseable, TypedSPI {
+public interface XATransactionManagerProvider extends AutoCloseable, TypedSPI, RequiredSPI {
     
     /**
      * Initialize XA transaction manager provider.