refactor: create sql parser spi and a druid type sql parser (apache#1703

)

all/pom.xml

@@ -207,6 +207,16 @@
             <artifactId>seata-rm-datasource</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-sqlparser-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.seata</groupId>
+            <artifactId>seata-sqlparser-druid</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>io.seata</groupId>
             <artifactId>seata-spring</artifactId>
@@ -608,6 +618,8 @@
                                     <include>io.seata:seata-grpc</include>
                                     <include>io.seata:seata-rm</include>
                                     <include>io.seata:seata-rm-datasource</include>
+                                    <include>io.seata:seata-sqlparser-core</include>
+                                    <include>io.seata:seata-sqlparser-druid</include>
                                     <include>io.seata:seata-sofa-rpc</include>
                                     <include>io.seata:seata-spring</include>
                                     <include>io.seata:seata-tcc</include>

core/src/main/java/io/seata/core/constants/ConfigurationKeys.java

@@ -425,4 +425,9 @@ public class ConfigurationKeys {
      * The constant DISABLE_GLOBAL_TRANSACTION.
      */
     public static final String DISABLE_GLOBAL_TRANSACTION = SERVICE_PREFIX + "disableGlobalTransaction";
+
+    /**
+     * The constant SQL_PARSER_TYPE.
+     */
+    public static final String SQL_PARSER_TYPE = CLIENT_RM_PREFIX + "sqlparser.type";
 }

pom.xml

@@ -47,6 +47,7 @@
         <module>seata-spring-boot-starter</module>
         <module>compressor</module>
         <module>saga</module>
+        <module>sqlparser</module>
     </modules>
     <packaging>pom</packaging>
 

rm-datasource/pom.xml

@@ -40,8 +40,9 @@
             <version>${project.version}</version>
         </dependency>
         <dependency>
-            <groupId>com.alibaba</groupId>
-            <artifactId>druid</artifactId>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>seata-sqlparser-core</artifactId>
+            <version>${project.version}</version>
         </dependency>
         <dependency>
             <groupId>com.github.ben-manes.caffeine</groupId>
@@ -70,6 +71,17 @@
             <artifactId>h2</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.alibaba</groupId>
+            <artifactId>druid</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>seata-sqlparser-druid</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
 
         <dependency>
             <groupId>com.esotericsoftware</groupId>
@@ -81,6 +93,4 @@
         </dependency>
 
     </dependencies>
-
-
 </project>

rm-datasource/src/main/java/io/seata/rm/datasource/AbstractConnectionProxy.java

@@ -16,11 +16,11 @@
 package io.seata.rm.datasource;
 
 import io.seata.core.context.RootContext;
-import io.seata.rm.datasource.sql.SQLRecognizer;
-import io.seata.rm.datasource.sql.SQLType;
 import io.seata.rm.datasource.sql.SQLVisitorFactory;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableMetaCacheFactory;
+import io.seata.sqlparser.SQLRecognizer;
+import io.seata.sqlparser.SQLType;
 
 import java.sql.Array;
 import java.sql.Blob;

rm-datasource/src/main/java/io/seata/rm/datasource/AbstractPreparedStatementProxy.java

@@ -14,6 +14,7 @@
  *  limitations under the License.
  */
 package io.seata.rm.datasource;
+import io.seata.sqlparser.struct.Null;
 
 import java.io.InputStream;
 import java.io.Reader;
@@ -37,8 +38,6 @@
 import java.util.Calendar;
 import java.util.List;
 
-import io.seata.rm.datasource.sql.struct.Null;
-
 /**
  * The type Abstract prepared statement proxy.
  *

rm-datasource/src/main/java/io/seata/rm/datasource/ColumnUtils.java

@@ -15,9 +15,9 @@
  */
 package io.seata.rm.datasource;
 
-import com.alibaba.druid.util.JdbcConstants;
 import io.seata.common.util.CollectionUtils;
 import io.seata.common.util.StringUtils;
+import io.seata.sqlparser.util.JdbcConstants;
 
 import java.util.ArrayList;
 import java.util.List;

rm-datasource/src/main/java/io/seata/rm/datasource/DataSourceProxy.java

