一招搞定! 自定义MyBatis拦截器,SQL日志存储成本直降30%

Spring Boot集成MyBatis-Plus:自定义拦截器实现动态表名切换 介绍动态表名的场景需求,比如多租户系统、分表分库,或者不同业务模块共用一套代码但操作不同表。说明 MyBatis-Plus 默认绑定固定表名的问题。解释 MyBatis 拦截器的核心概念,介绍接口和@Signature注解。MyBatis 拦截器为开发者提供了灵活的扩展能力,可以在 SQL 执行的多个阶段中注入自定义逻辑,从而实现多种高级功能。合理使用拦截器不仅能增强系统功能,还能提升性能和安全性。 阅读详情

👉 这是一个或许对你有用的社群

🐱 一对一交流/面试小册/简历优化/求职解惑,欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料: 

👉这是一个或许对你有用的开源项目

国产Star破10w的开源项目,前端包括管理后台、微信小程序,后端支持单体、微服务架构

RBAC权限、数据权限、SaaS多租户、商城、支付、工作流、大屏报表、ERP、CRM、AI大模型、IoT物联网等功能:

  • 多模块:https://gitee.com/zhijiantianya/ruoyi-vue-pro

  • 微服务:https://gitee.com/zhijiantianya/yudao-cloud

  • 视频教程:https://doc.iocoder.cn

【国内首批】支持 JDK17/21+SpringBoot3、JDK8/11+Spring Boot2双版本 

来源:juejin.cn/post/7483708438683893795


背景

MyBatis Plus 通过配置文件中设置 log-impl 属性来指定日志实现,以打印 SQL 语句。

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

logging:
  level:
    org.ylzl.eden.demo.mapper: DEBUG

打印出来的 SQL 内容如下:

==>  Preparing: SELECT id,login,email,activated,locked,lang_key,activation_key,reset_key,reset_date,created_by,created_date,last_modified_by,last_modified_date FROM demo_user WHERE id=?
==> Parameters: 1(Long)
<==  Columns: ID, LOGIN, EMAIL, ACTIVATED, LOCKED, LANG_KEY, ACTIVATION_KEY, RESET_KEY, RESET_DATE, CREATED_BY, CREATED_DATE, LAST_MODIFIED_BY, LAST_MODIFIED_DATE
<==  Row: 1, admin, 1813986321@qq.com, TRUE, FALSE, zh-cn, null, null, null, system, 2025-02-10 22:31:03.818, system, null
<==  Total: 1

然而,默认的日志输出格式存在以下不足:

  • 缺少日志时间,无法快速定位 SQL 执行时间。

  • SQL 语句可读性差,复杂的 SQL 语句难以阅读。

  • 日志存储成本高:SQL 模板占用较多字符,增加了日志存储成本。

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/ruoyi-vue-pro

  • 视频教程:https://doc.iocoder.cn/video/

目标

通过 MyBatis 的拦截器实现 SQL 原始语句的打印。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

  • 项目地址:https://github.com/YunaiV/yudao-cloud

  • 视频教程:https://doc.iocoder.cn/video/

实现

首先,自定义 MyBatis 拦截器,实现 org.apache.ibatis.plugin.Interceptor 接口。

@Intercepts({
@Signature(method = "query", type = Executor.class, args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
 @Signature(method = "query", type = Executor.class, args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class, CacheKey.class, BoundSql.class}),
 @Signature(method = "update", type = Executor.class, args = {MappedStatement.class, Object.class})
})
public class MybatisSqlLogInterceptor implements Interceptor {

privatestaticfinal Logger log = LoggerFactory.getLogger("MybatisSqlLog");

private Duration slownessThreshold = Duration.ofMillis(1000);

@Override
public Object intercept(Invocation invocation) throws Throwable {
  MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
  String mapperId = mappedStatement.getId();

  String originalSql = MybatisUtils.getSql(mappedStatement, invocation);

long start = SystemClock.now();
  Object result = invocation.proceed();
long duration = SystemClock.now() - start;
        // 当 SQL 执行超过我们设置的阈值,转为 WARN 级别 
if (Duration.ofMillis(duration).compareTo(slownessThreshold) < 0) {
   log.info("{} execute sql: {} ({} ms)", mapperId, originalSql, duration);
  } else {
   log.warn("{} execute sql took more than {} ms: {} ({} ms)", mapperId, slownessThreshold.toMillis(), originalSql, duration);
  }
return result;
 }

@Override
public Object plugin(Object target) {
if (target instanceof Executor) {
   return Plugin.wrap(target, this);
  }
return target;
 }

