MyBatis-Plus 与 Spring Boot 集成原理实战示例

2025-08-14 22:50

本文主要是介绍MyBatis-Plus 与 Spring Boot 集成原理实战示例,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《MyBatis-Plus与SpringBoot集成原理实战示例》MyBatis-Plus通过自动配置与核心组件集成SpringBoot实现零配置,提供分页、逻辑删除等插件化功能,增强MyBa...

下面是对 MyBatis-Plus 与 Spring Boot 集成原理的源码级深度分析,涵盖自动配置、核心组件、启动流程、关键类解析以及与原生 MyBatis 的差异。通过本篇分析,你将彻底理解 MyBatis-Plus 是如何在 Spring Boot 环境中实现“开箱即用”的。

一、MyBatis-Plus 简介

MyBatis-Plus(简称 MP) 是基于 MyBatis 的增强工具,完全兼容 MyBatis,提供了:

  • 无需写 SQL 的 CRUD 操作(IService / BaseMapper
  • 自动分页插件
  • 逻辑删除
  • 自动填充字段(如 create_time
  • 代码生成器
  • 性能分析插件

它并不是替代 MyBatis,而是对 MyBatis 的“增强 + 自动化”。

二、集成方式(Spring Boot)

1. 引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3.1</version>
</dependency>

⚠️ 注意:使用 mybatis-plus-boot-starter 而非 mybatis-plus,它会自动引入 mybatis-spring 并触发自动配置。

三、核心机制:自动配置(Auto Configuration)

1. 自动配置入口

Spring Boot 启动时,会加载:

META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

内容包含:

com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration

✅ 这是 MP 的自动配置类,由 Spring Boot 2.4+ 的新机制加载。

2.MybatisPlusAutoConfiguration核心功能

@Configuration
@ConditionalOnClass({SqlSessionFactory.class, SqlSessionFactoryBean.class})
@ConditionalOnSingleCandidate(DataSource.class)
@EnableConfigurationProperties(MybatisPlusProperties.class)
@AutoConfigureAfter({DataSourceAutoConfiguration.class})
public class MybatisPlusAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        MybatisSqlSessionFactoryBean factoryBean = new MybatisSqlSessionFactoryBean(http://www.chinasem.cn);
        factoryBean.setDataSource(dataSource);
        // 设置 MyBatis-Plus 全局配置、插件、扫描路径等
        return factoryBean.getObject();
    }
    @Bean
    @ConditionalOnMissingBean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
    @Bean
    @ConditionalOnProperty(prefix = "mybatis-plus", name = "mapper-locations")
    public MapperScannerConfigurer mapperScannerConfigurer() {
        MapperScannerConfigurer configurer = new MapperScannerConfigurer();
        configurer.setBasePackage(mybatisPlusProperties.getMapperlocations());
        return configurer;
    }
}

本质:在原生 MyBatis 集成 Spring 的基础上,做了增强和默认配置

️ 四、MyBatis-Plus 核心增强组件

1.MybatisSqlSessionFactoryBean—— 增强版工厂

继承自 SqlSessionFactoryBean,但做了以下增强:

功能说明
自动注入全局配置GlobalConfig(ID 生成策略、逻辑删除等)
自动注册核心插件PaginationInnerInterceptor(分页)、LogicDeleteInnerInterceptor(逻辑删除)
支持 @DS 多数据源集成 dynamic-datasource-spring-boot-starter
// 自动添加分页插件
if (globalConfig.getDbConfig().isEnableSqlRunner()) {
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.mysql));
}

2.BaseMapper<T>—— 通用 Mapper 接口

public interface BaseMapper<T> extends Mapper<T> {
    int insert(T entity);
    T selectById(Serializable id);
    int updateById(T entity);
    int deleteById(Serializable id);
    // ... 更多方法
}
  • 继承自 MyBatis 的 Mapper<T>,但提供了默认 SQL 实现(通过 MP 内部 SQL 构造器自动生成)。
  • 无需 XML@Select 注解,即可使用 CRUD。

