Mybatis控制台打印SQL执行信息(执行方法、执行SQL、执行时间)

ops/2024/11/29 1:21:09/

文章目录

  • 前言
  • 一、基本功能介绍
    • 1.1本章功能效果预览图:
  • 二、可执行源码
    • 2.1 yaml基础配置
    • 2.2 MybatisAnalyzeSQLInterceptor实现SQL拦截

前言

SQL性能监控是一个程序必要的功能，通常我们可以使用数据库自带的客户端工具进行SQL性能分析。然而对于一些专业度不高的人员来说，当程序出现卡顿或者响应速度变慢时，排查问题变得困难。当程序出现卡顿，通常通过检查服务器磁盘使用情况、程序内存大小，网络带宽以及数据库I/O等方面进行问题排查。然而数据库I/O打高的情况通常是由于SQL执行效率过低导致的。一般项目制的公司都有属于自己的实施人员，然而要让实施人员去排查具体SQL执行过慢问题，这显然对于专业度不高的工作人员来说是一种挑战和煎熬。因此本系列文章将介绍如何使用Mybatis的拦截器功能完成对SQL执行的时间记录，并通过MQ推送至SQL记录服务，记录具体的慢SQL信息，后续可以通过页面进行展示。通过可视化的方式让实施人员快速定位到问题所在。

在这里插入图片描述

一、基本功能介绍

本章节只实现Mybatis执行时对执行SQL进行拦截，控制台打印执行SQL包括参数、执行方法以及执行时间。大致结构图如下：
在这里插入图片描述
对慢SQL进行发送MQ,记录显示到前端界面的功能，将在本系列文章第二章实现。

1.1本章功能效果预览图:

在这里插入图片描述

Mapper Method： 显示该SQL是由哪个Mapper方法进行调用执行。
Execute SQL：打印出完整执行的SQL，自动填充了参数。
Spend Time：记录本次SQL执行花费的时间。

二、可执行源码

2.1 yaml基础配置

需要在yaml配置文件中配置是否打印SQL执行信息。当然该配置可以放入Redis中，以方便后续面向微服务时，可以一键开启和关闭，这里就不再演示，后续扩展可有您自主实现。

mybatis-analyze:show-log: true #SQL打印到控制台

2.2 MybatisAnalyzeSQLInterceptor实现SQL拦截

源码可直接复制运行！！！！！

