一款 IDEA Mybatis插件:极大提升 CRUD 效率,堪称神器!

IDEA插件之mybatisx 插件使用教程 MybatisX 是一款基于 IDEA 的快速开发插件,方便在使用mybatis以及mybatis-plus开发时简化繁琐的重复操作,提高开发速率。使用MybatisX能够快速生产mybatis的相关文件,免去手动建立的繁琐过程。 阅读详情

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

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

792a1390d4fac95babad3bc88bb6ee1b.gif

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

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

功能涵盖 RBAC 权限、SaaS 多租户、数据权限、商城、支付、工作流、大屏报表、微信公众号、CRM 等等功能:

  • Boot 仓库:https://gitee.com/zhijiantianya/ruoyi-vue-pro

  • Cloud 仓库:https://gitee.com/zhijiantianya/yudao-cloud

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

【国内首批】支持 JDK 21 + SpringBoot 3.2.2、JDK 8 + Spring Boot 2.7.18 双版本 

来源:juejin.cn/post/
7246365103783673911


mybatis-sql-viewer插件主要提供能力:将mybatis xml转成真实SQL语句、参数mock、SQL规范检查、SQL索引检查、SQL运行、SQL压测及Mybatis SQL语句扫描。

1 简介

虽然写了很久的CRUD,但是依旧觉得写好CRUD是一件非常难且麻烦的事情,以下的情况在开发过程中应该都遇到过:

SQL的编写需要细心,写错了SQL字段或者表名称,修改完要重启(几分钟过去了)

SQL编写好后进行测试时,造数据也好麻烦,特别是还存在表关联的情况,数据内容不真实,还容易超出字段长度,让人抓狂

SQL好不容易能跑了,又会有以下的疑问

  • 符不符合SQL开发规范?

  • 是否能命中索引?又可能命中哪个索引?

  • 日常环境数据太少,如何模拟SQL在生产环境下运行的真实情况?

  • 性能怎么样,最大TPS可以达到多少?数量大时是否会存在慢SQL?

  • TP99/TP90、最大RT/平均RT、平均TPS是多少呢?

对于使用Mybatis的开发者还会存在这些问题:

  • Mapper接口方法和XML标签不对应,修改完要重启(又几分钟过去了)

  • XML中多写了一个逗号或者分号,又没有错误提示,接口测试调用时才发现,修改完又又要重启(好多个几分钟过去了)

  • 这个Mapper接口对应的是哪个XML文件?找找十几秒过去了

  • 这个XMl文件对应的是哪个Mapper接口?找找十几秒又过去了

  • 这个项目中有多少个XML文件?有多少SQL语句?里面是否存在慢SQL?是否都符合开发规范?

158aee19bb2043f633a509761032f147.jpeg

按照这种开发模式,需要重启好多次应用,对于每次启动都需要几分钟的应用来说开发体验简直就是灾难。

基于上述的问题,开发了mybatis-sql-viewer插件,基于此插件可以实现以下能力而不需要启动应用:

49143e0c3498930e90b8fb1741d923b6.jpeg

基于此插件以上的问题在编码阶段即可解决:

SQL的编写好麻烦,写错了SQL字段或者表名称,修改完需要重启 --> 语法校验

SQL编写好后进行测试时,造数据麻烦,特别是存在表关联的情况,数据内容不真实,容易超出字段长度报错 --> 多种数据mock方式,自动关联

SQL好不容易跑起来了,又会有以下的疑问:

  • 符不符合SQL开发规范?--> SQL规范检查

  • 是否能命中索引,可能命中哪个索引?--> SQL索引检查&SQL执行计划

  • 日常环境数据量太少,如何模拟SQL在生产环境下运行的真实情况?--> 支持大批量数据mock

  • 性能怎么样,最大TPS可以达到多少?数量大时是否会存在慢SQL?--> SQL语句压测,结果一目了然

基于此插件可以提高CRUD的效率及SQL质量,开发流程可以转换为如下模式:

1f3254d2dfca36f0deccb406bd0068d0.jpeg

上述的规约均来自《阿里巴巴Java开发手册》中的MySQL数据库章节。

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

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

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

2 安装

IDEA中安装:

Preferences(Settings) > Plugins > Marketplace > Search"mybatis sql viewer" > Install

手动安装:

在releases页面中下载最新版本的zip文件

Preferences(Settings) > Plugins > ⚙️ > Install plugin from disk... -> 选择下载的文件安装

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

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

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

3 使用

因为需要拉取数据库表的元数据信息、执行SQL,所以使用前需要配置一下数据源。

支持多数据源配置,点击「datasource」按钮即可完成数据源的创建、选择、删除、测试。

52c5cd374653663ea121c67f0d0221f6.png

1. 模式

此插件有两种模式:mybatis模式和非mybatis模式。差别在于mybatis模式支持以下功能:

  • mapper接口方法参数mock

  • 随机参数

  • 默认参数

  • 自定义参数

  • mapper接口/方法跳转XML文件

  • XML文件跳转mapper接口/方法

  • 基于mock参数将mapper接口方法的xml转换成真实SQL

  • 按照文件/项目维度扫描XML文件,并生成对应的真实SQL语句,并进行规约/索引相关校验

1. 非mybatis模式

将mybatis mode的勾选框关闭即可使用非mybatis模式,然后在「statement」Tab左栏手写SQL即可。

b7df64fd8e1c507d0fc6f7c255c07fea.png
2. mybatis模式

将mybatis mode的勾选框选中即可使用mybatis模式,mybatis模式主要添加了mapper接口方法参数mock、文件跳转及mybatis文件扫描的功能。

在mapper接口或XML文件中点击「sql」图标,即可生成mapper方法参数随机值,如果对生成的随机不满意或不满足条件,可以手动修改进行自定义。

然后点击「statement」Tab即可使用该参数将mybatis的xml实现转换成真实的SQL语句。

905fc588c9c96a2fa3ad5afa846df934.png

2. mybatis sql扫描

支持文件和项目两个维度扫描。

  • 文件维度扫描

点击或者namespace对应的mapper接口旁边的「sql」图标即可完成文件维度mybatis sql的扫描

cedde584f03381009310d2c4300de9a4.png
  • 项目维度

点击「mybatis sql scan」即可进行项目维度mybatis sql的扫描

6dea5836edd44c68987c7b7fd7cbb138.png

扫描结果左侧是mybatis文件的namespace(对于mapper接口名)及其下的方法名,点击具体的方法,右侧产生其对应的SQL语句,并会对该SQL语句进行规约检查、索引检查并输出此SQL语句的的执行计划

  • 图标说明

dc583b5c0b5ab4cec0124f9aa1e212fd.png

项目维度扫描

  • all:所有语句

  • compliance with spec:符合SQL规约要求的SQL语句

  • does not meet spec:不符合SQL规约的要求的SQL语句

  • full table scan:存在全表扫描的SQL语句

  • error:存在错误的SQL语句,可能是SQL编写错误,参数错误,数据库连接错误等

3. SQL语句

1. 语法校验&规约检查

对于「非mybatis模式」需要左栏编写SQL语句,「mybatis」模式则需要在mapper接口或XML文件中点击「sql」图标生成SQL,右栏自动进行语法校验和规规约校验

1. SQL语法校验

d61146137c034b9caf54d6934196a62b.png

2. 规约校验

1377ba408d3ffa3843bd2f5734ceb481.png
2. SQL执行

点击「result」tab后会自动执行「statement」Tab中的SQL语句。执行结果由3部分组成:执行信息、执行计划及执行结果。

  • 执行信息包含: 执行的语句、执行该条语句的耗时、返回的记录数及表中记录总数

  • 执行计划: EXPLAIN对应的结果

  • 执行结果: 结果表格,默认只返回100条记录(只有SELECT语句有该信息)

1becaa32a1657c08746a3ecb4152c63e.png
3. SQL压测

点击「stress」Tab进行压测配置,配置页面如下:

07cd926901388147a7671aeecb634254.png

配置说明

  • 值类型由两种方式组成:

    • use sql directly :表示直接使用「statement」Tab中的SQL语句进行压测

    • configure parameters :表示对「statement」Tab中的SQL语句的条件进行参数配置。

  • 流量模型也是由两种方式组成(与并发数有关):

    • increase in a constant rate :并发数按照固定速率增长,增长速率由「递增时长」指定

    • fixed concurrent number :直接按照指定并发数进行压测

  • 递增时长 :指定并发数的增长速率,单位为秒

  • 并发数 :同时执行SQL语句的线程数

  • 压测时长 :指定压测时间,单位为分钟,因为压测的指标数据直接存在内存中,应该避免压测时间过长造成Idea OOM

