mybatis统计每条SQL的执行时间的方法示例

背景

最近面试经常被问到关于数据库的事务的问题，可能平时我就知道加个注解@Transactional之后就一脸懵逼的。现在发现这一块真的是常常被忽略了，然而面试官就是最喜欢这种看是不常用，但是非常重要的问题，进而达到出其不意攻其不备。不吹水了，开始正文。

方案一：切面编程@Aspect

此方案主要是通过环绕切面的方式将mapper包下的接口方法，然后前后计算时间差即可。这就是典型的AOP知识，不过这种计算比较粗糙，但是也是个办法。具体方法如下：

1. @Aspect
2. @Component
3. @Slf4j
4. public class MapperAspect {
5.  
6. @AfterReturning("execution(* cn.xbmchina.mybatissqltime.mapper.*Mapper.*(..))")
7. public void logServiceAccess(JoinPoint joinPoint) {
8. log.info("Completed: " + joinPoint);
9. }
10.  
11.  
12. /**
13. * 监控cn.xbmchina.mybatissqltime.mapper..*Mapper包及其子包的所有public方法
14. */
15. @Pointcut("execution(* cn.xbmchina.mybatissqltime.mapper.*Mapper.*(..))")
16. private void pointCutMethod() {
17. }
18.  
19. /**
20. * 声明环绕通知
21. *
22. * @param pjp
23. * @return
24. * @throws Throwable
25. */
26. @Around("pointCutMethod()")
27. public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
28. long begin = System.nanoTime();
29. Object obj = pjp.proceed();
30. long end = System.nanoTime();
31.  
32. log.info("调用Mapper方法：{}，参数：{}，执行耗时：{}纳秒，耗时：{}毫秒",
33. pjp.getSignature().toString(), Arrays.toString(pjp.getArgs()),
34. (end - begin), (end - begin) / 1000000);
35. return obj;
36. }
37. }
38.  

方案二：mybatis 的插件

MyBatis在四大对象的创建过程中，都会有插件进行介入。插件可以利用动态代理机制一层层的包装目标对象，而实现在目标对象执行目标方法之前进行拦截的效果。

MyBatis 允许在已映射语句执行过程中的某一点进行拦截调用。

默认情况下，MyBatis 允许使用插件来拦截的方法调用包括：

①Executor(update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
②ParameterHandler(getParameterObject, setParameters)
③ResultSetHandler(handleResultSets, handleOutputParameters)
④StatementHandler(prepare, parameterize, batch, update, query)

下面是代码:

1. import org.apache.ibatis.executor.statement.StatementHandler;
2. import org.apache.ibatis.mapping.BoundSql;
3. import org.apache.ibatis.mapping.ParameterMapping;
4. import org.apache.ibatis.plugin.Interceptor;
5. import org.apache.ibatis.plugin.Intercepts;
6. import org.apache.ibatis.plugin.Invocation;
7. import org.apache.ibatis.plugin.Plugin;
8. import org.apache.ibatis.plugin.Signature;
9. import org.apache.ibatis.session.ResultHandler;
10. import org.slf4j.Logger;
11. import org.slf4j.LoggerFactory;
12. import org.springframework.stereotype.Component;
13.  
14. import java.sql.Statement;
15. import java.util.List;
16. import java.util.Properties;
17.  
18. /**
19. * Sql执行时间记录拦截器
20. *
21. * @author zero
22. * 2019年12月13日17:05:28
23. */
24. @Intercepts({@Signature(type = StatementHandler.class, method = "query", args ={Statement.class, ResultHandler.class}),
25. @Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),
26. @Signature(type = StatementHandler.class, method = "batch", args = {Statement.class})})
27. @Component
28. public class SqlExecuteTimeCountInterceptor implements Interceptor {
29.  
30. private static Logger logger =LoggerFactory.getLogger(SqlExecuteTimeCountInterceptor.class);
31.  
32. /**
33. * 打印的参数字符串的最大长度
34. */
35. private final static int MAX_PARAM_LENGTH = 50;
36.  
37. /**
38. * 记录的最大SQL长度
39. */
40. private final static int MAX_SQL_LENGTH = 200;
41.  
42.  
43. @Override
44. public Object intercept(Invocation invocation) throws Throwable {
45. Object target = invocation.getTarget();
46. long startTime = System.currentTimeMillis();
47. StatementHandler statementHandler = (StatementHandler) target;
48. try {
49. return invocation.proceed();
50. } finally {
51. long endTime = System.currentTimeMillis();
52. long timeCount = endTime - startTime;
53.  
54. BoundSql boundSql = statementHandler.getBoundSql();
55. String sql = boundSql.getSql();
56. Object parameterObject = boundSql.getParameterObject();
57. List<ParameterMapping> parameterMappingList = boundSql.getParameterMappings();
58.  
59. // 格式化Sql语句，去除换行符，替换参数
60. sql = formatSQL(sql, parameterObject, parameterMappingList);
61.  
62. logger.info("执行 SQL：[ , {} ]执行耗时[ {} ms]", sql, timeCount);
63. }
64. }
65.  
66.  
67. /**
68. * 格式化/美化 SQL语句
69. *
70. * @param sql sql 语句
71. * @param parameterObject 参数的Map
72. * @param parameterMappingList 参数的List
73. * @return 格式化之后的SQL
74. */
75. private String formatSQL(String sql, Object parameterObject, List<ParameterMapping>parameterMappingList) {
76. // 输入sql字符串空判断
77. if (sql == null || sql.length() == 0) {
78. return "";
79. }
80. // 美化sql
81. sql = beautifySql(sql);
82. // 不传参数的场景，直接把sql美化一下返回出去
83. if (parameterObject == null || parameterMappingList == null || parameterMappingList.size()== 0) {
84. return sql;
85. }
86. return LimitSQLLength(sql);
87. }
88.  
89.  
90. /**
91. * 返回限制长度之后的SQL语句
92. *
93. *
94. * @param sql 原始SQL语句
95. */
96. private String LimitSQLLength(String sql) {
97. if (sql == null || sql.length() == 0) {
98. return "";
99. }
100. if (sql.length() > MAX_SQL_LENGTH) {
101. return sql.substring(0, MAX_SQL_LENGTH);
102. } else {
103. return sql;
104. }
105. }
106.  
107.  
108. @Override
109. public Object plugin(Object target) {
110. return Plugin.wrap(target, this);
111. }
112.  
113. @Override
114. public void setProperties(Properties properties) {
115.  
116. }
117.  
118.  
119.  
120.  
121. /**
122. * 替换SQL 中? 所对应的值, 只保留前50个字符
123. *
124. * @param sql sql语句
125. * @param valueOf ?对应的值
126. */
127. private String replaceValue(String sql, String valueOf) {
128. //超过50个字符只取前50个
129. if (valueOf != null && valueOf.length() > MAX_PARAM_LENGTH) {
130. valueOf = valueOf.substring(0, MAX_PARAM_LENGTH);
131. }
132. sql = sql.replaceFirst("\\?", valueOf);
133. return sql;
134. }
135.  
136. /**
137. * 美化sql
138. *
139. * @param sql sql语句
140. */
141. private String beautifySql(String sql) {
142. sql = sql.replaceAll("[\\s\n ]+", " ");
143. return sql;
144. }
145. }

