Mybatis 實現(xiàn)打印sql語句的代碼

更新時間：2021年04月01日 15:35:44 作者：上學威龍7

這篇文章主要介紹了Mybatis 實現(xiàn)打印sql語句的代碼,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

mybatis本身沒有提供日志的實現(xiàn)，引入的是第三方組件。mybatis支持多個第三方日志插件，優(yōu)先級由低到高為slf4J、commonsLoging、Log4J2、Log4J和JdkLog。

mybatis中有一個LogFactory，獲取log的工廠類，在工程類中可以回去對應的日志實現(xiàn)。分析工程類，可以發(fā)現(xiàn)mybatis如何來選擇log

public static Log getLog(String logger) {
 try {
 return logConstructor.newInstance(logger);
 } catch (Throwable t) {
 throw new LogException("Error creating logger for logger " + logger + ". Cause: " + t, t);
 }
}

關(guān)于logConstructor的加載如下

static {
 tryImplementation(LogFactory::useSlf4jLogging);
 tryImplementation(LogFactory::useCommonsLogging);
 tryImplementation(LogFactory::useLog4J2Logging);
 tryImplementation(LogFactory::useLog4JLogging);
 tryImplementation(LogFactory::useJdkLogging);
 tryImplementation(LogFactory::useNoLogging);
}

private static void tryImplementation(Runnable runnable) {
 if (logConstructor == null) {
 try {
 runnable.run();
 } catch (Throwable t) {
 // ignore
 }
 }
}

在 tryImplementation ，中會設(shè)置mybatis使用的log類型。把引用的log設(shè)置到logConstructor中后，后續(xù)其他類型的log也不會再加載。所以在mybatis中優(yōu)先級由低到高為slf4J、commonsLoging、Log4J2、Log4J和JdkLog。感覺也是屬于SPI的一種實現(xiàn)方式，不同的是各種類型的第三方日志，無法形成一個統(tǒng)一的接口。故此，mybatis為了解決這一問題，使用了適配器模式。

適配器的實現(xiàn)一般是讓適配器實現(xiàn)或者繼承目標，并且內(nèi)部持有一個適配者的引用。這樣調(diào)用目標對象方法，實際上是調(diào)用適配者的方法。

mybatis 又是如何把這log，用起來的。根據(jù)mybatis的習慣，應該會使用代理模式，來打印這個日志。舉例查詢的語句查看，根據(jù)MapperProxy,查到最后查詢的語句

public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
 Statement stmt = null;
 try {
 Configuration configuration = ms.getConfiguration();
 StatementHandler handler = configuration.newStatementHandler(wrapper, ms, parameter, rowBounds, resultHandler, boundSql);
 stmt = prepareStatement(handler, ms.getStatementLog());
 return handler.query(stmt, resultHandler);
 } finally {
 closeStatement(stmt);
 }
}

private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
 Statement stmt;
 Connection connection = getConnection(statementLog);
 stmt = handler.prepare(connection, transaction.getTimeout());
 handler.parameterize(stmt);
 return stmt;
}

protected Connection getConnection(Log statementLog) throws SQLException {
 Connection connection = transaction.getConnection();
 if (statementLog.isDebugEnabled()) {
 return ConnectionLogger.newInstance(connection, statementLog, queryStack);
 } else {
 return connection;
 }
}

到此處可以看到mybatis在獲取連接的時候，會根據(jù)日志的打印級別來判斷是否會創(chuàng)建一個代理類。到這里就基本可以猜到，在代理類中，mybatis會去打印這個sql的語句

public static Connection newInstance(Connection conn, Log statementLog, int queryStack) {
 InvocationHandler handler = new ConnectionLogger(conn, statementLog, queryStack);
 ClassLoader cl = Connection.class.getClassLoader();
 return (Connection) Proxy.newProxyInstance(cl, new Class[]{Connection.class}, handler);
}

用 ConnectionLogger 來舉例，看到里面的invoke的方法

public Object invoke(Object proxy, Method method, Object[] params)
 throws Throwable {
 try {
 if (Object.class.equals(method.getDeclaringClass())) {
 return method.invoke(this, params);
 }
 if ("prepareStatement".equals(method.getName())) {
 if (isDebugEnabled()) {
 debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
 }
 PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
 stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
 return stmt;
 } else if ("prepareCall".equals(method.getName())) {
 if (isDebugEnabled()) {
 debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
 }
 PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
 stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
 return stmt;
 } else if ("createStatement".equals(method.getName())) {
 Statement stmt = (Statement) method.invoke(connection, params);
 stmt = StatementLogger.newInstance(stmt, statementLog, queryStack);
 return stmt;
 } else {
 return method.invoke(connection, params);
 }
 } catch (Throwable t) {
 throw ExceptionUtil.unwrapThrowable(t);
 }
}

可以看到，mybatis在里面還可以更具情況創(chuàng)建代理類。代理類又一次被代理，這也是mybatis喜歡的編程方式，比如插件也是代理類再次被代理，來實現(xiàn)多個插件并行。

到此這篇關(guān)于Mybatis 實現(xiàn)打印sql語句的代碼的文章就介紹到這了,更多相關(guān)Mybatis 打印sql語句內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: