rework MySQL prepared statement binding parameters (#587)

BillyYccc · web-flow · commit 0cea83ba26fd · 2020-04-22T22:36:34.000+08:00
Signed-off-by: Billy Yuan &lt;billy112487983@gmail.com&gt;
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/MySQLParamDesc.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/MySQLParamDesc.java
@@ -11,49 +11,17 @@
 
 package io.vertx.mysqlclient.impl;
 
-import io.vertx.mysqlclient.impl.datatype.DataType;
-import io.vertx.mysqlclient.impl.datatype.DataTypeCodec;
 import io.vertx.mysqlclient.impl.protocol.ColumnDefinition;
-import io.vertx.sqlclient.impl.ErrorMessageFactory;
 import io.vertx.sqlclient.impl.ParamDesc;
-import io.vertx.sqlclient.impl.TupleInternal;
 
 public class MySQLParamDesc extends ParamDesc {
   private final ColumnDefinition[] paramDefinitions;
-  private boolean sendTypesToServer;
 
   public MySQLParamDesc(ColumnDefinition[] paramDefinitions) {
     this.paramDefinitions = paramDefinitions;
-    this.sendTypesToServer = false;
   }
 
   public ColumnDefinition[] paramDefinitions() {
     return paramDefinitions;
   }
-
-  public String prepare(TupleInternal values) {
-    int numberOfParameters = values.size();
-    int paramDescLength = paramDefinitions.length;
-    if (numberOfParameters != paramDescLength) {
-      return ErrorMessageFactory.buildWhenArgumentsLengthNotMatched(paramDescLength, numberOfParameters);
-    }
-
-    // binding the parameters
-    boolean reboundParameters = false;
-    for (int i = 0; i < values.size(); i++) {
-      Object value = values.getValue(i);
-      DataType dataType = DataTypeCodec.inferDataTypeByEncodingValue(value);
-      DataType paramDataType = paramDefinitions[i].getType();
-      if (paramDataType != dataType) {
-        paramDefinitions[i].setType(dataType);
-        reboundParameters = true;
-      }
-    }
-    sendTypesToServer = reboundParameters; // parameter must be re-bound
-    return null;
-  }
-
-  public boolean sendTypesToServer() {
-    return sendTypesToServer;
-  }
 }
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/MySQLRowImpl.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/MySQLRowImpl.java
@@ -322,7 +322,7 @@ private GeometryCollection getGeometryCollection(int pos) {
   public LocalTime getLocalTime(int pos) {
     ColumnDefinition columnDefinition = rowDesc.columnDefinitions()[pos];
     Object val = getValue(pos);
-    if (columnDefinition.getType() == DataType.TIME && val instanceof Duration) {
+    if (columnDefinition.type() == DataType.TIME && val instanceof Duration) {
       // map MySQL TIME data type to java.time.LocalTime
       Duration duration = (Duration) val;
       return LocalTime.ofNanoOfDay(duration.toNanos());
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/ExtendedBatchQueryCommandCodec.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/ExtendedBatchQueryCommandCodec.java
@@ -14,7 +14,6 @@
 import io.netty.buffer.ByteBuf;
 import io.vertx.mysqlclient.impl.datatype.DataType;
 import io.vertx.mysqlclient.impl.datatype.DataTypeCodec;
-import io.vertx.mysqlclient.impl.protocol.ColumnDefinition;
 import io.vertx.mysqlclient.impl.protocol.CommandType;
 import io.vertx.sqlclient.Tuple;
 import io.vertx.sqlclient.impl.command.CommandResponse;
@@ -78,8 +77,10 @@ private void sendBatchStatementExecuteCommand(MySQLPreparedStatement statement,
     // iteration count, always 1
     packet.writeIntLE(1);
 
-    ColumnDefinition[] paramsColumnDefinitions = statement.paramDesc.paramDefinitions();
-    int numOfParams = paramsColumnDefinitions.length;
+    /*
+     * Null-bit map and type should always be reconstructed for every batch of parameters here
+     */
+    int numOfParams = statement.bindingTypes().length;
     int bitmapLength = (numOfParams + 7) / 8;
     byte[] nullBitmap = new byte[bitmapLength];
 
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/ExtendedQueryCommandCodec.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/ExtendedQueryCommandCodec.java
@@ -17,8 +17,8 @@
 package io.vertx.mysqlclient.impl.codec;
 
 import io.netty.buffer.ByteBuf;
+import io.vertx.mysqlclient.impl.datatype.DataType;
 import io.vertx.mysqlclient.impl.datatype.DataTypeCodec;
-import io.vertx.mysqlclient.impl.protocol.ColumnDefinition;
 import io.vertx.mysqlclient.impl.protocol.CommandType;
 import io.vertx.sqlclient.Tuple;
 import io.vertx.sqlclient.impl.command.ExtendedQueryCommand;
@@ -48,7 +48,7 @@ void encode(MySQLEncoder encoder) {
         sendStatementExecuteCommand(statement, true, cmd.params(), CURSOR_TYPE_READ_ONLY);
       } else {
         // CURSOR_TYPE_NO_CURSOR
-        sendStatementExecuteCommand(statement, statement.paramDesc.sendTypesToServer(), cmd.params(), CURSOR_TYPE_NO_CURSOR);
+        sendStatementExecuteCommand(statement, statement.sendTypesToServer(), cmd.params(), CURSOR_TYPE_NO_CURSOR);
       }
     }
   }
@@ -116,8 +116,7 @@ private void sendStatementExecuteCommand(MySQLPreparedStatement statement, boole
     // iteration count, always 1
     packet.writeIntLE(1);
 
-    ColumnDefinition[] paramsColumnDefinitions = statement.paramDesc.paramDefinitions();
-    int numOfParams = paramsColumnDefinitions.length;
+    int numOfParams = statement.bindingTypes().length;
     int bitmapLength = (numOfParams + 7) / 8;
     byte[] nullBitmap = new byte[bitmapLength];
 
@@ -129,16 +128,16 @@ private void sendStatementExecuteCommand(MySQLPreparedStatement statement, boole
       packet.writeBoolean(sendTypesToServer);
 
       if (sendTypesToServer) {
-        for (ColumnDefinition paramsColumnDefinition : paramsColumnDefinitions) {
-          packet.writeByte(paramsColumnDefinition.getType().id);
+        for (DataType bindingType : statement.bindingTypes()) {
+          packet.writeByte(bindingType.id);
           packet.writeByte(0); // parameter flag: signed
         }
       }
 
       for (int i = 0; i < numOfParams; i++) {
         Object value = params.getValue(i);
         if (value != null) {
-          DataTypeCodec.encodeBinary(paramsColumnDefinitions[i].getType(), value, encoder.encodingCharset, packet);
+          DataTypeCodec.encodeBinary(statement.bindingTypes()[i], value, encoder.encodingCharset, packet);
         } else {
           nullBitmap[i / 8] |= (1 << (i & 7));
         }
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/MySQLPreparedStatement.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/MySQLPreparedStatement.java
@@ -19,10 +19,11 @@
 
 import io.vertx.mysqlclient.impl.MySQLParamDesc;
 import io.vertx.mysqlclient.impl.MySQLRowDesc;
-import io.vertx.sqlclient.impl.ParamDesc;
-import io.vertx.sqlclient.impl.PreparedStatement;
-import io.vertx.sqlclient.impl.RowDesc;
-import io.vertx.sqlclient.impl.TupleInternal;
+import io.vertx.mysqlclient.impl.datatype.DataType;
+import io.vertx.mysqlclient.impl.datatype.DataTypeCodec;
+import io.vertx.sqlclient.impl.*;
+
+import java.util.Arrays;
 
 class MySQLPreparedStatement implements PreparedStatement {
 
@@ -32,6 +33,9 @@ class MySQLPreparedStatement implements PreparedStatement {
   final MySQLRowDesc rowDesc;
   final boolean cacheable;
 
+  private boolean sendTypesToServer;
+  private final DataType[] bindingTypes;
+
   boolean isCursorOpen;
 
   MySQLPreparedStatement(String sql, long statementId, MySQLParamDesc paramDesc, MySQLRowDesc rowDesc, boolean cacheable) {
@@ -40,6 +44,10 @@ class MySQLPreparedStatement implements PreparedStatement {
     this.rowDesc = rowDesc;
     this.sql = sql;
     this.cacheable = cacheable;
+
+    this.bindingTypes = new DataType[paramDesc.paramDefinitions().length];
+    // init param bindings
+    cleanBindings();
   }
 
   @Override
@@ -59,7 +67,42 @@ public String sql() {
 
   @Override
   public String prepare(TupleInternal values) {
-    return paramDesc.prepare(values);
+    return bindParameters(paramDesc, values);
+  }
+
+  boolean sendTypesToServer() {
+    return sendTypesToServer;
+  }
+
+  DataType[] bindingTypes() {
+    return bindingTypes;
+  }
+
+  void cleanBindings() {
+    this.sendTypesToServer = true;
+    Arrays.fill(bindingTypes, DataType.UNBIND);
+  }
+
+  private String bindParameters(MySQLParamDesc paramDesc, TupleInternal params) {
+    int numberOfParameters = params.size();
+    int paramDescLength = paramDesc.paramDefinitions().length;
+    if (numberOfParameters != paramDescLength) {
+      return ErrorMessageFactory.buildWhenArgumentsLengthNotMatched(paramDescLength, numberOfParameters);
+    }
+
+    // binding the parameters
+    boolean reboundParameters = false;
+    for (int i = 0; i < params.size(); i++) {
+      Object value = params.getValue(i);
+      DataType dataType = DataTypeCodec.inferDataTypeByEncodingValue(value);
+      DataType paramDataType = bindingTypes[i];
+      if (paramDataType != dataType) {
+        bindingTypes[i] = dataType;
+        reboundParameters = true;
+      }
+    }
+    sendTypesToServer = reboundParameters; // parameter must be re-bound
+    return null;
   }
 
   @Override
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/ResetStatementCommandCodec.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/ResetStatementCommandCodec.java
@@ -26,26 +26,26 @@ class ResetStatementCommandCodec extends CommandCodec<Void, CloseCursorCommand>
   void encode(MySQLEncoder encoder) {
     super.encode(encoder);
     MySQLPreparedStatement statement = (MySQLPreparedStatement) cmd.statement();
+    statement.cleanBindings();
 
     statement.isCursorOpen = false;
-
-    sendStatementResetCommand(statement);
+    sendStatementResetCommand(statement.statementId);
   }
 
   @Override
   void decodePayload(ByteBuf payload, int payloadLength) {
     handleOkPacketOrErrorPacketPayload(payload);
   }
 
-  private void sendStatementResetCommand(MySQLPreparedStatement statement) {
+  private void sendStatementResetCommand(long statementId) {
     ByteBuf packet = allocateBuffer(PAYLOAD_LENGTH + 4);
     // encode packet header
     packet.writeMediumLE(PAYLOAD_LENGTH);
     packet.writeByte(encoder.sequenceId);
 
     // encode packet payload
     packet.writeByte(CommandType.COM_STMT_RESET);
-    packet.writeIntLE((int) statement.statementId);
+    packet.writeIntLE((int) statementId);
 
     sendNonSplitPacket(packet);
   }
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/RowResultDecoder.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/codec/RowResultDecoder.java
@@ -55,7 +55,7 @@ protected Row decodeRow(int len, ByteBuf in) {
         if (nullByte == 0) {
           // non-null
           ColumnDefinition columnDef = rowDesc.columnDefinitions()[c];
-          DataType dataType = columnDef.getType();
+          DataType dataType = columnDef.type();
           int collationId = rowDesc.columnDefinitions()[c].characterSet();
           int columnDefinitionFlags = columnDef.flags();
           decoded = DataTypeCodec.decodeBinary(dataType, collationId, columnDefinitionFlags, in);
@@ -69,7 +69,7 @@ protected Row decodeRow(int len, ByteBuf in) {
         if (in.getUnsignedByte(in.readerIndex()) == NULL) {
           in.skipBytes(1);
         } else {
-          DataType dataType = rowDesc.columnDefinitions()[c].getType();
+          DataType dataType = rowDesc.columnDefinitions()[c].type();
           int columnDefinitionFlags = rowDesc.columnDefinitions()[c].flags();
           int collationId = rowDesc.columnDefinitions()[c].characterSet();
           decoded = DataTypeCodec.decodeText(dataType, collationId, columnDefinitionFlags, in);
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/datatype/DataType.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/datatype/DataType.java
@@ -47,7 +47,8 @@ public enum DataType {
   BIT(ColumnDefinition.ColumnType.MYSQL_TYPE_BIT, Long.class, Long.class),
   JSON(ColumnDefinition.ColumnType.MYSQL_TYPE_JSON, Object.class, Object.class),
   GEOMETRY(ColumnDefinition.ColumnType.MYSQL_TYPE_GEOMETRY, Geometry.class, Geometry.class),
-  NULL(ColumnDefinition.ColumnType.MYSQL_TYPE_NULL, Object.class, Object.class); // useful for mariadb prepare statement response
+  NULL(ColumnDefinition.ColumnType.MYSQL_TYPE_NULL, Object.class, Object.class), // useful for mariadb prepare statement response
+  UNBIND(-1, Object.class, Object.class); // useful for binding param values
 
   private static final Logger LOGGER = LoggerFactory.getLogger(DataType.class);
 
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/protocol/ColumnDefinition.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/impl/protocol/ColumnDefinition.java
@@ -25,7 +25,7 @@ public final class ColumnDefinition {
   private final String orgName;
   private final int characterSet;
   private final long columnLength;
-  private DataType type;
+  private final DataType type;
   private final int flags;
   private final byte decimals;
 
@@ -85,14 +85,10 @@ public long columnLength() {
     return columnLength;
   }
 
-  public DataType getType() {
+  public DataType type() {
     return type;
   }
 
-  public void setType(DataType type) {
-    this.type = type;
-  }
-
   public int flags() {
     return flags;
   }