配置完成后,点击「stress」按钮即可进行压测,并自动跳转到压测报告「report」Tab

压测报告

压测报告中主要包含指标:

  • 请求成功率

  • TP99

  • TP90

  • 最大RT

  • 平均RT

  • 最大TPS

  • 平均TPS

  • 并发数

  • 异常数

  • 总请求数

图表包含:

  • 请求成功率

  • 平均RT

  • TPS

0f9b9eddb151e8eab6de9a031937bed8.png
4. SQL表

点击「table」Tab时会对「statement」Tab中的SQL语句进行解析,提取出表名称,然后每个表作为一个Tab。如以下语句:

SELECT
    state
FROM
    CITY
WHERE
    country_name IN (
        SELECT
            name
        FROM
            COUNTRY
        WHERE
            id IN (1, 2, 3)
    )

SQL语句中包含了两个表:CITY和COUNTRY,所以会产生两个Tab,如下图所示:

b94e7b85077dfbff6572e41b1cc9b04c.png

1. 字段

  • 左栏显示表的字段信息:字段名称、类型、是否可为NULL、默认值、索引、注释说明等信息

  • 右栏显示对表进行建表规约检查的结果:如表名、字段名是否包含大写字母或特殊字符等检查

f9b4571914848de39b16a54245e2addc.png

2. 索引

  • 左栏显示表的索引信息

  • 右栏显示对索引进行规约检查的结果

fc892c9cafbba7ffca2d7ec3ee6f3a28.png

3. 数据mock

mock表数据,支持批量数据mock,左栏进行mock数据类型配置,右栏显示mock结果

  • mock规则

左栏表单中「Mock Type」和「Mock Value」进行mock配置。初始化时,已经按照字段类型设置了默认的配置,可以按照需求进行修改。支持多种mock数据规则:

  • random:随机值

    • string

    • name:姓名

    • datetime:形如:2023-01-01 00:00:00

    • integer

    • decimal

    • date:形如2023-01-01

    • timestamp

    • time:形如18:00:00

    • year:形如2023

    • city

    • url

    • email

    • ip

    • university

    • phone

  • lexicon:自定义词库

  • database:数据库,需要填写table.field

  • increment:递增

  • fixed:固定值

  • regex:正则

  • none:不进行mock,生成insert语句时不包含此字段

  • 词库创建

点击「lexicon」按钮,即可进行词库的创建

7c69affa7a4e8ff49664a52bf191bc66.png
  • mock数据预览

配置好mock配置后,可以点击「preview」按钮进行mock数据的预览,默认会生成50条数据

ece6e8f456bfed3bb8cd338887162e80.png
  • mock数据

预览数据符合要求后,点击「mock」按钮完成数据的插入,默认插入100条数据,通过修改「Mock Rows」的值指定mock记录数,经测试,插入10w条数据花费时间在10秒内,所以可以进行大批量数据mock。

6b5fae7500c2226d85cc1d07584fee99.png
  • mock数据清理

mock数据完成后,会存储主键id的范围(持久化存储到本地文件),在对SQL语句进行压测完成后,可以进行清理,避免污染日常真实的测试数据。点击「Clean」按钮即可完成清理工作

183a81d28e373453907833d6a2c12962.png

4 配置

相关配置:Preferences(Settings) > Tools > Mybatis Sql Viewer

d6a13e81115a3afb917b8c125f866ce8.png

5 参考

在实现过程中参考了许多非常优秀的项目,拷贝了很多代码,特此感谢。

  • JDBC压测_性能测试 PTS-阿里云帮助中心

  • SQL Father - 模拟数据生成器(后端)

  • GitHub - q258523454/Java-Mybatis-SQL-Scanner: Java Mybatis SQL Scanner

  • 程序员顺仔:动手撸一个SQL规范检查工具

  • pojo2json

  • mybatis-3

mybatis-sql-viewer开源地址:

https://github.com/linyimin0812/mybatis-sql-viewer


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

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

c3e5736e3acd9cd9825b9831cb4369fa.png

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

ae0bb48fcd384214f9ced8489bed190d.png

19f70f0b6b1e146caec75516a3c9e982.pngf58771f8a706e45018d5e9a13e3dee8d.pnga58c28ed3ccffe5707597ae75a1f294c.pngdcd22996af8bce5ee419de3f28825f59.png

文章有帮助的话,在看,转发吧。
谢谢支持哟 (*^__^*)
Idea Mybatis插件:提高CRUD效率 将mybatis xml转成真实SQL语句、参数mock、SQL规范检查、SQL索引检查、SQL运行、SQL压测及Mybatis SQL语句扫描 阅读详情

相关推荐

MyBatis中的插件机制详解

插件是一种常见的扩展方式,大多数开源框架也都支持用户通过添加自定义插件的方式来扩展或者改变原有的功能,MyBatis中也提供的有插件,虽然叫插件,但是实际上是通过拦截器(Interceptor)实现的,在MyBatis的插件模块中涉及到责任链模式和JDK动态代理,这两种设计模式的技术知识也是大家要提前掌握的

10年老JAVA大数据技术人的专栏 1426

mybatis入门

1、搭建mybatis框架环境 搭建maven项目如图 pom.xml 导入依赖 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ...

weixin_44222931的博客 761

帝国CMS v7.5存储型XSS漏洞挖掘与修复实战

存储型XSS(跨站脚本攻击)是一种常见的Web安全漏洞,其核心原理是攻击者将恶意脚本代码提交并永久存储在服务器端(如数据库),当其他用户访问包含该数据的页面时,脚本会在其浏览器中执行。这种漏洞的危害在于其持久性和广泛的影响范围,可能导致用户Cookie被窃取、会话被劫持,甚至引发蠕虫式传播。从技术价值看,理解存储型XSS有助于掌握Web应用安全的核心逻辑,即数据在输入、处理和输出全链路中的安全风险。在内容管理系统(CMS)等Web应用场景中,用户可控的输入点(如个人资料、评论、公告)若未经妥善过滤和输出编码

weixin_29327525的博客 300

自己动手写一款 IDEA Mybatis 插件:大大提高 CRUD 效率

????这是一个或许对你有用的社群????一对一交流/面试小册/简历优化/求职解惑,欢迎加入「芋道快速开发平台」知识星球。下面是星球提供的部分资料:《项目实战(视频)》:从书中学,往事中“练”《互联网高频面试题》:面朝简历学习,春暖花开《架构 x 系统设计》:摧枯拉朽,掌控面试高频场景题《精进 Java 学习指南》:系统学习,互联网主流技术栈《必读 Java 源码专栏》:知其然,知其所以然????这是一个或许...

weixin_44421461的博客 602

DeepSeek-OCR又更新:一起看下OCR1和OCR2

DeepSeek-AI 最近又又开源了,这次是DeepSeek-OCR2,结合之前发布的DeepSeek-OCR ,可以发现DeepSeek走出了一条不同于主流 OCR 方案的技术路线。第一代模型探索了**“视觉作为文本压缩介质”的可行性,打破了传统的序列长度限制;第二代模型则通过“Visual Causal Flow(视觉因果流)”**架构,将因果推理引入视觉编码器,解决了复杂排版下的阅读顺序难题。本文将从架构设计、逻辑结构、训练范式及工程实现四个维度,深度剖析这两代模型的异同与创新。

kakaZhui的博客 629

数学建模 种群竞争模型 学习笔记

模型背景 应用场景 种群竞争模型 例如 s1=0.5,则表示对于供养甲的资源来讲,单位数量的乙的消耗为单位数量的甲的0.5倍,即表示乙对于该资源的占有能力是甲的0.5倍(即竞争力弱) 仿真结果及分析 (1)设置自然增长率 r1=r2=1 (2)改变自然增长率 r1=r2=0.3 (3)修改甲和乙的最大容量 n1=10000, n2=100 (4)修改甲和乙的初始数量 x1=10, x...

Test_tju的博客 2030

一款IDEA MyBatis插件:极大提升CRUD效率,堪称神器!