    // 设置慢 SQL 阈值,单位为秒
public void setSlownessThreshold(Duration slownessThreshold) {
this.slownessThreshold = slownessThreshold;
 }
}

笔者编写了一个工具类负责解析 MyBatis 执行语句,还原为可执行的 SQL 内容。

@UtilityClass
publicclass MybatisUtils {

    privatestaticfinal Pattern PARAMETER_PATTERN = Pattern.compile("\\?");

public String getSql(MappedStatement mappedStatement, Invocation invocation) {
  Object parameter = null;
if (invocation.getArgs().length > 1) {
   parameter = invocation.getArgs()[1];
  }
  BoundSql boundSql = mappedStatement.getBoundSql(parameter);
  Configuration configuration = mappedStatement.getConfiguration();
return resolveSql(configuration, boundSql);
 }

private static String resolveSql(Configuration configuration, BoundSql boundSql) {
  Object parameterObject = boundSql.getParameterObject();
  List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
  String sql = boundSql.getSql().replaceAll("[\\s]+", " ");
if (!parameterMappings.isEmpty() && parameterObject != null) {
   TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry();
   if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
    sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(resolveParameterValue(parameterObject)));

   } else {
    MetaObject metaObject = configuration.newMetaObject(parameterObject);
    Matcher matcher = PARAMETER_PATTERN.matcher(sql);
    StringBuffer sqlBuffer = new StringBuffer();
    for (ParameterMapping parameterMapping : parameterMappings) {
     String propertyName = parameterMapping.getProperty();
     Object obj = null;
     if (metaObject.hasGetter(propertyName)) {
      obj = metaObject.getValue(propertyName);
     } elseif (boundSql.hasAdditionalParameter(propertyName)) {
      obj = boundSql.getAdditionalParameter(propertyName);
     }
     if (matcher.find()) {
      matcher.appendReplacement(sqlBuffer, Matcher.quoteReplacement(resolveParameterValue(obj)));
     }
    }
    matcher.appendTail(sqlBuffer);
    sql = sqlBuffer.toString();
   }
  }
return sql;
 }

private static String resolveParameterValue(Object obj) {
if (obj instanceof CharSequence) {
   return"'" + obj + "'";
  }
if (obj instanceof Date) {
   DateFormat formatter = DateFormat.getDateTimeInstance(DateFormat.DEFAULT, DateFormat.DEFAULT, Locale.CHINA);
   return"'" + formatter.format(obj) + "'";
  }
return obj == null ? "" : String.valueOf(obj);
 }
}

将 MyBatis 拦截器设置为 Spring 自动装配。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
@ConditionalOnBean(SqlSessionFactory.class)
@ConditionalOnProperty(name = "mybatis.plugin.sql-log.enabled")
@EnableConfigurationProperties({MybatisPluginProperties.class})
@RequiredArgsConstructor
@Slf4j
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
@Configuration(proxyBeanMethods = false)
publicclass MybatisPluginAutoConfiguration {

privatefinal MybatisPluginProperties mybatisPluginProperties;

@Bean
public MybatisSqlLogInterceptor mybatisSqlLogInterceptor() {
  MybatisSqlLogInterceptor interceptor = new MybatisSqlLogInterceptor();
  interceptor.setSlownessThreshold(mybatisPluginProperties.getSqlLog().getSlownessThreshold());
return interceptor;
 }
}

@Data
@ConfigurationProperties(prefix = "mybatis.plugin")
publicclass MybatisPluginProperties {

privatefinal SqlLog sqlLog = new SqlLog();

@Data
publicstaticclass SqlLog {

privateboolean enabled = true;

private Duration slownessThreshold = Duration.ofMillis(1000);
 }
}

当项目配置了属性 mybatis.plugin.sql-log.enabled=true 时,SQL 拦截将生效,打印的内容如下:

2024-02-10 23:03:01.845 INFO  [dev] [XNIO-1 task-1] org.ylzl.eden.demo.infrastructure.user.database.UserMapper.selectById execute sql: SELECT id,login,email,activated,locked,lang_key,activation_key,reset_key,reset_date,created_by,created_date,last_modified_by,last_modified_date FROM demo_user WHERE id=1 (10 ms)

