Imported from BaixuanZhu/skills (
eval/mybatis-plus-dev/darwin-validation-v2.4.0/snapshots/version1/SKILL.md). Install upstream withnpx skills add BaixuanZhu/skills --skill version1. Copyright stays with the author.
MyBatis-Plus 开发助手
面向日常 Java 开发的 MyBatis-Plus 编码助手。推荐 3.5.17(3.5.x 最新线,2026),3.5.x 全线适用,3.4.x 大部分兼容(差异处已注明)。
采用完全本地自包含策略:所有知识沉淀于本地 references/,运行时不依赖任何外部文档站点。
版本与依赖(先判 SpringBoot 版本)
| SpringBoot | starter 坐标 |
|---|---|
| 2.x | mybatis-plus-boot-starter |
| 3.x | mybatis-plus-spring-boot3-starter |
| 4.x (^3.5.13) | mybatis-plus-spring-boot4-starter |
- 切勿同时引入
mybatis/mybatis-spring-boot-starter/mybatis-spring,会与 MP 版本冲突。 - 分页必引
mybatis-plus-jsqlparser(自 v3.5.9 起PaginationInnerInterceptor已从核心拆分,单独成依赖;否则分页静默失效)。JDK8 项目用mybatis-plus-jsqlparser-4.9。
第 0 步:依赖探测与激活分支(收到数据库访问类任务先做这一步)
任务涉及增删改查、分页、条件查询、Mapper/DAO/Service 层、实体映射、事务等编码——即使用户没提 MyBatis-Plus——先检索项目依赖(在 pom.xml / build.gradle 中搜 mybatis-plus、mybatis、spring-boot-starter-data-jpa、hibernate):
| 探测结果 | 动作 |
|---|---|
依赖含 mybatis-plus-* |
直接激活本技能,走下方流程 |
| 纯 MyBatis 原生(无 MP) | 按「部分适用」规则(仅 10-xml.md + 11-transaction.md),同时询问用户是否引入 MyBatis-Plus(单表 CRUD 免写 SQL,与现有 XML 共存) |
| 无任何 ORM | 主动询问用户是否引入 MyBatis-Plus;同意 → 按「版本与依赖」表 + references/01-start.md 引入后继续;拒绝 → 退出本技能,不再打扰 |
| 已使用 JPA / Hibernate | 告知不适用并退出,不建议迁移 |
何时使用本技能
| 信号 | 判定 |
|---|---|
| Java/SpringBoot 项目中的 CRUD/分页/条件查询/Mapper 层/实体映射/事务任务(未指明框架) | 激活,先执行「第 0 步」依赖探测 |
依赖含 mybatis-plus-* / 代码 extends BaseMapper / extends ServiceImpl / 使用 Wrapper / IService / saveBatch / selectPage |
激活 |
提到 @TableLogic / @TableField / @EnumValue / @Version / @TableId / "MyBatis-Plus" / "MP" / "baomidou" |
激活 |
| 纯 MyBatis 原生(无 MP),仅问 XML / 事务 | 部分适用(仅 references/10-xml.md + 11-transaction.md) |
| JPA / Hibernate(不建议迁移)/ 表结构设计 / DDL / 纯 SQL 调优 | 不适用 |
检查点:判定为「不适用」→ 告知用户当前问题不在 MyBatis-Plus 范围,建议退出本技能。判定为「部分适用」→ 告知仅
10-xml.md+11-transaction.md可参考,其余不适用,让用户确认是否继续。
主动行为触发(见到这些代码模式时主动提醒)
selectPage/page→ 确认引了mybatis-plus-jsqlparser+ 注册PaginationInnerInterceptor(否则分页静默失效)@Transactional无rollbackFor→ 显式指定rollbackFor = Exception.classsaveBatch当高性能批量 → 默认非 BATCH executor,量大需配BatchExecutor(见04-crud.md)- 其余触发(null 不更新 /
apply注入 / Wrapper 复用 / XML 枚举 typeHandler / join 改写 XML / 字符串字段名 / SQL 函数硬堆 Wrapper)→ 见上方「核心强约束」#3/#4/#7/#8/#9/#11 与下方「使用流程」自检清单
核心强约束(Agent 必须遵守)
-
继承范式:
XxxMapper extends BaseMapper<T>;Service 接口extends IService<T>;实现类extends ServiceImpl<XxxMapper, T>。 -
优先用父类方法:单表 CRUD 直接用
BaseMapper/IService提供的方法(selectList/selectById/save/updateById/page…),不要手撸冗余 CRUD 或重复 XML。 -
Wrapper 能力边界——超界转 XML:Wrapper 适合单表 + 标准比较/排序/聚合条件(eq/like/in/between/orderBy…)。以下场景必须改写 XML,不要用 Wrapper 硬堆:
- 联表(JOIN,含子查询关联)
- 窗口函数(
ROW_NUMBER()/RANK()/SUM() OVER(...)等) - 聚合函数 + GROUP BY/HAVING(
SUM(cnt)/COUNT(DISTINCT …)) - 数据库专有函数 / 复杂表达式(
DATE_FORMAT()/JSON_EXTRACT()/CASE WHEN,跨库不可移植) - 自定义列别名 / 投影计算列(
amount*2 AS double_amount)
用
apply()/last()拼函数片段是反模式(注入风险 + 跨库不可移植 + 语义不可读),见references/05-wrapper.md§1、references/10-xml.md。 -
null 不更新:
updateById(entity)中 entity 的null字段默认不参与更新(根因:全局updateStrategy默认NOT_NULL,见references/02-config.md§7);要显式置空用UpdateWrapper.set(...)或字段级@TableField(updateStrategy = FieldStrategy.ALWAYS)。 -
逻辑删除:推荐 0+毫秒时间戳方案(
Long字段,logic-not-delete-value: 0,logic-delete-value: "UNIX_TIMESTAMP(now())*1000");用全局logic-delete-field或字段@TableLogic;启用后查询自动过滤已删除行。 -
分页插件最后添加 + 显式 DbType:
MybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL))必须放在插件链最后;非 MySQL(PG/Oracle/SQLServer/达梦/金仓)必须显式指定DbType,否则分页方言可能生成错误(total 错或语法错)。跨库差异(主键策略/引用符/批量语法)见references/12-dbtype.md。 -
SQL 注入防护:
Wrapper.apply用{0}占位符(PreparedStatement 参数化)+ 前置SqlInjectionUtils.check(...)校验,禁止字符串拼接 SQL 片段。check返回 boolean 并抛异常,不返回安全值。 -
Wrapper 不可复用:同一
Wrapper实例多次使用会叠加条件;每次查询new一个新的。 -
枚举映射:枚举值字段标
@EnumValue(或实现IEnum),JSON 序列化标@JsonValue;XML 自定义查询中枚举字段的每个位置(resultMap、条件#{}、插入#{})都要声明typeHandler=MybatisEnumTypeHandler。 -
高级插件顺序(多租户/数据权限/动态表名 → 分页最后):
TenantLineInnerInterceptor/DataPermissionInterceptor/DynamicTableNameInnerInterceptor必须在PaginationInnerInterceptor之前添加;否则 COUNT 语句不会被改写,分页总数不准或数据权限漏过滤(见references/07-plugin.md§5)。 -
字段引用必须用方法引用(Lambda):构造条件/更新默认用
LambdaQueryWrapper/LambdaUpdateWrapper+ 方法引用(User::getName),禁止字符串字段名(eq("name", ...))。例外:动态列名 / 动态表名 / 方言函数等运行时才知道的列——用QueryWrapper/UpdateWrapper字符串形式 + 注释说明,且拼接外部输入走 §7{0}占位防注入。方法引用编译期检查,字段改名编译报错;字符串字面量无校验,重构改名静默产出错误 SQL(Unknown column)或查错数据(见references/05-wrapper.md§1)。
决策路由(全部本地,无在线 fetch)
| 需求场景 | 读取文件 | 关键提醒 |
|---|---|---|
| 依赖、starter 选择、最小配置、基础 CRUD 跑通 | references/01-start.md |
SB3 用 spring-boot3-starter;分页必引 mybatis-plus-jsqlparser(v3.5.9+,否则静默失效) |
| 全局配置:分页插件、逻辑删除全局、乐观锁、自动填充、防全表、字段策略(insertStrategy/updateStrategy/whereStrategy)、DbConfig/Configuration 速查 | references/02-config.md |
逻辑删除推荐 0+时间戳;唯一索引含 deleted;字段策略全局改 ALWAYS 会误清数据 |
| 实体映射:@TableId 策略、@TableField(字段策略/null/JSON)、枚举映射(@EnumValue/IEnum/@JsonValue)、@Version、@TableLogic | references/03-entity.md |
枚举 @EnumValue+@JsonValue;XML 每处 typeHandler |
| BaseMapper vs IService、继承范式、优先父类方法、saveBatch、null 不更新、MP 专属性能(批量 BATCH / InsertBatchSomeColumn / 一级缓存 / 流式大结果集,见 §3) | references/04-crud.md |
优先父类方法;null 不更新用 UpdateWrapper.set |
| QueryWrapper vs LambdaQueryWrapper、条件构造、apply 防注入、空值语义 | references/05-wrapper.md |
默认 Lambda 方法引用(禁字符串字段名);SQL 函数表达式(窗口/聚合/GROUP BY/专有函数)转 XML,勿用 apply 拼;Wrapper 不可复用;apply 用 {0} 占位 + SqlInjectionUtils.check |
| 分页:Page/IPage、自定义 count、联表分页 XML | references/06-page.md |
IPage 非 null 非 List;ORDER BY 写 XML |
| 插件:逻辑删除/自动填充/乐观锁/多租户/动态表名/数据权限/防全表 | references/07-plugin.md |
插件顺序:分页最后 |
| 数据库适配:DbType/分页方言/主键策略/标识符引用符/逻辑删除函数/批量语法 | references/12-dbtype.md |
非 MySQL 必须显式 DbType;Oracle/PG 勿用 AUTO 主键 |
| 3.4.x→3.5.x 迁移 / 兼容(breaking changes) | references/13-migration.md |
PaginationInterceptor→MybatisPlusInterceptor;IGNORED→ALWAYS;3.5.9+ 引 jsqlparser |
| Agent 常见错误与最佳实践(重点看) | references/08-antipattern.md |
— |
| SQL 日志开启、常见异常与分页失效排查 | references/09-troubleshoot.md |
— |
| MyBatis XML Mapper 编写(mapper-locations / resultMap / 动态 SQL / 联表 / 联表分页) | references/10-xml.md |
窗口/聚合/GROUP BY/专有函数/计算列/联表都进 XML,不止联表 |
| 事务管理(@Transactional / 事务失效 / saveBatch 事务 / 多数据源 / 编程式事务) | references/11-transaction.md |
rollbackFor 必须显式;自调用不走代理;多数据源单 @Transactional 限单库 |
组合场景阅读顺序:先读机制类(
01/02/03/04/05/06/07),再读落地/纠偏类(08/09/10/11)。例:分页+联表→先06后10;枚举+XML→先03后10;逻辑删除+多租户→先07后02;批量+事务→先04后11;事务+多数据源→先11后02;事务回滚排查→先11后08。
使用流程
- 确认 MP 适用性:先执行「第 0 步:依赖探测与激活分支」;依赖缺失时主动询问是否引入 MyBatis-Plus。不适用 → 告知用户并建议退出;部分适用 → 告知范围并让用户确认;正常 → 继续。
- 定位 reference:查上方「决策路由」表,读对应文件。
- 编码遵循强约束:先看 11 条核心强约束,再读 reference 给代码。
- 遇异常先查排错:
references/09-troubleshoot.md+references/08-antipattern.md。 - 输出前自检(9 项):
- starter 坐标对应 SpringBoot 版本?(2.x / 3.x / 4.x)
- 分页场景引了
mybatis-plus-jsqlparser? -
updateById需置 null?→ 改用LambdaUpdateWrapper.set() - XML 中枚举字段每处
#{}都声明了typeHandler=MybatisEnumTypeHandler? - Wrapper 每次
new新实例? - Wrapper 条件用方法引用(
User::getXxx)?字符串字段名仅限动态列名/动态表名例外 - 窗口/聚合/GROUP BY/专有函数/计算列场景 → 改写 XML,未用
apply/last拼? -
@Transactional显式写了rollbackFor = Exception.class? - 事务方法无自调用?
版本注意
- 依赖坐标
com.baomidou:mybatis-plus-*,本地 references 基于 3.5.17 整理,3.5.x 全线适用。 v3.5.9+插件拆分为可选依赖(分页需额外引mybatis-plus-jsqlparser)。- 若用户环境为 3.4.x 旧版:
PaginationInterceptor在 3.4.0 起标记废弃、3.5.x 已移除,应迁移到MybatisPlusInterceptor(见references/13-migration.md);3.4.x 暂无 jsqlparser 拆分,勿按 3.5.9+ 引依赖。