Mybatis控制台打印SQL实行信息(实行方法、实行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中，以方便后续面向微服务时，可以一键开启和关闭，这里就不再演示，后续扩展可有您自主实现。

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

复制代码

---

2.2 MybatisAnalyzeSQLInterceptor实现SQL拦截

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

1. package com.hl.by.common.mybatis.interceptor;
3. import lombok.Getter;
4. import lombok.Setter;
5. import lombok.extern.slf4j.Slf4j;
6. import org.apache.commons.lang3.time.StopWatch;
7. import org.apache.ibatis.cache.CacheKey;
8. import org.apache.ibatis.executor.Executor;
9. import org.apache.ibatis.executor.statement.RoutingStatementHandler;
10. import org.apache.ibatis.executor.statement.StatementHandler;
11. import org.apache.ibatis.mapping.BoundSql;
12. import org.apache.ibatis.mapping.MappedStatement;
13. import org.apache.ibatis.mapping.ParameterMapping;
14. import org.apache.ibatis.mapping.ParameterMode;
15. import org.apache.ibatis.plugin.*;
16. import org.apache.ibatis.reflection.MetaObject;
17. import org.apache.ibatis.session.Configuration;
18. import org.apache.ibatis.session.ResultHandler;
19. import org.apache.ibatis.session.RowBounds;
20. import org.apache.ibatis.type.TypeHandlerRegistry;
21. import org.springframework.beans.factory.annotation.Value;
22. import org.springframework.stereotype.Component;
24. import java.sql.Connection;
25. import java.sql.Timestamp;
26. import java.text.SimpleDateFormat;
27. import java.util.*;
28. import java.util.concurrent.TimeUnit;
30. /**
31. * @Author: DI.YIN
32. * @Date: 2024/11/25 16:32
33. * @Version: 1.0.0
34. * @Description: Mybatis SQL分析插件
35. **/
36. @Slf4j
37. @Intercepts(value = {
38.         @Signature(type = StatementHandler.class, method = "prepare", args = {Connection.class, Integer.class}),
39.         @Signature(type = Executor.class, method = "update", args = {MappedStatement.class, Object.class}),
40.         @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
41.         @Signature(type = Executor.class, method = "query", args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
42. })
43. @Component
44. public class MybatisAnalyzeSQLInterceptor implements Interceptor {
46.     @Value("${mybatis-analyze.show-log:false}")
47.     private Boolean showLog;
49.     @Override
50.     public Object intercept(Invocation invocation) throws Throwable {
52.         StopWatch startedWatch = StopWatch.createStarted();
53.         Object returnValue = null;
54.         Exception proceedSQLException = null;
55.         try {
56.             returnValue = invocation.proceed();
57.         } catch (Exception e) {
58.             proceedSQLException = e;
59.         }
60.         startedWatch.stop();
61.         long spendTime = startedWatch.getTime(TimeUnit.MILLISECONDS);
62.         if (invocation.getArgs() == null || !(invocation.getArgs()[0] instanceof MappedStatement)) {
63.             return returnValue;
64.         }
65.         // just handle mappedStatement
66.         MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
67.         // get BoundSql
68.         BoundSql boundSql = null;
69.         for (int i = invocation.getArgs().length - 1; i >= 0; i--) {
70.             if (invocation.getArgs()[i] instanceof BoundSql) {
71.                 boundSql = (BoundSql) invocation.getArgs()[i];
72.                 break;
73.             }
74.         }
75.         if (invocation.getTarget() instanceof RoutingStatementHandler) {
76.             RoutingStatementHandler routingStatementHandler = (RoutingStatementHandler) invocation.getTarget();
77.             boundSql = routingStatementHandler.getBoundSql();
78.         }
79.         if (boundSql == null) {
80.             Object parameter = null;
81.             if (invocation.getArgs().length > 1) {
82.                 parameter = invocation.getArgs()[1];
83.             }
84.             boundSql = mappedStatement.getBoundSql(parameter);
85.         }
86.         //
87.         printProcessedSQL(boundSql, mappedStatement.getConfiguration(), mappedStatement.getId(), spendTime);
88.         // If an exception occurs during SQL execution,throw exception
89.         if (proceedSQLException != null) {
90.             throw proceedSQLException;
91.         }
92.         return returnValue;
93.     }
95.     /**
96.      * Parse SQL and Print SQL
97.      *
98.      * @param boundSql
99.      * @param configuration
100.      * @param statement
101.      * @param spendTime
102.      */
103.     private void printProcessedSQL(BoundSql boundSql, Configuration configuration, String statement, long spendTime) {
104.         Map<Integer, Object> parameterValueMap = parseParameterValues(configuration, boundSql);
105.         String finalSQL = fillSqlParams(boundSql.getSql(), parameterValueMap);
106.         finalSQL = finalSQL.replaceAll("\n", "");
107.         String printData = "\n===============Start Print SQL===============\n" +
108.                 "Mapper Method: [ " + statement + " ]\n" +
109.                 "Execute SQL: " + finalSQL + " \n" +
110.                 "Spend Time: " + spendTime + " ms \n" +
111.                 "===============End Print SQL===============\n";
112.         if (showLog) {
113.             log.info(printData);
114.         }
115.     }
117.     public static String fillSqlParams(String statementQuery, Map<Integer, Object> parameterValues) {
118.         final StringBuilder sb = new StringBuilder();
119.         int currentParameter = 0;
120.         for (int pos = 0; pos < statementQuery.length(); pos++) {
121.             char character = statementQuery.charAt(pos);
122.             if (statementQuery.charAt(pos) == '?' && currentParameter <= parameterValues.size()) {
123.                 Object value = parameterValues.get(currentParameter);
124.                 sb.append(value != null ? value.toString() : new MybatisAnalyzeSQLInterceptor.Values().toString());
125.                 currentParameter++;
126.             } else {
127.                 sb.append(character);
128.             }
129.         }
130.         return sb.toString();
131.     }
133.     /**
134.      * 用于解析参数值
135.      *
136.      * @param configuration
137.      * @param boundSql
138.      * @return Map<Integer, Object>
139.      */
140.     private static Map<Integer, Object> parseParameterValues(Configuration configuration, BoundSql boundSql) {
141.         Object parameterObject = boundSql.getParameterObject();
142.         List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
143.         if (parameterMappings != null) {
144.             Map<Integer, Object> parameterValues = new HashMap<>();
145.             TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
146.             for (int i = 0; i < parameterMappings.size(); i++) {
147.                 ParameterMapping parameterMapping = parameterMappings.get(i);
148.                 if (parameterMapping.getMode() != ParameterMode.OUT) {
149.                     Object value;
150.                     String propertyName = parameterMapping.getProperty();
151.                     if (boundSql.hasAdditionalParameter(propertyName)) {
152.                         value = boundSql.getAdditionalParameter(propertyName);
153.                     } else if (parameterObject == null) {
154.                         value = null;
155.                     } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
156.                         value = parameterObject;
157.                     } else {
158.                         MetaObject metaObject = configuration.newMetaObject(parameterObject);
159.                         value = metaObject.getValue(propertyName);
160.                     }
161.                     parameterValues.put(i, new MybatisAnalyzeSQLInterceptor.Values(value));
162.                 }
163.             }
164.             return parameterValues;
165.         }
166.         return Collections.emptyMap();
167.     }
169.     @Override
170.     public Object plugin(Object target) {
171.         return Plugin.wrap(target, this);
172.     }
174.     @Override
175.     public void setProperties(Properties properties0) {
176.     }
178.     @Setter
179.     @Getter
180.     public static class Values {
181.         public static final String NORM_DATETIME_PATTERN = "yyyy-MM-dd HH:mm:ss";
183.         public static final String databaseDialectDateFormat = NORM_DATETIME_PATTERN;
184.         public static final String databaseDialectTimestampFormat = NORM_DATETIME_PATTERN;
185.         private Object value;
187.         public Values(Object valueToSet) {
188.             this();
189.             this.value = valueToSet;
190.         }
192.         public Values() {
193.         }
195.         @Override
196.         public String toString() {
197.             return convertToString(this.value);
198.         }
200.         public String convertToString(Object value) {
201.             String result;
203.             if (value == null) {
204.                 result = "NULL";
205.             } else {
206.                 if (value instanceof byte[]) {
207.                     result = new String((byte[]) value);
208.                 } else if (value instanceof Timestamp) {
209.                     result = new SimpleDateFormat(databaseDialectTimestampFormat).format(value);
210.                 } else if (value instanceof Date) {
211.                     result = new SimpleDateFormat(databaseDialectDateFormat).format(value);
212.                 } else if (value instanceof Boolean) {
213.                     result = Boolean.FALSE.equals(value) ? "0" : "1";
214.                 } else {
215.                     result = value.toString();
216.                 }
217.                 result = quoteIfNeeded(result, value);
218.             }
220.             return result;
221.         }
223.         private String quoteIfNeeded(String stringValue, Object obj) {
224.             if (stringValue == null) {
225.                 return null;
226.             }
227.             if (Number.class.isAssignableFrom(obj.getClass()) || Boolean.class.isAssignableFrom(obj.getClass())) {
228.                 return stringValue;
229.             } else {
230.                 return "'" + escape(stringValue) + "'";
231.             }
232.         }
234.         private String escape(String stringValue) {
235.             return stringValue.replaceAll("'", "''");
236.         }
237.     }
238. }

复制代码

---

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。