这种日志格式比较符合我们实际的生产要求:提供日志时间、可运行的 SQL、执行耗时。

产出

团队引入这个组件后,在定位生产 SQL 问题时,比原来清晰多了,并且,日志文件缩减了 30% 存储成本。

本文涉及的代码完全开源,感兴趣的伙伴可以查阅:

https://github.com/shiyindaxiaojie/eden-architect/tree/main/eden-components/eden-spring-boot-starters/eden-mybatis-spring-boot-starter


欢迎加入我的知识星球,全面提升技术能力。

👉 加入方式,“长按”或“扫描”下方二维码噢:

星球的内容包括:项目实战、面试招聘、源码解析、学习路线。

文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)
Mybatis拦截器打印完整SQL 之前写过一篇:Mybatis拦截器实现Geometry类型数据存储与查询 主要是关于Mybatis拦截器的使用。从赞的数量看????,可能知道Geometry数据类型的人不多,这种类型是MySQL中处理地理数据的数据类型,比如经纬度等。 今天再说一下,如何使用Mybatis拦截器打印完整SQL。 MybatisPlus自带一款SQL性能分析拦截器:com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor 而这个可以打印部分SQ 阅读详情

相关推荐

ftmp-stock:全面的开源股票分析平台

ftmp-stock股票分析系统是一套综合性的股票市场分析工具,旨在为股票投资者和分析师提供一个全面的平台,以便于深入理解股票市场动态和趋势。它由多个模块构成,包括数据获取、数据处理、统计分析、技术指标计算、算法交易策略回测、实时警报及社区共享、以及多平台支持与用户友好的界面设计。统计分析方法是理解数据背后含义的关键。通过对数据集进行系统化的分析,统计学可以帮助我们从噪声中找到信号,从而挖掘出有深度的洞见。在当今的金融市场中,算法交易已经成为主流的交易方式之一。

weixin_36238982的博客 1309

大数据应用实践1:基于开源架构的股票行情分析与预测

