MyBatis-Plus基于MyBatis封装 BaseMapper的流程步骤

 更新时间:2025年04月03日 08:39:04   作者:Asthenian  
MyBatis-Plus作为 MyBatis 的增强框架,通过 BaseMapper 提供了通用的 CRUD 操作,极大地提升了开发效率,为了更透彻地理解其封装机制,本文将采用链路追踪的思维,从开发者调用接口开始,分析其如何基于 MyBatis 完成对 BaseMapper 的封装,需要的朋友可以参考下

引言

MyBatis-Plus(简称 MP)作为 MyBatis 的增强框架,通过 BaseMapper 提供了通用的 CRUD 操作,极大地提升了开发效率。为了更透彻地理解其封装机制,本文将采用链路追踪的思维,从开发者调用接口开始,逐步深入到 MyBatis-Plus 的核心实现,分析其如何基于 MyBatis 完成对 BaseMapper 的封装。

一、从调用开始:BaseMapper 的使用场景

假设我们有一个简单的实体类 User 和对应的 Mapper 接口:

@TableName("t_user")
public class User {
    @TableId
    private Long id;
    private String name;
    private Integer age;
    // getter 和 setter 省略
}

public interface UserMapper extends BaseMapper<User> {
}

开发者只需这样调用:

UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
User user = userMapper.selectById(1L);

表面上看,selectByIdBaseMapper 提供的方法,但其背后是如何实现的呢?让我们沿着调用链路逐步追踪。

二、链路追踪:从接口调用到代理执行

1. 获取 Mapper 代理对象

当调用 sqlSession.getMapper(UserMapper.class) 时,MyBatis 的 SqlSession 会委托给 ConfigurationgetMapper 方法:

// MyBatis: org.apache.ibatis.session.Configuration
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    return mapperRegistry.getMapper(type, sqlSession);
}

这里的 mapperRegistry 是 MyBatis 的 MapperRegistry 类,但在 MyBatis-Plus 中被替换为 MybatisMapperRegistry。链路进入 MyBatis-Plus 的自定义实现:

// MyBatis-Plus: com.baomidou.mybatisplus.core.MybatisMapperRegistry
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {
    MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);
    if (mapperProxyFactory == null) {
        throw new BindingException("Type " + type + " is not known to the MapperRegistry.");
    }
    return mapperProxyFactory.newInstance(sqlSession);
}
  • 关键点:MyBatis-Plus 重写了 MapperRegistry,并在启动时通过扫描将所有继承 BaseMapper 的接口注册到 knownMappers 中。
  • 代理生成newInstance 方法创建了一个 MapperProxy 对象,这是 JDK 动态代理的实现。

2. 方法调用拦截

当调用 userMapper.selectById(1L) 时,代理对象 MapperProxyinvoke 方法被触发:

// MyBatis-Plus: com.baomidou.mybatisplus.core.override.MybatisMapperProxy
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
    if (Object.class.equals(method.getDeclaringClass())) {
        return method.invoke(this, args);
    }
    MybatisMapperMethod mapperMethod = cachedMapperMethod(method);
    return mapperMethod.execute(sqlSession, args);
}
  • 链路分叉cachedMapperMethod 会根据方法签名缓存并返回一个 MybatisMapperMethod 对象。
  • 执行逻辑execute 方法根据方法名和参数决定具体的执行路径。

对于 selectById,链路进入 MybatisMapperMethod.execute

// MyBatis-Plus: com.baomidou.mybatisplus.core.override.MybatisMapperMethod
public Object execute(SqlSession sqlSession, Object[] args) {
    if (SqlCommandType.SELECT == command.getType()) {
        if (method.getReturnType().isAssignableFrom(List.class)) {
            return sqlSession.selectList(command.getName(), args);
        }
        return sqlSession.selectOne(command.getName(), args[0]);
    }
    // 其他类型如 INSERT、UPDATE 等略
}
  • 关键点command.getName() 返回的是一个全局唯一的 SQL ID,例如 com.baomidou.mybatisplus.core.mapper.BaseMapper.selectById
  • 执行 SQL:最终调用 MyBatis 的 selectOne 方法执行查询。

三、SQL 注入:BaseMapper 方法的实现来源

问题来了:selectById 的 SQL 是从哪里来的?答案在于 MyBatis-Plus 的 SQL 注入机制。

1. 启动时的 SQL 注入

MyBatis-Plus 在 Spring 容器初始化时,通过 MapperScannerConfigurer 扫描 Mapper 接口,并调用 ISqlInjector 注入通用 SQL:

// MyBatis-Plus: com.baomidou.mybatisplus.core.injector.DefaultSqlInjector
public void inspectInject(MapperBuilderAssistant builderAssistant, Class<?> mapperClass) {
    List<AbstractMethod> methodList = getMethodList(mapperClass);
    for (AbstractMethod method : methodList) {
        method.inject(builderAssistant, mapperClass);
    }
}
  • 方法列表getMethodList 返回 BaseMapper 中定义的所有方法(如 selectByIdinsert 等)的实现类,例如 SelectById
  • 注入过程:以 SelectById 为例:
// MyBatis-Plus: com.baomidou.mybatisplus.core.injector.methods.SelectById
public void injectMappedStatement(Class<?> mapperClass, Class<?> modelClass, TableInfo tableInfo) {
    String sql = String.format("<script>SELECT %s FROM %s WHERE %s = #{id}</script>",
        sqlSelectColumns(), tableInfo.getTableName(), tableInfo.getKeyColumn());
    SqlSource sqlSource = languageDriver.createSqlSource(configuration, sql, modelClass);
    addSelectMappedStatement(mapperClass, "selectById", sqlSource, modelClass, tableInfo);
}
  • SQL 生成:根据 TableInfo(通过反射解析实体类)动态生成 SELECT * FROM t_user WHERE id = #{id}
  • 注册:将生成的 MappedStatement 注册到 MyBatis 的 Configuration 中。

2. TableInfo 的作用

TableInfo 是 MyBatis-Plus 的核心元数据类,通过 TableInfoHelper 在启动时解析实体类:

  • @TableName("t_user") → 表名 t_user
  • @TableId → 主键字段 id
  • 字段映射 → 自动推断 nameage 等列名。

这些信息为 SQL 注入提供了基础数据。

四、链路总结:从调用到执行的全流程

  • 开发者调用userMapper.selectById(1L)
  • 代理拦截MybatisMapperProxy.invokeMybatisMapperMethod.execute
  • SQL 执行sqlSession.selectOne → MyBatis 执行预注入的 MappedStatement
  • 结果映射:MyBatis 将查询结果映射为 User 对象返回。

背后支持:

  • 启动时:扫描 Mapper → 注入通用 SQL → 注册 MappedStatement
  • 运行时:动态代理 → 方法路由 → SQL 执行。

五、与 MyBatis 的协作与增强

  • 复用 MyBatis:动态代理、SqlSession、结果映射等核心机制完全继承自 MyBatis。
  • 增强点

    SQL 自动化:通过 ISqlInjector 注入通用 SQL。

    元数据管理TableInfo 实现实体与表的自动映射。

    条件构造Wrapper 扩展了动态查询能力。

六、结论

MyBatis-Plus 对 BaseMapper 的封装,是在 MyBatis 动态代理和 SQL 执行框架上的巧妙扩展。通过启动时的 SQL 注入和运行时的代理拦截,它实现了通用 CRUD 的零配置使用。链路追踪显示,这种设计既保留了 MyBatis 的灵活性,又通过自动化大幅提升了开发效率,堪称对 MyBatis 的“完美补完”。

以上就是MyBatis-Plus基于MyBatis封装 BaseMapper的流程步骤的详细内容,更多关于MyBatis-Plus封装 BaseMapper的资料请关注脚本之家其它相关文章!

相关文章

  • Java并发之嵌套管程锁死详解

    Java并发之嵌套管程锁死详解

    这篇文章主要介绍了Java并发之嵌套管程锁死详解,涉及嵌套管程锁死的发生,实例等相关内容,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • javaSE基础java自定义注解原理分析

    javaSE基础java自定义注解原理分析

    这篇文章主要介绍了javaSE基础对java自定义注解原理分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多度进步,早日升职加薪
    2021-10-10
  • 浅谈springboot内置tomcat和外部独立部署tomcat的区别

    浅谈springboot内置tomcat和外部独立部署tomcat的区别

    这篇文章主要介绍了浅谈springboot内置tomcat和外部独立部署tomcat的区别,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • java使用apache.poi导出word文件的示例代码

    java使用apache.poi导出word文件的示例代码

    这篇文章主要介绍了java使用apache.poi导出word文件,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • springcloud如何获取网关封装的头部信息

    springcloud如何获取网关封装的头部信息

    这篇文章主要介绍了springcloud获取网关封装的头部信息,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • Maven编译Fatal error compiling:无效的目标发行版:11问题及解决

    Maven编译Fatal error compiling:无效的目标发行版:11问题及解决

    在Java11中编译Springboot工程时遇到问题,解决方法是在pom.xml文件中指定Maven的Java编译器版本,可以使用MavenJava编译器属性或插件,在Java9及以后的版本中,也要使用插件并设置release属性
    2024-12-12
  • 从java面试题了解你所模糊的数组

    从java面试题了解你所模糊的数组

    这篇文章主要介绍了从java面试题了解你所模糊的数组,数组用来存储一系列的数据项,其中的每一项具有相同的基本数据类型、类或相同的父类。通过使用数组,可以在很大程度上缩短和简化程序代码,从而提高应用程序的效率。,需要的朋友可以参考下
    2019-06-06
  • Java运行Python脚本的几种方式小结

    Java运行Python脚本的几种方式小结

    在跨语言编程中,有时候我们需要在 Java 应用程序中执行 Python 脚本,这可能是为了利用 Python 丰富的库生态系统,或者是为了在已有 Java 系统中集成一些 Python 特有的功能,本文给大家介绍了实现这几种目标的方法,需要的朋友可以参考下
    2024-12-12
  • java中调用super的实例讲解

    java中调用super的实例讲解

    在本篇文章里小编给大家分享了一篇关于java中调用super的实例讲解内容,有兴趣的朋友们可以学习下。
    2020-12-12
  • Java看完秒懂版熔断和降级的关系

    Java看完秒懂版熔断和降级的关系

    这篇文章主要介绍了Java熔断和降级的关系,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-09-09

最新评论