mysql logger connector_mysql-connector-j SQL 请求执行过程梳理

本次源码分析基于 mysql-connector-8.0.20

一、SQL 请求调用链路跟踪

当上层应用或 ORM 框架调用 PreparedStatement#execute 方法时，会直接调用 mysql-connector-j 包中 ClientPreparedStatement#execute 方法，从此处开始正式进入 MySQL 驱动程序的逻辑。后续的源码我会进行相应的简化，突出重点，方便理解

1.1 ClientPreparedStatement：SQL 请求入口

// ClientPreparedStatement.class

@Override

public boolean execute() throws SQLException {

synchronized (checkClosed().getConnectionMutex()) {

JdbcConnection locallyScopedConn = this.connection;

ResultSetInternalMethods rs = null;

Message sendPacket = ((PreparedQuery>) this.query).fillSendPacket();

rs = executeInternal(this.maxRows, sendPacket, createStreamingResultSet(),

(((PreparedQuery>) this.query).getParseInfo().getFirstStmtChar() == 'S'), cachedMetadata, false);

if (rs != null) {

this.results = rs;

}

return ((rs != null) && rs.hasRows());

}

}

我们可以看到获取 ResultSet 的详细过程在 ClientPreparedStatement#executeInternal 方法中

// ClientPreparedStatement.class

protected ResultSetInternalMethods executeInternal(int maxRowsToRetrieve, M sendPacket, boolean createStreamingResultSet,

boolean queryIsSelectOnly, ColumnDefinition metadata, boolean isBatch) throws SQLException {

synchronized (checkClosed().getConnectionMutex()) {

JdbcConnection locallyScopedConnection = this.connection;

((PreparedQuery>) this.query).getQueryBindings()

.setNumberOfExecutions(((PreparedQuery>) this.query).getQueryBindings().getNumberOfExecutions() + 1);

ResultSetInternalMethods rs = ((NativeSession) locallyScopedConnection.getSession()).execSQL(this, null, maxRowsToRetrieve, (NativePacketPayload) sendPacket, createStreamingResultSet, getResultSetFactory(), metadata, isBatch);

return rs;

}

}

核心过程在 NativeSession#execSQL 方法中

// NativeSession.class

public T execSQL(Query callingQuery, String query, int maxRows, NativePacketPayload packet, boolean streamResults,

ProtocolEntityFactory resultSetFactory, ColumnDefinition cachedMetadata, boolean isBatch) {

return packet == null ?

((NativeProtocol) this.protocol).sendQueryString(callingQuery, query, this.characterEncoding.getValue(), maxRows, streamResults, cachedMetadata, resultSetFactory) :

((NativeProtocol) this.protocol).sendQueryPacket(callingQuery, packet, maxRows, streamResults, cachedMetadata, resultSetFactory);

}

可以看到在 execSQL 中，若命令包不为 null，则执行 NativeProtocol#sendQueryPacket 方法

1.2 NativeProtocol：执行 SQL 请求并返回结果

public final T sendQueryPacket(Query callingQuery, NativePacketPayload queryPacket, int maxRows, boolean streamResults,

ColumnDefinition cachedMetadata, ProtocolEntityFactory resultSetFactory) throws IOException {

final long queryStartTime = getCurrentTimeNanosOrMillis();

this.statementExecutionDepth++;

// 1 获取 SQL 二进字符数组

byte[] queryBuf = queryPacket.getByteBuffer();

int oldPacketPosition = queryPacket.getPosition(); // save the packet position

LazyString query = new LazyString(queryBuf, 1, (oldPacketPosition - 1));

try {

// 2 若存在拦截器，则调用拦截器的前置处理方法 preProcess 对 SQL 进行处理，并返回结果

if (this.queryInterceptors != null) {

// 若拦截器 preProcess 方法返回非 null，则直接返回拦截处理后的 Resultset

T interceptedResults = invokeQueryInterceptorsPre(query, callingQuery, false);

if (interceptedResults != null) {

return interceptedResults;

}

}

// 3 Send query command and sql query string

NativePacketPayload resultPacket = sendCommand(queryPacket, false, 0);

// 4 读取 SQL 执行结果

T rs = readAllResults(maxRows, streamResults, resultPacket, false, cachedMetadata, resultSetFactory);

// 5 若存在拦截器，则调用拦截器的后置处理方法 postProcess 对 SQL、 Resultset 等进行处理，并返回结果

if (this.queryInterceptors != null) {

rs = invokeQueryInterceptorsPost(query, callingQuery, rs, false);