股票市场行情分析与预测一直是数据分析领域里面的重头戏,确切地说IT行业的每一次重大发展的幕后推动者以及新产品(特别是高端产品)的最先尝试者都包含金融行业,特别是证券交易市场,它符合大数据的四大特征:交易量大、频率高、数据种类多、价值高。 在本小节,我为大家介绍一种完全基于开源软件构建的大数据驱动的股票行情分析与预测系统的实现。 通常我们认为在一个充分共享信息的股票市场内,股票价格的短期走向是不可预测的,因此无论是技术分析(Technical Analysis)还是基本面分析(Fundamental An

Ultipa的博客 2299

基于vue3与spring boot+python实现股票预测系统源码.zip

介绍 采用vue3与spring boot搭建的前后端系统,采用python进行脚本编写,采用线性回归的最小二乘法与随机森林实现股票预测的效果;前端采用echarts绘制图表;算法采用的是sklearn库内置的模型 软件架构 MySQL数据库 Sprint boot Vue3、element-plus echarts python3.8 安装教程 安装需要搭建好Java的maven环境和vue的Vue@Cli环境 通过flask调用执行python脚本的系统,需要运行里面的app.py,打开flask应用提供服务,然后对于后端MySQL的密码和端口,需要设置为自己的;系统导入的股票数据会默认安装在D:/stock/data目录,可以通过application.properties配置文件设置 安装具体细节可在安装说明目录进行查阅

[开源] 零成本基于 AI 的股票分析系统

起初只是自己做一个帮忙分析自选股和大盘的工具,减少盯盘、盯股票分析的精力,后面本着开源精神开源出来,能够每天定时推送到企业微信上。用的都是免费的方案,github action + Gemini 的 API + Serpapi 和 TAVILY 的检索功能,免费额度足够日常使用。│ ├─ 量比: 0.8 (缩量回调) ✓ │。│ ├─ 理想买点: 25.50 元 (MA5附近) │。│ 一句话结论: 缩量回踩MA5,最佳狙击点出现 │。

Mumu's Blogs 1262

2.13寸电子墨水屏HINK-E0213+esp8266

很久以前买的一块电子墨水屏,运气很好,这个型号HINK-E0213资料很全,而且微雪官网也有相关电路资料等。

梦境虽美,却不长. 3005

飞凌OK3588-C Linux R4系统下MIPI YUV摄像头CSI尺寸错误排查与极性适配方案

本文详细介绍了在飞凌OK3588-C平台的Linux R4系统下调试MIPI YUV摄像头时遇到的'csi size err'错误排查与极性适配方案。通过分析信号极性、驱动参数调整及FPGA协同调试,提供了从硬件检测到系统级调试的完整解决方案,帮助开发者快速解决类似问题。

bean的博客 261

中国最难入职的IT公司

【国内首批】支持 JDK17/21+SpringBoot3、JDK8/11+Spring Boot2双版本。国产Star破10w的开源项目,前端包括管理后台、微信小程序,后端支持单体、微服务架构。一对一交流/面试小册/简历优化/求职解惑,欢迎加入。:项目实战、面试招聘、源码解析、学习路线。RBAC权限、数据权限、SaaS多租户、7、网易,团队协作能力考验大。9、哔哩哔哩,二次元文化要懂。、支付、工作流、大屏报表、2、字节跳动,算法题难上天。6、京东,项目经验要求高。3、快手,面试流程超长。

芋艿V 41

Eplan2022 复制已有的宏文件生成新的原理图宏文件

Eplan2022 新建原理图宏文件

haier123888的博客 1万+

股票分析系统安装与使用教程

股票分析系统安装与使用教程 项目介绍 股票分析系统是由SleepySoft团队开发的一款开源工具,旨在提供一个综合性的框架,用于深入分析股票市场数据。该系统融合了复杂的算法与直观的界面,帮助投资者从海量股市数据中提取有价值的信息。它支持自定义指标分析、实时数据处理、历史行情回测等功能,是个人投资者及金融分析师的强大辅助工具。 项目快速启动 环境准备 确保你的开发环境已具备以下条件: Pytho...

gitblog_00677的博客 969

Windows下玩转Spark:零基础本地集群搭建与实战演示

本文详细介绍了在Windows系统下零基础搭建Spark本地集群的完整流程,包括环境准备、集群启动、实战案例演示及性能优化技巧。通过Standalone模式快速部署,结合WordCount等经典案例帮助初学者快速掌握Spark数据处理,特别适合Windows环境下的大数据开发入门学习。

weixin_33734785的博客 425

国科大学习资料--人工智能原理与算法-第六次作业解析(学长整理)

国科大学习资料–人工智能原理与算法-第六次作业解析(张文生老师主讲)(6.6、6.7、6.11) 6.6 说明如何通过使用辅助变量把诸如A+B=C这样的三元约束转变成三个二元约束。假设值域是有限的。(提示:考虑引进新变量表示变量对的值,引进约束如“X是Y变量对中的第一个元素”。)然后说明如何把多于三个变量的约束类似地转换为二元约束。说明如何通过改变变量的值域来消除一元约束。这就完整演示了任何CSP都可以转变为只含二元约束的CSP。 答:首先,我们引入一个新变量AB,假设A和B的范围均为N,AB的范围为N×N

无名何许人的博客 2873

来吧,自定义MyBatis拦截器,SQL日志存储成本直降30%

本文介绍了优化MyBatisPlus SQL日志输出的方案。针对默认日志格式存在的不足(缺少时间、可读性差、存储成本高),作者通过自定义MyBatis拦截器实现SQL语句美化打印。该方案包含:1)拦截SQL执行并记录耗时;2)通过工具类还原可执行SQL;3)支持慢SQL阈值告警;4)提供Spring自动配置。实施后日志格式包含执行时间、完整SQL和耗时,使问题定位更清晰,同时减少30%日志存储成本。该组件已开源,适用于需要优化SQL日志的生产环境。

【可全包】本人程序员,不需要做任何吹嘘,只是实在写点程序,写点文档,熟悉各类主流框架,SSM,SpringBoot,Flask,Djiango,Mysql,Sqlite,VUE,Uniapp等,各类程序设计专家,优质作者 104

R语言中的summarise函数和mutate函数用于计算分组占比。下面是关于这两个函数的详细介绍以及相应的源代码示例:

R语言中的summarise函数和mutate函数用于计算分组占比。

CodeByte的博客 1183

Mybatis拦截器实现操作日志记录

• 核 心 作 用 : – 保 证 一 个 类 只 有 一 个 实 例 , 并 且 提 供 一 个 访 问 该 实 例 的 全 局 访 问 点 。

人生就像一场戏 6431