@@ -22,14 +22,14 @@
 import java.util.concurrent.ScheduledThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
 
-import com.alibaba.druid.util.JdbcUtils;
 import io.seata.common.thread.NamedThreadFactory;
 import io.seata.config.ConfigurationFactory;
 import io.seata.core.constants.ConfigurationKeys;
 import io.seata.core.model.BranchType;
 import io.seata.core.model.Resource;
 import io.seata.rm.DefaultResourceManager;
 import io.seata.rm.datasource.sql.struct.TableMetaCacheFactory;
+import io.seata.rm.datasource.util.JdbcUtils;
 
 /**
  * The type Data source proxy.
@@ -84,7 +84,7 @@ private void init(DataSource dataSource, String resourceGroupId) {
         this.resourceGroupId = resourceGroupId;
         try (Connection connection = dataSource.getConnection()) {
             jdbcUrl = connection.getMetaData().getURL();
-            dbType = JdbcUtils.getDbType(jdbcUrl, null);
+            dbType = JdbcUtils.getDbType(jdbcUrl);
         } catch (SQLException e) {
             throw new IllegalStateException("can not init dataSource", e);
         }

rm-datasource/src/main/java/io/seata/rm/datasource/PreparedStatementProxy.java

@@ -22,6 +22,7 @@
 
 import io.seata.rm.datasource.exec.ExecuteTemplate;
 import io.seata.rm.datasource.exec.StatementCallback;
+import io.seata.sqlparser.ParametersHolder;
 
 /**
  * The type Prepared statement proxy.

rm-datasource/src/main/java/io/seata/rm/datasource/exec/AbstractDMLBaseExecutor.java

@@ -18,7 +18,7 @@
 import io.seata.rm.datasource.AbstractConnectionProxy;
 import io.seata.rm.datasource.ConnectionProxy;
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLRecognizer;
+import io.seata.sqlparser.SQLRecognizer;
 import io.seata.rm.datasource.sql.struct.TableRecords;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

rm-datasource/src/main/java/io/seata/rm/datasource/exec/BaseTransactionalExecutor.java

@@ -28,17 +28,18 @@
 import io.seata.core.context.RootContext;
 import io.seata.rm.datasource.ColumnUtils;
 import io.seata.rm.datasource.ConnectionProxy;
-import io.seata.rm.datasource.ParametersHolder;
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLRecognizer;
-import io.seata.rm.datasource.sql.SQLType;
-import io.seata.rm.datasource.sql.WhereRecognizer;
 import io.seata.rm.datasource.sql.struct.Field;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableMetaCacheFactory;
 import io.seata.rm.datasource.sql.struct.TableRecords;
 import io.seata.rm.datasource.undo.SQLUndoLog;
 
+import io.seata.sqlparser.ParametersHolder;
+import io.seata.sqlparser.SQLRecognizer;
+import io.seata.sqlparser.SQLType;
+import io.seata.sqlparser.WhereRecognizer;
+
 /**
  * The type Base transactional executor.
  *

rm-datasource/src/main/java/io/seata/rm/datasource/exec/DeleteExecutor.java

@@ -22,12 +22,12 @@
 import java.util.StringJoiner;
 
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLDeleteRecognizer;
-import io.seata.rm.datasource.sql.SQLRecognizer;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableRecords;
 import io.seata.rm.datasource.undo.KeywordChecker;
 import io.seata.rm.datasource.undo.KeywordCheckerFactory;
+import io.seata.sqlparser.SQLDeleteRecognizer;
+import io.seata.sqlparser.SQLRecognizer;
 import org.apache.commons.lang.StringUtils;
 
 /**

rm-datasource/src/main/java/io/seata/rm/datasource/exec/ExecuteTemplate.java

@@ -17,8 +17,8 @@
 
 import io.seata.core.context.RootContext;
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLRecognizer;
 import io.seata.rm.datasource.sql.SQLVisitorFactory;
+import io.seata.sqlparser.SQLRecognizer;
 
 import java.sql.SQLException;
 import java.sql.Statement;

rm-datasource/src/main/java/io/seata/rm/datasource/exec/InsertExecutor.java

@@ -23,20 +23,23 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
-import com.alibaba.druid.util.JdbcConstants;
 import io.seata.common.exception.NotSupportYetException;
 import io.seata.common.exception.ShouldNeverHappenException;
 import io.seata.common.util.CollectionUtils;
 import io.seata.common.util.StringUtils;
+
 import io.seata.rm.datasource.PreparedStatementProxy;
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLInsertRecognizer;
-import io.seata.rm.datasource.sql.SQLRecognizer;
 import io.seata.rm.datasource.sql.struct.ColumnMeta;
-import io.seata.rm.datasource.sql.struct.Null;
-import io.seata.rm.datasource.sql.struct.SqlMethodExpr;
-import io.seata.rm.datasource.sql.struct.SqlSequenceExpr;
 import io.seata.rm.datasource.sql.struct.TableRecords;
+
+import io.seata.sqlparser.SQLInsertRecognizer;
+import io.seata.sqlparser.SQLRecognizer;
+import io.seata.sqlparser.struct.Null;
+import io.seata.sqlparser.struct.SqlMethodExpr;
+import io.seata.sqlparser.struct.SqlSequenceExpr;
+import io.seata.sqlparser.util.JdbcConstants;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

rm-datasource/src/main/java/io/seata/rm/datasource/exec/SelectForUpdateExecutor.java

@@ -26,8 +26,8 @@
 import io.seata.common.util.StringUtils;
 import io.seata.core.context.RootContext;
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLRecognizer;
-import io.seata.rm.datasource.sql.SQLSelectRecognizer;
+import io.seata.sqlparser.SQLRecognizer;
+import io.seata.sqlparser.SQLSelectRecognizer;
 import io.seata.rm.datasource.sql.struct.TableRecords;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;

rm-datasource/src/main/java/io/seata/rm/datasource/exec/UpdateExecutor.java

@@ -24,12 +24,12 @@
 import java.util.StringJoiner;
 
 import io.seata.rm.datasource.StatementProxy;
-import io.seata.rm.datasource.sql.SQLRecognizer;
-import io.seata.rm.datasource.sql.SQLUpdateRecognizer;
+
+import io.seata.sqlparser.SQLRecognizer;
+import io.seata.sqlparser.SQLUpdateRecognizer;
 import io.seata.rm.datasource.sql.struct.Field;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableRecords;
-
 import org.apache.commons.lang.StringUtils;
 
 /**

rm-datasource/src/main/java/io/seata/rm/datasource/sql/SQLVisitorFactory.java

@@ -15,20 +15,25 @@
  */
 package io.seata.rm.datasource.sql;
 