方案三：直接用druid

这种就是我们平时用的最多的，但是面试的话说一下就得了，估计也没有怎么好问的了。

Springboot+druid的配置application.yml文件如下：

1. spring:
2. datasource:
3. url: jdbc:mysql://localhost:3306/testdb1?characterEncoding=utf-8&useUnicode=true&useSSL=false&serverTimezone=UTC
4. driver-class-name: com.mysql.jdbc.Driver # mysql8.0以前使用com.mysql.jdbc.Driver
5. username: root
6. password: root
7. platform: mysql
8. #通过这句配置将druid连接池引入到我们的配置中，spring会尽可能判断类型是什么，然后根据情况去匹配驱动类。
9. type: com.alibaba.druid.pool.DruidDataSource
10. druid:
11. initial-size: 5 # 初始化大小
12. min-idle: 5 # 最小
13. max-active: 100 # 最大
14. max-wait: 60000 # 配置获取连接等待超时的时间
15. time-between-eviction-runs-millis: 60000 # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
16. min-evictable-idle-time-millis: 300000 # 指定一个空闲连接最少空闲多久后可被清除，单位是毫秒
17. validationQuery: select 'x'
18. test-while-idle: true # 当连接空闲时，是否执行连接测试
19. test-on-borrow: false # 当从连接池借用连接时，是否测试该连接
20. test-on-return: false # 在连接归还到连接池时是否测试该连接
21. filters: config,wall,stat # 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙
22. poolPreparedStatements: true # 打开PSCache，并且指定每个连接上PSCache的大小
23. maxPoolPreparedStatementPerConnectionSize: 20
24. maxOpenPreparedStatements: 20
25. # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
26. connectionProperties:druid.stat.slowSqlMillis=200;druid.stat.logSlowSql=true;config.decrypt=false
27. # 合并多个DruidDataSource的监控数据
28. #use-global-data-source-stat: true
29. #WebStatFilter配置，说明请参考Druid Wiki，配置_配置WebStatFilter
30. web-stat-filter:
31. enabled: true #是否启用StatFilter默认值true
32. url-pattern: /*
33. exclusions: /druid/*,*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico
34. session-stat-enable: true
35. session-stat-max-count: 10
36. #StatViewServlet配置，说明请参考Druid Wiki，配置_StatViewServlet配置
37. stat-view-servlet:
38. enabled: true #是否启用StatViewServlet默认值true
39. url-pattern: /druid/*
40. reset-enable: true
41. login-username: admin
42. login-password: admin

总结

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。