package com.hl.by.common.mybatis.interceptor;import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.time.StopWatch;
import org.apache.ibatis.cache.CacheKey;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.executor.statement.RoutingStatementHandler;
import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.mapping.ParameterMapping;
import org.apache.ibatis.mapping.ParameterMode;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.apache.ibatis.session.RowBounds;
import org.apache.ibatis.type.TypeHandlerRegistry;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;import java.sql.Connection;
import java.sql.Timestamp;
import java.text.SimpleDateFormat;
import java.util.*;
import java.util.concurrent.TimeUnit;/*** @Author: DI.YIN* @Date: 2024/11/25 16:32* @Version: 1.0.0* @Description: Mybatis SQL分析插件**/
@Slf4j
@Intercepts(value = {@Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}),@Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),@Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
})
@Component
public class MybatisAnalyzeSQLInterceptor implements Interceptor {@Value("${mybatis-analyze.show-log:false}")private Boolean showLog;@Overridepublic Object intercept(Invocation invocation) throws Throwable {StopWatch startedWatch = StopWatch.createStarted();Object returnValue = null;Exception proceedSQLException = null;try {returnValue = invocation.proceed();} catch (Exception e) {proceedSQLException = e;}startedWatch.stop();long spendTime = startedWatch.getTime(TimeUnit.MILLISECONDS);if (invocation.getArgs() == null || !(invocation.getArgs()[0] instanceof MappedStatement)) {return returnValue;}// just handle mappedStatementMappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];// get BoundSqlBoundSql boundSql = null;for (int i = invocation.getArgs().length - 1; i >= 0; i--) {if (invocation.getArgs()[i] instanceof BoundSql) {boundSql = (BoundSql) invocation.getArgs()[i];break;}}if (invocation.getTarget() instanceof RoutingStatementHandler) {RoutingStatementHandler routingStatementHandler = (RoutingStatementHandler) invocation.getTarget();boundSql = routingStatementHandler.getBoundSql();}if (boundSql == null) {Object parameter = null;if (invocation.getArgs().length > 1) {parameter = invocation.getArgs()[1];}boundSql = mappedStatement.getBoundSql(parameter);}//printProcessedSQL(boundSql, mappedStatement.getConfiguration(), mappedStatement.getId(), spendTime);// If an exception occurs during SQL execution,throw exceptionif (proceedSQLException != null) {throw proceedSQLException;}return returnValue;}/*** Parse SQL and Print SQL** @param boundSql* @param configuration* @param statement* @param spendTime*/private void printProcessedSQL(BoundSql boundSql, Configuration configuration, String statement, long spendTime) {Map<Integer, Object> parameterValueMap = parseParameterValues(configuration, boundSql);String finalSQL = fillSqlParams(boundSql.getSql(), parameterValueMap);finalSQL = finalSQL.replaceAll("\n", "");String printData = "\n===============Start Print SQL===============\n" +"Mapper Method: [ " + statement + " ]\n" +"Execute SQL: " + finalSQL + " \n" +"Spend Time: " + spendTime + " ms \n" +"===============End Print SQL===============\n";if (showLog) {log.info(printData);}}public static String fillSqlParams(String statementQuery, Map<Integer, Object> parameterValues) {final StringBuilder sb = new StringBuilder();int currentParameter = 0;for (int pos = 0; pos < statementQuery.length(); pos++) {char character = statementQuery.charAt(pos);if (statementQuery.charAt(pos) == '?' && currentParameter <= parameterValues.size()) {Object value = parameterValues.get(currentParameter);sb.append(value != null ? value.toString() : new MybatisAnalyzeSQLInterceptor.Values().toString());currentParameter++;} else {sb.append(character);}}return sb.toString();}/*** 用于解析参数值** @param configuration* @param boundSql* @return Map<Integer, Object>*/private static Map<Integer, Object> parseParameterValues(Configuration configuration, BoundSql boundSql) {Object parameterObject = boundSql.getParameterObject();List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();if (parameterMappings != null) {Map<Integer, Object> parameterValues = new HashMap<>();TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();for (int i = 0; i < parameterMappings.size(); i++) {ParameterMapping parameterMapping = parameterMappings.get(i);if (parameterMapping.getMode() != ParameterMode.OUT) {Object value;String propertyName = parameterMapping.getProperty();if (boundSql.hasAdditionalParameter(propertyName)) {value = boundSql.getAdditionalParameter(propertyName);} else if (parameterObject == null) {value = null;} else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {value = parameterObject;} else {MetaObject metaObject = configuration.newMetaObject(parameterObject);value = metaObject.getValue(propertyName);}parameterValues.put(i, new MybatisAnalyzeSQLInterceptor.Values(value));}}return parameterValues;}return Collections.emptyMap();}@Overridepublic Object plugin(Object target) {return Plugin.wrap(target, this);}@Overridepublic void setProperties(Properties properties0) {}@Setter@Getterpublic static class Values {public static final String NORM_DATETIME_PATTERN = "yyyy-MM-dd HH:mm:ss";public static final String databaseDialectDateFormat = NORM_DATETIME_PATTERN;public static final String databaseDialectTimestampFormat = NORM_DATETIME_PATTERN;private Object value;public Values(Object valueToSet) {this();this.value = valueToSet;}public Values() {}@Overridepublic String toString() {return convertToString(this.value);}public String convertToString(Object value) {String result;if (value == null) {result = "NULL";} else {if (value instanceof byte[]) {result = new String((byte[]) value);} else if (value instanceof Timestamp) {result = new SimpleDateFormat(databaseDialectTimestampFormat).format(value);} else if (value instanceof Date) {result = new SimpleDateFormat(databaseDialectDateFormat).format(value);} else if (value instanceof Boolean) {result = Boolean.FALSE.equals(value) ? "0" : "1";} else {result = value.toString();}result = quoteIfNeeded(result, value);}return result;}private String quoteIfNeeded(String stringValue, Object obj) {if (stringValue == null) {return null;}if (Number.class.isAssignableFrom(obj.getClass()) || Boolean.class.isAssignableFrom(obj.getClass())) {return stringValue;} else {return "'" + escape(stringValue) + "'";}}private String escape(String stringValue) {return stringValue.replaceAll("'", "''");}}
}

http://www.ppmy.cn/ops/137525.html

相关文章

性能测试调优之线程池的性能优化

性能测试调优之线程池的性能优化

做性能测试时&#xff0c;有些压测场景下TPS上不去&#xff0c;或者响应时间变长&#xff0c;或者直接出现一些连接 被拒绝的报错&#xff0c;这些都有可能是tomcat的连接池不够引起的。 连接池的概念 线程池&#xff1a;是一个管理线程集合的框架&#xff0c;它负责维护一个…
阅读更多...
【Oracle11g SQL详解】 SELECT 语句的基础用法与示例

【Oracle11g SQL详解】 SELECT 语句的基础用法与示例

SELECT 语句的基础用法与示例 在 Oracle 11g 中&#xff0c;SELECT 语句是最常用的 SQL 语句&#xff0c;用于从数据库表中查询数据。本文将从语法结构、使用方法和常见示例出发&#xff0c;系统讲解 SELECT 语句的基础用法。 一、SELECT 语句的基本语法 SELECT 列名1, 列名2…
阅读更多...
大数据机器学习算法与计算机视觉应用05：乘法权重算法

大数据机器学习算法与计算机视觉应用05：乘法权重算法

The Multiplicative Weight Algorithm The Experts ProblemWeighed Majority AlgorithmLower Bound for Deterministic AlgorithmsRandomized Weighed Majority Algorithm The Experts Problem 假设现在有 n n n位专家对 T T T天的做出预测 在第 t t t天&#xff0c;第 i i …
阅读更多...
后台管理-动态路由配置以及用户权限管理（vue3+element plus+koa+Sequelize ）

后台管理-动态路由配置以及用户权限管理（vue3+element plus+koa+Sequelize ）

前言 之前开发了一个校园二手物品交易网站的demo 前端采用Vue2结合Element UI 后端采用了koa 、Sequelize 、Mysql 在工作了一年多之后&#xff0c;突然想针对工作所学来完善一下自己手里的项目 想要做一个针对于该平台或多个平台&#xff0c;来进行路由配置和角色集中管理…
阅读更多...
算法篇：贪心算法

算法篇：贪心算法

题目一&#xff1a;均分纸牌 有n堆纸牌&#xff0c;编号分别为 1&#xff0c;2&#xff0c;…,n1&#xff0c;2&#xff0c;…,n。每堆上有若干张&#xff0c;但纸牌总数必为nn的倍数。可以在任一堆上取若干张纸牌&#xff0c;然后移动。 移牌规则为&#xff1a;在编号为11的…
阅读更多...
Kafka日志索引详解以及生产常见问题分析与总结

Kafka日志索引详解以及生产常见问题分析与总结

文章目录 一、Kafka的Log日志梳理1.1、Topic下的消息如何存储1.1.1、log文件追加记录所有消息1.1.2、index和timeindex加速读取log消息日志 1.2、文件清理机制1.2.1、如何判断哪些日志文件过期了1.2.2、过期的日志文件如何处理 1.3、Kafka的文件高效读写机制1.3.1、Kafka的文件…
阅读更多...
CBK7运营安全

CBK7运营安全

1 运营部门的角色 ​ prudent man、due care&#xff08;按要求执行&#xff09;VS due diligence&#xff08;承担管理者责任&#xff09; ​ 应尽关注&#xff1a;执行了负责任的动作降低了风险。 ​ 应尽职责&#xff1a;采取了所有必要的安全步骤以了解公司或个人的实际风…
阅读更多...
2024年11月27日Github流行趋势

2024年11月27日Github流行趋势

项目名称&#xff1a;screenshot-to-code 项目维护者&#xff1a;abi clean99 sweep-ai kachbit vagusX项目介绍&#xff1a;通过上传截图将其转换为整洁的代码&#xff08;支持HTML/Tailwind/React/Vue&#xff09;。项目star数&#xff1a;62,429项目fork数&#xff1a;7,614…
阅读更多...
最新文章

Copyright @ 2022~2023