Mybatis 实现打印sql语句的代码

更新时间：2021年04月01日 15:35:44 作者：上学威龙7

这篇文章主要介绍了Mybatis 实现打印sql语句的代码,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

mybatis本身没有提供日志的实现，引入的是第三方组件。mybatis支持多个第三方日志插件，优先级由低到高为slf4J、commonsLoging、Log4J2、Log4J和JdkLog。

mybatis中有一个LogFactory，获取log的工厂类，在工程类中可以回去对应的日志实现。分析工程类，可以发现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);
 }
}

关于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 ，中会设置mybatis使用的log类型。把引用的log设置到logConstructor中后，后续其他类型的log也不会再加载。所以在mybatis中优先级由低到高为slf4J、commonsLoging、Log4J2、Log4J和JdkLog。感觉也是属于SPI的一种实现方式，不同的是各种类型的第三方日志，无法形成一个统一的接口。故此，mybatis为了解决这一问题，使用了适配器模式。

适配器的实现一般是让适配器实现或者继承目标，并且内部持有一个适配者的引用。这样调用目标对象方法，实际上是调用适配者的方法。

mybatis 又是如何把这log，用起来的。根据mybatis的习惯，应该会使用代理模式，来打印这个日志。举例查询的语句查看，根据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在获取连接的时候，会根据日志的打印级别来判断是否会创建一个代理类。到这里就基本可以猜到，在代理类中，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在里面还可以更具情况创建代理类。代理类又一次被代理，这也是mybatis喜欢的编程方式，比如插件也是代理类再次被代理，来实现多个插件并行。

到此这篇关于Mybatis 实现打印sql语句的代码的文章就介绍到这了,更多相关Mybatis 打印sql语句内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

如何基于springboot-admin实现后台监控
这篇文章主要介绍了如何基于springboot-admin实现后台监控,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-04-04
$java-制表符\t的使用说明$
java-制表符\t的使用说明
这篇文章主要介绍了java-制表符\t的使用说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-02-02
SpringBoot--Banner的定制和关闭操作
这篇文章主要介绍了SpringBoot--Banner的定制和关闭操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2018-05-05
Spring Bean的线程安全问题
Spring容器中的Bean是否线程安全，本文主要介绍了Spring Bean的线程安全问题，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
java实现自动售货机
这篇文章主要为大家详细介绍了java实现自动售货机，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-01-01
Java设计模式之浅谈模板方法模式
今天给大家带来的是关于Java设计模式的相关知识,文章围绕着Java模板方法展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
2021-06-06
Java由浅入深学习数组的使用
数组对于每一门编程语言来说都是重要的数据结构之一，当然不同语言对数组的实现及处理也不尽相同。Java 语言中提供的数组是用来存储固定大小的同类型元素
2022-05-05
@RequestBody的使用详解
这篇文章主要介绍了@RequestBody的使用详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-12-12
Java并发CopyOnWrite容器原理解析
这篇文章主要介绍了Java并发CopyOnWrite容器原理解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-01-01
使用ehcache三步搞定springboot缓存的方法示例
本次内容主要介绍基于Ehcache 3.0来快速实现Spring Boot应用程序的数据缓存功能。小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2019-04-04