使用AutoDL云服务器训练YOLO计算机视觉网络模型(AutoDL+Xftp+VS Code),附详细操作步骤

AutoDL AI算力云是一个提供人工智能算力服务的云平台。丰富的GPU资源:提供多种GPU型号,包括NVIDIA的A100A800L40V100RTX 4090RTX 3090等,能满足我们在不同场景下的需求,无论是进行大规模的AI训练还是复杂的科学计算等任务,都可以找到合适的GPU资源。灵活的付费方式:支持按量付费包日包周包月等多种付费模式。对于短期的实验或不确定时长的项目,可以选择按量付费;如果有长期稳定的算力需求,预付费或包周包月则可能更划算,可以根据自己的需求和预算进行选择。集成主流框架:集成了。

Limiiiing的博客 964

013:无人机航线规划的概念

航线规划是无人机任务规划的核心环节,它决定了无人机在整个任务执行过程中的飞行路径。航线规划需要考虑多种因素,包括飞行时间、飞行距离、能源消耗、飞行安全等。

qq_31762031的博客 2445

一招搞定!自定义MyBatis拦截器,这才是我想看的SQL日志!

我们使用 MyBatis Plus 通常通过配置文件中设置 log-impl 属性来指定日志实现,以打印 SQL 语句。团队引入这个组件后,在定位生产 SQL 问题时,比原来清晰多了,并且,日志文件缩减了 30% 存储成本。笔者编写了一个工具类负责解析 MyBatis 执行语句,还原为可执行的 SQL 内容。这种日志格式比较符合我们实际的生产要求:提供日志时间、可运行的 SQL、执行耗时。日志存储成本高:SQL 模板占用较多字符,增加了日志存储成本。时,SQL 拦截将生效,打印的内容如下。

IT_1024的博客 49

pscad IEEE标准系统搭建说明

pscad IEEE标准系统搭建说明,包含典型的IEEE 9节点、14节点、30节点、39节点和118节点系统。内含标准测试系统的原始数据和潮流结果。

mybatis自定义拦截器

知识铺垫 一、拦截器接口: 1、方法: (1)plugin():让mybatis判断,是否要进行拦截,然后决定是否返回拦截对象还是原对象 (2)intercept(Invocation invocation):处理拦截到的对象 2、多个插件plugin()和intercept()方法的执行顺序: 执行完毕所有的plugin方法,再执行每个Intercept方法 二、拦截器注解: 1、注解的...

yaybvb的博客 1670

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

ET2012新版免狗免安装绿色软件

ET2012新版免狗免安祖昂绿色软件。,新界面,新视觉,

写一个MyBatis的plugins,记录完整SQL日志

当用户定义了一个Mapper接口中的方法或者XML映射文件中的SQL语句时,MyBatis会根据这些定义生成相应的MappedStatement对象,并将其存储在Configuration对象的内部映射表中。当遇到长SQL和参数较多时,还原一个SQL往往需要十几分钟的时间。最近接到的项目有很多长SQL并且参数的数量也很多,在做SQL优化时需要花很多时间在SQL拼接上,想到前同事使用MyBatis框架插件机制来打印完整的SQL日志,尝试自己实现一下,同时也是为了加强对MyBatis框架的了解。

王文强 908

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

在Spring boot 中执行 sql 利用 Mybatis 拦截器 获取执行sql语句

解决方案:在开发中 添加 更新 删除的 基础数据 执行的 sql 语句 存到开发数据库 需要同步 到线上时。需求: 有的时候 需要动态 拼接 sql 比如 数据权限 根据权限不同 拼接不同的 where 条件。需求: 开发 生成 数据库 同步基础数据 但是又不能直接覆盖表 这时候同步起来 很玛法。最后再执行 sql 的时候 数据库表里 就会记录 执行的 sql 语句。下面的代码 主要是 拦截 执行的 sql 语句 存储到 数据库。直接执行 存在 开发数据的 sql 语句 即可。

Json的知识梦工厂 4936

MyBatis拦截器

JBDC的底层主要是三个接口对象,Connection、Statement、ResultSet。Connection用于建立与数据库的连接,Statement用于向数据库发送sql语句,ResultSet用于封装sql查询语句的结果。

zhzjn的博客 1178
上一篇: 为什么面试问的越详细反而没有后文了?
下一篇: 叫你别乱封装,你看出事了吧!
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值