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

下面是对 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();
        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>—— 服务层增强

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 --> 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 集成对比

功能	原生 mybatis	mybatis-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 configuration + default sql + core plugins

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

如果你需要：

mybatis-plus 分页执行流程图（mermaid）
自动填充源码分析
代码生成器（code generator）原理

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

到此这篇关于mybatis-plus 与 spring boot 集成原理实战示例的文章就介绍到这了,更多相关mybatis-plus 与 spring boot 集成内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网！

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

2025年08月14日 • Java •我要评论