作者:linyimin来源:juejin.cn/post/7246365103783673911mybatis-sql-viewer插件主要提供能力:将mybatis xml转成真实SQL语句、参数mock、SQL规范检查、SQL索引检查、SQL运行、SQL压测及Mybatis SQL语句扫描。简介虽然写了很久的CRUD,但是依旧觉得写好CRUD是一件非常难且麻烦的事情,以下的情况在开发过程中应该...

码农code之路 550

PaddleOCRv5训练自己的模型-微调文字识别模型

本文介绍了使用PaddleOCR微调文字识别模型的具体步骤。首先需要按照官方格式准备数据集,包括图片和标注文件。然后进行模型训练,包括环境安装、预训练模型下载、配置文件修改等关键环节,特别针对训练中可能出现的类别数不匹配问题提供了三种解决方案。文章还详细说明了模型导出为静态图格式的方法,以及如何调用训练好的模型进行推理。整个过程涉及多个技术细节,如早停机制设置、断点续训方法等,为需要提升OCR识别精度的开发者提供了实用指导。

weixin_43827982的博客 3180

一款 IDEA Mybatis 插件:极大提升 CRUD 效率,堪称神器!

Java精选面试题(微信小程序):5000+道面试题和选择题,真实面经,简历模版,包含Java基础、并发、JVM、线程、MQ系列、Redis、Spring系列、Elasticsearch、Docker、K8s、Flink、Spark、架构设计、大厂真题等,在线随时刷题!mybatis-sql-viewer插件主要提供能力:将mybatis xml转成真实SQL语句、参数mock、SQL规范检查、S...

Java精选 327

【Java完整版 面试必备】Leetcode Top100题目和答案-滑动窗口篇

【Java完整版 面试必备】Leetcode Top100题目和答案-滑动窗口篇

weixin_43298211的博客 2248

ros2的unity仿真配置(ros2-for-unity)

可以看到unity中输出了Hello World,验证完毕!可以看到unity上监听的/chatter。

m0_63671696的博客 4096

告别996!一款 IDEA Mybatis插件:极大提升 CRUD 效率,堪称神器!

扫描结果左侧是mybatis文件的namespace(对于mapper接口名)及其下的方法名,点击具体的方法,右侧产生其对应的SQL语句,并会对该SQL语句进行规约检查、索引检查并输出此SQL语句的的执行计划。预览数据符合要求后,点击「mock」按钮完成数据的插入,默认插入100条数据,通过修改「Mock Rows」的值指定mock记录数,经测试,插入10w条数据花费时间在10秒内,所以可以进行大批量数据mock。点击「result」tab后会自动执行「statement」Tab中的SQL语句。

程序员闪充宝 152

微信小程序|基于小程序实现定位打卡功能

此文主要在小程序内实现打卡功能,可根据用户位置与公司设定的打卡范围实时判断打卡是否合法,并在后台对打卡记录进行管理。

商务合作 / 项目定制 / 学习交流。个人vx:lovely_wml 1万+

一款 IDEA Mybatis插件:极大提升 CRUD 效率,堪称神器

因公众号更改推送规则,请点“在看”并加“星标”第一时间获取精彩技术分享点击关注#互联网架构师公众号,领取架构师全套资料 都在这里0、2T架构师学习资料干货分上一篇:2T架构师学习资料干货分享大家好,我是互联网架构师!mybatis-sql-viewer插件主要提供能力:❝将mybatis xml转成真实SQL语句、参数mock、SQL规范检查、SQL索引检查、SQL运行、SQL压测及Mybatis...

emprere的博客 232

OpenClaw人人养虾:接入即时通讯平台Zalo

通过 Zalo Official Account(OA,官方账号)API,可以将 OpenClaw 接入 Zalo,实现面向越南用户的自动化客服和互动。

王国平的博客 438

复分析 阿尔福斯(Ahlfors) 第三版答案 英文

答案分为十章,有部分习题没有答案,全英文复分析阿尔福斯(Ahlfors) 第三版答案

上一篇: 缓存七坑,你踩过吗?
下一篇: Spring 定时任务与 XXL-JOB 灵活切换方案
公众号-芋道源码
博客等级 码龄10年 1639粉丝 377原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值