-import com.alibaba.druid.sql.SQLUtils;
-import com.alibaba.druid.sql.ast.SQLStatement;
-import com.alibaba.druid.sql.ast.statement.SQLDeleteStatement;
-import com.alibaba.druid.sql.ast.statement.SQLInsertStatement;
-import com.alibaba.druid.sql.ast.statement.SQLSelectStatement;
-import com.alibaba.druid.sql.ast.statement.SQLUpdateStatement;
-import java.util.List;
+import io.seata.common.loader.EnhancedServiceLoader;
+import io.seata.config.ConfigurationFactory;
+import io.seata.core.constants.ConfigurationKeys;
+import io.seata.sqlparser.SQLRecognizer;
+import io.seata.sqlparser.SQLRecognizerFactory;
 
 /**
- * The type Sql visitor factory.
- *
- * @author sharajava
+ * @author ggndnn
  */
 public class SQLVisitorFactory {
+    /**
+     * SQLRecognizerFactory.
+     */
+    private final static SQLRecognizerFactory SQL_RECOGNIZER_FACTORY;
+
+    static {
+        String sqlparserType = ConfigurationFactory.getInstance().getConfig(ConfigurationKeys.SQL_PARSER_TYPE, "druid");
+        SQL_RECOGNIZER_FACTORY = EnhancedServiceLoader.load(SQLRecognizerFactory.class, sqlparserType);
+    }
 
     /**
      * Get sql recognizer.
@@ -38,23 +43,6 @@ public class SQLVisitorFactory {
      * @return the sql recognizer
      */
     public static SQLRecognizer get(String sql, String dbType) {
-        List<SQLStatement> asts = SQLUtils.parseStatements(sql, dbType);
-        if (asts == null || asts.size() != 1) {
-            throw new UnsupportedOperationException("Unsupported SQL: " + sql);
-        }
-        SQLRecognizer recognizer = null;
-        SQLStatement ast = asts.get(0);
-        SQLOperateRecognizerHolder recognizerHolder =
-            SQLOperateRecognizerHolderFactory.getSQLRecognizerHolder(dbType.toLowerCase());
-        if (ast instanceof SQLInsertStatement) {
-            recognizer = recognizerHolder.getInsertRecognizer(sql, ast);
-        } else if (ast instanceof SQLUpdateStatement) {
-            recognizer = recognizerHolder.getUpdateRecognizer(sql, ast);
-        } else if (ast instanceof SQLDeleteStatement) {
-            recognizer = recognizerHolder.getDeleteRecognizer(sql, ast);
-        } else if (ast instanceof SQLSelectStatement) {
-            recognizer = recognizerHolder.getSelectForUpdateRecognizer(sql, ast);
-        }
-        return recognizer;
+        return SQL_RECOGNIZER_FACTORY.create(sql, dbType);
     }
 }

