1. 引言MyBatis-Plus简称 MP是 MyBatis 的增强工具在 MyBatis 的基础上只做增强不做改变为简化开发、提高效率而生。它内置了通用 Mapper、通用 Service几乎可以不用写 SQL 就能完成单表 CRUD 操作同时保留了 MyBatis 的灵活性支持自定义 SQL、分页插件、乐观锁插件等强大功能。本文将围绕 MyBatis-Plus 的核心功能展开重点讲解条件构造器Wrapper、自定义 SQL、主键策略、分页插件、乐观锁等核心特性的实现原理与使用方式帮助读者从原理层面理解 MP 的设计思想。2. MyBatis-Plus 核心功能总览MyBatis-Plus 的核心功能可以概括为以下几个方面通用 CRUD内置 BaseMapper 与 IService提供单表增删改查的通用方法无需编写 SQL。条件构造器Wrapper通过面向对象的链式 API 构造查询条件支持 Lambda 表达式编译期校验字段名。自定义 SQL支持在 XML 或注解中编写自定义 SQL并可与 Wrapper 结合实现动态条件拼接。分页插件基于 MyBatis 拦截器实现物理分页自动生成 COUNT 查询。乐观锁插件通过版本号字段实现乐观锁自动拼接SET version version 1。主键策略支持雪花算法、自增、UUID 等多种主键生成策略。逻辑删除通过全局配置实现逻辑删除自动拼接deleted 0条件。代码生成器一键生成 Entity、Mapper、Service、Controller 等全套代码。整体架构如下图所示业务代码BaseMapper / IService条件构造器 WrapperSQL 解析与拼接MyBatis 执行器数据库分页插件 / 乐观锁插件3. 条件构造器Wrapper原理与使用3.1 Wrapper 是什么Wrapper 是 MyBatis-Plus 中用于封装查询条件的核心抽象类它把 SQL 中的WHERE、ORDER BY、GROUP BY、HAVING等子句抽象为 Java 对象通过链式调用构造查询条件。Wrapper 的继承体系如下WrapperT ├── AbstractWrapperT │ ├── QueryWrapperT │ ├── UpdateWrapperT │ └── LambdaQueryWrapperT │ └── LambdaUpdateWrapperT3.2 核心实现原理Wrapper 的核心原理是将条件表达式解析为 SQL 片段。以QueryWrapper为例调用eq(name, 张三)时内部会生成一个MergeSegments对象将条件片段按AND/OR组合最终在getSqlSegment()方法中拼接为完整的 SQL 片段。关键源码逻辑如下// AbstractWrapper 中的核心方法publicChildreneq(Rcolumn,Objectval){returnaddCondition(true,column,SqlKeyword.EQ,val);}privateChildrenaddCondition(booleancondition,Rcolumn,SqlKeywordkeyword,Objectval){// 将条件封装为 QueryCondition 对象存入条件列表queryConditions.add(newQueryCondition(column,keyword,val));return(Children)this;}当执行selectList(wrapper)时MP 会调用wrapper.getSqlSegment()生成WHERE子句再通过TableInfo将实体字段映射为数据库列名最终拼装成完整 SQL。3.3 常用 API 示例// 查询年龄大于 18 且姓名包含张的用户QueryWrapperUserwrappernewQueryWrapper();wrapper.gt(age,18).like(name,张).orderByDesc(create_time);ListUserusersuserMapper.selectList(wrapper);3.4 Lambda 条件构造器Lambda 条件构造器通过LambdaQueryWrapper使用实体类的getter方法引用代替字符串字段名编译期即可校验字段是否存在避免运行时因字段名拼写错误导致异常。LambdaQueryWrapperUserwrappernewLambdaQueryWrapper();wrapper.gt(User::getAge,18).like(User::getName,张).orderByDesc(User::getCreateTime);ListUserusersuserMapper.selectList(wrapper);Lambda 的实现原理是通过SerializedLambda解析方法引用提取出对应的属性名再结合TableInfo映射为数据库列名。4. 自定义 SQL 的实现方式4.1 为什么需要自定义 SQL虽然 MP 提供了通用 CRUD但在多表联查、复杂子查询、特定数据库函数等场景下仍需要手写 SQL。MP 支持两种自定义 SQL 的方式注解方式和 XML 方式。4.2 注解方式publicinterfaceUserMapperextendsBaseMapperUser{Select(SELECT * FROM user WHERE age #{age} AND name LIKE CONCAT(%, #{name}, %))ListUserselectByCondition(Param(age)Integerage,Param(name)Stringname);}4.3 XML 方式mappernamespacecom.example.mapper.UserMapperselectidselectUserPageresultTypecom.example.entity.UserSELECT * FROM userwhereiftestname ! null and name ! AND name LIKE CONCAT(%, #{name}, %)/ififtestage ! nullAND agegt;#{age}/if/where/select/mapper4.4 自定义 SQL 结合 WrapperMP 最强大的特性之一是自定义 SQL 与 Wrapper 结合可以在自定义 SQL 中动态拼接 Wrapper 生成的 WHERE 条件Select(SELECT * FROM user ${ew.customSqlSegment})ListUserselectByWrapper(Param(Constants.WRAPPER)WrapperUserwrapper);调用时LambdaQueryWrapperUserwrappernewLambdaQueryWrapper();wrapper.gt(User::getAge,18).like(User::getName,张);ListUserusersuserMapper.selectByWrapper(wrapper);这里的${ew.customSqlSegment}会被替换为 Wrapper 生成的WHERE子句实现自定义 SQL 与动态条件的完美结合。5. 主键策略5.1 主键策略类型MyBatis-Plus 支持多种主键生成策略通过TableId注解的type属性指定策略说明IdType.AUTO数据库自增依赖数据库的自增主键IdType.INPUT用户手动输入不自动生成IdType.ASSIGN_ID默认策略使用雪花算法生成分布式 IDIdType.ASSIGN_UUID使用 UUID 生成主键IdType.NONE不指定跟随全局配置5.2 雪花算法原理雪花算法Snowflake是 Twitter 开源的分布式 ID 生成算法生成的 ID 是一个 64 位的 Long 型整数结构如下| 1 bit 符号位 | 41 bit 时间戳 | 10 bit 机器 ID | 12 bit 序列号 |符号位固定为 0保证 ID 为正数。时间戳毫秒级时间戳可保证 69 年的使用期限。机器 ID区分不同机器支持最多 1024 台机器。序列号同一毫秒内的递增序列支持每毫秒生成 4096 个 ID。// 使用示例TableId(typeIdType.ASSIGN_ID)privateLongid;5.3 全局配置mybatis-plus:global-config:db-config:id-type:assign_id6. 分页插件6.1 分页插件原理MyBatis-Plus 的分页插件基于 MyBatis 的**拦截器Interceptor**机制实现。在执行 SQL 前拦截器会拦截Executor.query()方法解析出原始 SQL自动生成 COUNT 查询和分页 SQL。ConfigurationpublicclassMybatisPlusConfig{BeanpublicMybatisPlusInterceptormybatisPlusInterceptor(){MybatisPlusInterceptorinterceptornewMybatisPlusInterceptor();interceptor.addInnerInterceptor(newPaginationInnerInterceptor(DbType.MYSQL));returninterceptor;}}6.2 分页使用示例PageUserpagenewPage(1,10);// 第 1 页每页 10 条LambdaQueryWrapperUserwrappernewLambdaQueryWrapper();wrapper.gt(User::getAge,18);PageUserresultuserMapper.selectPage(page,wrapper);System.out.println(总记录数result.getTotal());System.out.println(总页数result.getPages());System.out.println(当前页数据result.getRecords());6.3 分页 SQL 生成过程以 MySQL 为例原始 SQL 为SELECT*FROMuserWHEREage18分页插件会生成两条 SQL-- COUNT 查询SELECTCOUNT(*)FROMuserWHEREage18-- 分页查询SELECT*FROMuserWHEREage18LIMIT0,107. 乐观锁插件7.1 乐观锁原理乐观锁假设并发冲突较少在更新时通过版本号判断数据是否被修改。更新前先查询版本号更新时携带版本号并执行SET version version 1若版本号不匹配则更新失败。7.2 配置与使用// 实体类中增加版本字段VersionprivateIntegerversion;ConfigurationpublicclassMybatisPlusConfig{BeanpublicMybatisPlusInterceptormybatisPlusInterceptor(){MybatisPlusInterceptorinterceptornewMybatisPlusInterceptor();interceptor.addInnerInterceptor(newOptimisticLockerInnerInterceptor());returninterceptor;}}7.3 更新 SQL 生成执行updateById(user)时MP 自动生成如下 SQLUPDATEuserSETname?,versionversion1WHEREid?ANDversion?若更新影响行数为 0说明版本号已被其他事务修改需要重试或提示用户。8. 逻辑删除8.1 逻辑删除原理逻辑删除并非真正删除数据而是通过标记字段如deleted将数据标记为已删除。查询时自动拼接deleted 0条件删除时自动执行UPDATE语句。8.2 配置与使用TableLogicprivateIntegerdeleted;mybatis-plus:global-config:db-config:logic-delete-field:deletedlogic-delete-value:1logic-not-delete-value:0执行deleteById(1L)时实际执行的 SQL 为UPDATEuserSETdeleted1WHEREid1ANDdeleted09. 总结MyBatis-Plus 通过封装通用 CRUD、条件构造器、分页插件、乐观锁、逻辑删除等能力大幅提升了开发效率。其核心设计思想是约定优于配置与只增强不改变条件构造器将 SQL 条件抽象为 Java 对象配合 Lambda 表达式实现编译期校验。自定义 SQL保留了 MyBatis 的灵活性并可与 Wrapper 无缝结合。分页与乐观锁插件基于 MyBatis 拦截器机制对业务代码零侵入。主键策略通过雪花算法解决了分布式场景下的 ID 生成问题。掌握这些核心功能的原理不仅能更高效地使用 MyBatis-Plus还能在遇到复杂业务场景时灵活扩展写出更优雅的代码。
1. 引言MyBatis-Plus简称 MP是 MyBatis 的增强工具在 MyBatis 的基础上只做增强不做改变为简化开发、提高效率而生。它内置了通用 Mapper、通用 Service几乎可以不用写 SQL 就能完成单表 CRUD 操作同时保留了 MyBatis 的灵活性支持自定义 SQL、分页插件、乐观锁插件等强大功能。本文将围绕 MyBatis-Plus 的核心功能展开重点讲解条件构造器Wrapper、自定义 SQL、主键策略、分页插件、乐观锁等核心特性的实现原理与使用方式帮助读者从原理层面理解 MP 的设计思想。2. MyBatis-Plus 核心功能总览MyBatis-Plus 的核心功能可以概括为以下几个方面通用 CRUD内置 BaseMapper 与 IService提供单表增删改查的通用方法无需编写 SQL。条件构造器Wrapper通过面向对象的链式 API 构造查询条件支持 Lambda 表达式编译期校验字段名。自定义 SQL支持在 XML 或注解中编写自定义 SQL并可与 Wrapper 结合实现动态条件拼接。分页插件基于 MyBatis 拦截器实现物理分页自动生成 COUNT 查询。乐观锁插件通过版本号字段实现乐观锁自动拼接SET version version 1。主键策略支持雪花算法、自增、UUID 等多种主键生成策略。逻辑删除通过全局配置实现逻辑删除自动拼接deleted 0条件。代码生成器一键生成 Entity、Mapper、Service、Controller 等全套代码。整体架构如下图所示业务代码BaseMapper / IService条件构造器 WrapperSQL 解析与拼接MyBatis 执行器数据库分页插件 / 乐观锁插件3. 条件构造器Wrapper原理与使用3.1 Wrapper 是什么Wrapper 是 MyBatis-Plus 中用于封装查询条件的核心抽象类它把 SQL 中的WHERE、ORDER BY、GROUP BY、HAVING等子句抽象为 Java 对象通过链式调用构造查询条件。Wrapper 的继承体系如下WrapperT ├── AbstractWrapperT │ ├── QueryWrapperT │ ├── UpdateWrapperT │ └── LambdaQueryWrapperT │ └── LambdaUpdateWrapperT3.2 核心实现原理Wrapper 的核心原理是将条件表达式解析为 SQL 片段。以QueryWrapper为例调用eq(name, 张三)时内部会生成一个MergeSegments对象将条件片段按AND/OR组合最终在getSqlSegment()方法中拼接为完整的 SQL 片段。关键源码逻辑如下// AbstractWrapper 中的核心方法publicChildreneq(Rcolumn,Objectval){returnaddCondition(true,column,SqlKeyword.EQ,val);}privateChildrenaddCondition(booleancondition,Rcolumn,SqlKeywordkeyword,Objectval){// 将条件封装为 QueryCondition 对象存入条件列表queryConditions.add(newQueryCondition(column,keyword,val));return(Children)this;}当执行selectList(wrapper)时MP 会调用wrapper.getSqlSegment()生成WHERE子句再通过TableInfo将实体字段映射为数据库列名最终拼装成完整 SQL。3.3 常用 API 示例// 查询年龄大于 18 且姓名包含张的用户QueryWrapperUserwrappernewQueryWrapper();wrapper.gt(age,18).like(name,张).orderByDesc(create_time);ListUserusersuserMapper.selectList(wrapper);3.4 Lambda 条件构造器Lambda 条件构造器通过LambdaQueryWrapper使用实体类的getter方法引用代替字符串字段名编译期即可校验字段是否存在避免运行时因字段名拼写错误导致异常。LambdaQueryWrapperUserwrappernewLambdaQueryWrapper();wrapper.gt(User::getAge,18).like(User::getName,张).orderByDesc(User::getCreateTime);ListUserusersuserMapper.selectList(wrapper);Lambda 的实现原理是通过SerializedLambda解析方法引用提取出对应的属性名再结合TableInfo映射为数据库列名。4. 自定义 SQL 的实现方式4.1 为什么需要自定义 SQL虽然 MP 提供了通用 CRUD但在多表联查、复杂子查询、特定数据库函数等场景下仍需要手写 SQL。MP 支持两种自定义 SQL 的方式注解方式和 XML 方式。4.2 注解方式publicinterfaceUserMapperextendsBaseMapperUser{Select(SELECT * FROM user WHERE age #{age} AND name LIKE CONCAT(%, #{name}, %))ListUserselectByCondition(Param(age)Integerage,Param(name)Stringname);}4.3 XML 方式mappernamespacecom.example.mapper.UserMapperselectidselectUserPageresultTypecom.example.entity.UserSELECT * FROM userwhereiftestname ! null and name ! AND name LIKE CONCAT(%, #{name}, %)/ififtestage ! nullAND agegt;#{age}/if/where/select/mapper4.4 自定义 SQL 结合 WrapperMP 最强大的特性之一是自定义 SQL 与 Wrapper 结合可以在自定义 SQL 中动态拼接 Wrapper 生成的 WHERE 条件Select(SELECT * FROM user ${ew.customSqlSegment})ListUserselectByWrapper(Param(Constants.WRAPPER)WrapperUserwrapper);调用时LambdaQueryWrapperUserwrappernewLambdaQueryWrapper();wrapper.gt(User::getAge,18).like(User::getName,张);ListUserusersuserMapper.selectByWrapper(wrapper);这里的${ew.customSqlSegment}会被替换为 Wrapper 生成的WHERE子句实现自定义 SQL 与动态条件的完美结合。5. 主键策略5.1 主键策略类型MyBatis-Plus 支持多种主键生成策略通过TableId注解的type属性指定策略说明IdType.AUTO数据库自增依赖数据库的自增主键IdType.INPUT用户手动输入不自动生成IdType.ASSIGN_ID默认策略使用雪花算法生成分布式 IDIdType.ASSIGN_UUID使用 UUID 生成主键IdType.NONE不指定跟随全局配置5.2 雪花算法原理雪花算法Snowflake是 Twitter 开源的分布式 ID 生成算法生成的 ID 是一个 64 位的 Long 型整数结构如下| 1 bit 符号位 | 41 bit 时间戳 | 10 bit 机器 ID | 12 bit 序列号 |符号位固定为 0保证 ID 为正数。时间戳毫秒级时间戳可保证 69 年的使用期限。机器 ID区分不同机器支持最多 1024 台机器。序列号同一毫秒内的递增序列支持每毫秒生成 4096 个 ID。// 使用示例TableId(typeIdType.ASSIGN_ID)privateLongid;5.3 全局配置mybatis-plus:global-config:db-config:id-type:assign_id6. 分页插件6.1 分页插件原理MyBatis-Plus 的分页插件基于 MyBatis 的**拦截器Interceptor**机制实现。在执行 SQL 前拦截器会拦截Executor.query()方法解析出原始 SQL自动生成 COUNT 查询和分页 SQL。ConfigurationpublicclassMybatisPlusConfig{BeanpublicMybatisPlusInterceptormybatisPlusInterceptor(){MybatisPlusInterceptorinterceptornewMybatisPlusInterceptor();interceptor.addInnerInterceptor(newPaginationInnerInterceptor(DbType.MYSQL));returninterceptor;}}6.2 分页使用示例PageUserpagenewPage(1,10);// 第 1 页每页 10 条LambdaQueryWrapperUserwrappernewLambdaQueryWrapper();wrapper.gt(User::getAge,18);PageUserresultuserMapper.selectPage(page,wrapper);System.out.println(总记录数result.getTotal());System.out.println(总页数result.getPages());System.out.println(当前页数据result.getRecords());6.3 分页 SQL 生成过程以 MySQL 为例原始 SQL 为SELECT*FROMuserWHEREage18分页插件会生成两条 SQL-- COUNT 查询SELECTCOUNT(*)FROMuserWHEREage18-- 分页查询SELECT*FROMuserWHEREage18LIMIT0,107. 乐观锁插件7.1 乐观锁原理乐观锁假设并发冲突较少在更新时通过版本号判断数据是否被修改。更新前先查询版本号更新时携带版本号并执行SET version version 1若版本号不匹配则更新失败。7.2 配置与使用// 实体类中增加版本字段VersionprivateIntegerversion;ConfigurationpublicclassMybatisPlusConfig{BeanpublicMybatisPlusInterceptormybatisPlusInterceptor(){MybatisPlusInterceptorinterceptornewMybatisPlusInterceptor();interceptor.addInnerInterceptor(newOptimisticLockerInnerInterceptor());returninterceptor;}}7.3 更新 SQL 生成执行updateById(user)时MP 自动生成如下 SQLUPDATEuserSETname?,versionversion1WHEREid?ANDversion?若更新影响行数为 0说明版本号已被其他事务修改需要重试或提示用户。8. 逻辑删除8.1 逻辑删除原理逻辑删除并非真正删除数据而是通过标记字段如deleted将数据标记为已删除。查询时自动拼接deleted 0条件删除时自动执行UPDATE语句。8.2 配置与使用TableLogicprivateIntegerdeleted;mybatis-plus:global-config:db-config:logic-delete-field:deletedlogic-delete-value:1logic-not-delete-value:0执行deleteById(1L)时实际执行的 SQL 为UPDATEuserSETdeleted1WHEREid1ANDdeleted09. 总结MyBatis-Plus 通过封装通用 CRUD、条件构造器、分页插件、乐观锁、逻辑删除等能力大幅提升了开发效率。其核心设计思想是约定优于配置与只增强不改变条件构造器将 SQL 条件抽象为 Java 对象配合 Lambda 表达式实现编译期校验。自定义 SQL保留了 MyBatis 的灵活性并可与 Wrapper 无缝结合。分页与乐观锁插件基于 MyBatis 拦截器机制对业务代码零侵入。主键策略通过雪花算法解决了分布式场景下的 ID 生成问题。掌握这些核心功能的原理不仅能更高效地使用 MyBatis-Plus还能在遇到复杂业务场景时灵活扩展写出更优雅的代码。