原理:MP 在启动时,通过 MapperRegistry 扫描所有继承 BaseMapper 的接口,并为其生成 SQL。

3.IService<T>与ServiceImpl<M,T>&mjavascriptdash;— 服务层增强

public interface UserService extends IService<User> {}
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {}
  • ServiceImpl<M,T> 内部持有 baseMapper,调用 BaseMapper 方法。
  • 提供 saveBatch()list()page() 等批量操作。

4.MybatisPlusInterceptor—— 核心插件链

MP 将多个功能封装为 Inner Interceptor,统一注册到 MybatisPlusInterceptor

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
    interceptor.addInnerInterceptor(new LogicDeleteInnerInterceptor());
    interceptor.addInnerInterceptor(new blockAttackInnerInterceptor()); // 防止全表更新/删除
    return interceptor;
}
插件作用
PaginationInnerInterceptor分页支持(替换 PageHelper
LogicDeleteInnerInterceptor逻辑删除(自动改写 SQL:WHERE deleted=0
BlockAttackInnerInterceptor阻止无 WHERE 条件的 UPDATE/DELETE
TenantLineInnerInterceptor多租户支持

所有插件基于 MyBatis 的 Executor 拦截机制实现。

五、启动流程源码剖析

flowchart TD
    A[Spring Boot 启动] --> B[加载 MybatisPlusAutoConfiguration]
    B --> C[创建 SqlSessionFactory]
    C --> D[MybatisSqlSessionFactoryBean.build()]
    D --> E[解析 Mapper 接口]
    E --> F[MP 扫描 BaseMapper 子接口]
    F --> G[生成默认 SQL(通过 SqlMethod 枚举)]
    G -python-> H[注册 MappedStatement]
    H --> I[注入 MybatisPlusInterceptor]
    I --> J[Mapper 代理对象创建]
    J --> K[Service 层注入 Mapper]
    K --> L[应用就绪]

关键源码入口:

作用
MybatisPlusAutoConfiguration自动配置主类
MybatisSqlSessionFactoryBean构建 SqlSessionFactory,注入 MP 特性
DefaultSqlSession执行 SQL,MP 的 SQL 已注册为 MappedStatement
MapperRegistry扫描 Mapper 接口
SqlMethod 枚举定义所有默认 SQL 模板(如 INSERT, SELECT_BY_ID

六、MP 如何生成默认 SQL?

MP 在启动时,为每个 BaseMapper 方法预定义了 SQL 模板:

public enum SqlMethod {
    INSERT("insert", "插入一条数据", "<script>INSERT INTO %s %s VALUES %s</script>");
    // 更多...
}

通过 AbstractMethod 实现类(如 Insert)生成 MappedStatement

// org.apache.ibatis.session.Configuration
mappedStatements.put(ms.getId(), ms); // 注册到 MyBatis 全局配置

调用 userMapper.insert(user) 时,实际执行的是这个预生成的 SQL。

七、与原生 MyBatis 集成对比

功能原生 MyBatisMyBatis-Plus
CRUD SQL手写(XML 或注解)自动生成
分页手写或 PageHelper 插件内置 Page<T> + PaginationInnerInterceptor
逻辑删除手动写 WHERE deleted=0配置 mybatis-plus.global-config.db-config.logic-delete-value
字段自动填充自定义 MetaObjectHandler支持 @TableField(fill = FieldFill.INSERT)
代码生成手动或第三方工具内置 AutoGenerator
配置方式手动配置 SqlSessionFactoryBean自动配置,零配置启动

✅ 八、常见配置(application.yml)

mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
  type-aliases-package: com.example.entity
  configuration:
    map-underscore-to-camel-case: true
  global-config:
    db-config:
      id-type: auto
      logic-delete-value: 1
      logic-not-delete-value: 0
  configuration:
    auto-mapping-behavior: full

九、注意事项与坑点

问题解决方案
Mapped Statements collection does not contain...检查 @MapperScan 是否扫描到 Mapper 接口
分页无效确保 MybatisPlusInterceptor 中注册了 PaginationInnerInterceptor
逻辑删除不生效检查实体类字段是否有 @TableLogic 注解
多数据源冲突使用 dynamic-datasource-spring-boot-starter + @DS
自定义 SQL 与 MP 冲突使用 @Options(useCache = false, flushCache = FlushCachePolicy.TRUE)

✅ 总结:MyBatis-Plus 与 Spring Boot 集成的本质

MyBatis-Plus = MyBatis + Auto ConfiguratiChina编程on + Default SQL + Core Plugins

核心思想说明
零配置启动通过 mybatis-plus-boot-starter 自动装配
无侵入增强不改变 MyBatis 核心,只做扩展
约定优于配置提供合理的默认值(如分页、ID 生成)
插件化设计所有功能通过 InnerInterceptor 实现

如果你需要:

  • MyBatis-Plus 分页执行流程图(Mermaid)
  • 自动填充源码分析
  • 代码生成器(Code Generator)原理

欢迎继续提问,我可以为你生成对应的源码图解与实战示例!

到此这篇关于MyBatis-Plus 与 Spring Boot 集成原理实战示例的文章就介绍到这了,更多相关MyBatis-Plus 与 Spring Boot 集成内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于MyBatis-Plus 与 Spring Boot 集成原理实战示例的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1155741

相关文章

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面:本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一:使用 which命令方法二:使用 Java_home工具(Apple 官方推荐)那问题来了,

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述:HashMap的宏观结构二、核心数据结构解析1. 数组(桶数组)2. 链表节点(Node

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点(如日志、事务)与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么?二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储:配置灵活性:编码示例引入依赖:配置ehcache.XML文件:配置

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程?1.2 为什么需要虚拟线程?二、虚拟线程与平台线程对比代码对比示例:三

Python版本信息获取方法详解与实战

《Python版本信息获取方法详解与实战》在Python开发中,获取Python版本号是调试、兼容性检查和版本控制的重要基础操作,本文详细介绍了如何使用sys和platform模块获取Python的主... 目录1. python版本号获取基础2. 使用sys模块获取版本信息2.1 sys模块概述2.1.1

MyBatis延迟加载与多级缓存全解析

《MyBatis延迟加载与多级缓存全解析》文章介绍MyBatis的延迟加载与多级缓存机制,延迟加载按需加载关联数据提升性能,一级缓存会话级默认开启,二级缓存工厂级支持跨会话共享,增删改操作会清空对应缓... 目录MyBATis延迟加载策略一对多示例一对多示例MyBatis框架的缓存一级缓存二级缓存MyBat

Java中的.close()举例详解

《Java中的.close()举例详解》.close()方法只适用于通过window.open()打开的弹出窗口,对于浏览器的主窗口,如果没有得到用户允许是不能关闭的,:本文主要介绍Java中的.... 目录当你遇到以下三种情况时,一定要记得使用 .close():用法作用举例如何判断代码中的 input

Redis中Hash从使用过程到原理说明

《Redis中Hash从使用过程到原理说明》RedisHash结构用于存储字段-值对,适合对象数据,支持HSET、HGET等命令,采用ziplist或hashtable编码,通过渐进式rehash优化... 目录一、开篇:Hash就像超市的货架二、Hash的基本使用1. 常用命令示例2. Java操作示例三

Redis中Set结构使用过程与原理说明

《Redis中Set结构使用过程与原理说明》本文解析了RedisSet数据结构,涵盖其基本操作(如添加、查找)、集合运算(交并差)、底层实现(intset与hashtable自动切换机制)、典型应用场... 目录开篇:从购物车到Redis Set一、Redis Set的基本操作1.1 编程常用命令1.2 集