rm-datasource/src/main/java/io/seata/rm/datasource/sql/struct/TableMetaCacheFactory.java

@@ -15,11 +15,11 @@
  */
 package io.seata.rm.datasource.sql.struct;
 
-import com.alibaba.druid.util.JdbcConstants;
 import io.seata.common.exception.NotSupportYetException;
 import io.seata.rm.datasource.DataSourceProxy;
 import io.seata.rm.datasource.sql.struct.cache.MysqlTableMetaCache;
 import io.seata.rm.datasource.sql.struct.cache.OracleTableMetaCache;
+import io.seata.sqlparser.util.JdbcConstants;
 
 /**
  * @author guoyao

rm-datasource/src/main/java/io/seata/rm/datasource/sql/struct/cache/MysqlTableMetaCache.java

@@ -22,7 +22,6 @@
 import java.sql.SQLException;
 import java.sql.Statement;
 
-import com.alibaba.druid.util.JdbcConstants;
 import io.seata.common.exception.ShouldNeverHappenException;
 import io.seata.rm.datasource.sql.struct.ColumnMeta;
 import io.seata.rm.datasource.sql.struct.IndexMeta;
@@ -31,9 +30,12 @@
 import io.seata.rm.datasource.sql.struct.TableMetaCache;
 import io.seata.rm.datasource.undo.KeywordChecker;
 import io.seata.rm.datasource.undo.KeywordCheckerFactory;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import io.seata.sqlparser.util.JdbcConstants;
+
 /**
  * The type Table meta cache.
  *

rm-datasource/src/main/java/io/seata/rm/datasource/undo/AbstractUndoExecutor.java

@@ -15,7 +15,6 @@
  */
 package io.seata.rm.datasource.undo;
 
-import com.alibaba.druid.util.JdbcUtils;
 import com.alibaba.fastjson.JSON;
 import io.seata.common.util.IOUtil;
 import io.seata.common.util.StringUtils;
@@ -29,6 +28,7 @@
 import io.seata.rm.datasource.sql.struct.Row;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableRecords;
+import io.seata.rm.datasource.util.JdbcUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import javax.sql.rowset.serial.SerialBlob;
@@ -322,7 +322,7 @@ protected Object[] parsePkValues(TableRecords records) {
      * @throws SQLException
      */
     protected String getDbType(Connection conn) throws SQLException {
-        return JdbcUtils.getDbType(conn.getMetaData().getURL(), null);
+        return JdbcUtils.getDbType(conn.getMetaData().getURL());
     }
 
 }

rm-datasource/src/main/java/io/seata/rm/datasource/undo/SQLUndoLog.java

@@ -15,7 +15,7 @@
  */
 package io.seata.rm.datasource.undo;
 
-import io.seata.rm.datasource.sql.SQLType;
+import io.seata.sqlparser.SQLType;
 import io.seata.rm.datasource.sql.struct.TableMeta;
 import io.seata.rm.datasource.sql.struct.TableRecords;