专栏首页vivo互联网技术Mybatis-Plus的应用场景及注入SQL原理分析
原创

Mybatis-Plus的应用场景及注入SQL原理分析

一、背景

1.1 传统Mybatis的弊端

1.1.1 场景描述

假设有两张表:一张商品表、一张订单表,具体表的字段如下:

现有如下需求:

  • 分别根据id查询商品表和订单表所有信息
  • 根据支付状态和通知状态查询订单表信息
  • 对订单表增加一个订单状态,根据订单状态查询订单信息

1.1.2 需求

需求a:根据id查询商品表:

​@Select(" SELECT p.id ,p.name ,p.picture ,p.type ,p.price, p.type, p.time
          FROM product p  where id = #{id} ")
List<Product> getProductsBYId(@Param("id") Integer id);

根据id查询订单表所有信息:

@Select(" SELECT o.id ,o.pay_no ,o.user_id ,o.product_id ,o.pay_price, o.num, o.pay_time, o.order_type, o.notif_type
          FROM order o  where id = #{id} ")
List<Order> getOrderBYId(@Param("id") Integer id);

需求b:根据支付状态和通知状态查询订单表信息

​@Select(" SELECT o.id ,o.pay_no ,o.user_id ,o.product_id ,o.pay_price, o.num, o.pay_time, o.order_type, o.notif_type
          FROM order o  where order_type= #{orderType} ")
List<Order> getOrderBYId(@Param("orderType") Integer orderType);
 
@Select(" SELECT o.id ,o.pay_no ,o.user_id ,o.product_id ,o.pay_price, o.num, o.pay_time, o.order_type, o.notif_type
          FROM order o  where notify_type= #{notifyType} ")
List<Order> getOrderBYId(@Param("notifyType") Integer notifyType);

需求c:对订单表增加一个订单状态status,根据订单状态查询订单信息。

传统mybaits需要三步:首先需要在订单表里加个字段,然后在订单的实体类添加这个属性,并且将所有dao层设计该状态的的查询sql都修改一遍,加上这个字段。

1.1.3 上述方式有什么问题呢?

需求a:对于不同的实体类,即使查询的目的一致,仍然需要重复构造类似的sql语句,仅仅是表字段和表信息不同。 需求b:对于相似的查询条件,针对某个单一场景必须构造不同的sql,造成sql语句的大量冗余。 需求c:将dao层所有涉及到新增字段的sql都需要修改一遍,这个过程比较繁琐且容易出错。

使用mybatis-plus就可以解决上述问题。

1.1.4 Myatis-plus的解决方案

首先让ProductMapper和OrderMapper继承BaseMapper类:

public interface ProductMapper extends BaseMapper<Product> {
}
 
public interface OrderMapper extends BaseMapper<Order> {
  
}

需求a:

分别根据id查询商品表和订单表:由于BaseMapper中提供了selectById的方法,可以直接根据具体业务场景,传入指定的参数例如(id=1)即可。无需书写具体的sql语句,至于sql自动生成的原理将在下面介绍;

productMapper.selectById(1);
orderMapper.selectById(1);

需求b:

此时利用BaseMapper.selectList(Wapper queryWrapper)方法直接构造查询条件,例如查询支付状态为2和通知状态为1的订单信息

orderMapper.selectList(new QueryWrapper<Order>().eq("orderType",2));
orderMapper.selectList(new QueryWrapper<Order>().eq("notifyType",1));
orderMapper.selectList(new QueryWrapper<Order>().eq("orderType",2));orderMapper.selectList(new QueryWrapper<Order>().eq("notifyType",1));

此时我们可以发现:使用了Mybatis-plus以后,我们更加聚焦于业务本身,对于上述相似的应用场景,无需构造雷同的SQL,利用包装器直接传入查询条件。

需求c:

前两步与传统mybatis一致,由于MyBatis-plus无需手动创建SQL,因此减少了大量的重复劳动。

1.2 MyBatis-Plus的定位

MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。

1.3 特性

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑;
  • 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作;
  • 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求;
  • 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错;
  • 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题;
  • 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作;
  • 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere );
  • 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用;
  • 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询;
  • 分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库;
  • 内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询;
  • 内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作。

1.4 原理解析

本文针对MyBatis-plus中的核心功能:SQL自动注入功能,进行流程分析及原理探究。

二、准备工作

先从一个简单的demo入手,感受一下MyBatis-plus的便捷性。

2.1 基础接口BaseMapper

源码中提供了一个基础接口,里面包含了基本的增删改查方法。

2.2 创建实体类对象

2.3 业务接口UserMapper

业务中根据具体实体对象,继承该抽象接口。

2.4 测试用例

控制台显示:MyBatis-plus最终为我们自动生成了SQL语句。根据上述操作分析:UserMapper继承了BaseMapper,拥有了deleteById的方法,但是MyBatis-plus是基于mybatis的增强版,关键在于最终仍然需要提供具体的SQL语句,来进行数据库操作

下面就通过debug由上而下分析mybatis-plus是如何生成业务sql以及自动注入的。

三、SQL语句存储在哪里?

mappedStatements:描述sql信息

如下图所示:mybatis为我们生成了一个代理对象,里面包含了一些重要的属性。

具体如下:

userMapper——>mybatisMapperProxy——>sqlSession——>sqlSessionFactory

——>configuration——>mappedStatements——>mappedStatement——>sql语句

至此我们可以发现每一个SQL语句对应一个mappedStatement,mappedstatements存储在configuration文件(configuration是mybatis的全局配置文件,包含数据源、mapper、其他配置信息)中。

四、SQL语句是什么时候注入的?

4.1 AbstractMethod.addMappedStatement

基于上面的分析,想要知道SQL语句什么时候拿到的,就是要找到mappedStatement被添加的位置。追踪到AbstractMethod的抽象方法中。

找到了addMappedStatement()方法

而BaseMapper的所有方法(deleteById、delete、insert、select、update等)都继承了该抽象方法。

根据mapper方法(deleteById)显然是调用addDeleteMappedStatement方法。

这里我们可以发现,源码中根据不同的方法继承AbstractMethod实现了不同的实现类,并且实现了injectMappedStatement方法,sqlSource也是在这个地方被添加进配置文件。

4.2 AbstractMethod.inject

继续研究AbstractMethod抽象类,inject方法实现了自动注入sql的动作。

有上述源码可知,项目启动时,首先由默认注入器生成基础CRUD实现类对象,其次遍历实现类列表,依次注入各自的模板SQL,最后将其添加至mappedstatement。

五、SQL语句是怎么生成的?

5.1 SQL模板

上述方法中有两个关键的参数:SqlMethod、SqlSource;

继续研究源码发现:sqlMethod本质上是一个枚举类,存储了两个关键的元素:

BaseMapper中的方法名; 方法名对应的sql语句模板(即被<scripe>标签包裹的字符串)。

到这里我们基本了解了mybaits-plus实现sql自动生成的本质:根据不同的方法来提供一些通用的模板,项目启动后再加载进mappedStatement。

5.2 SqlSource

此时SqlSource通过解析SQL模板、以及传入的表信息和主键信息构建出了SQL语句。

5.3 数据库表信息是如何获取的?

分析initTableName()方法:获取表名信息源码中传入了实体类信息clazz,其实就是通过实体上的@TableName注解拿到了表名;

我们在定义实体类的同时,指定了该实体类对应的表名。

分析initTableFields()方法:

获取主键及其他字段信息

至此tableInfo的信息已经注入完成了。

在研究完解析mapper的核心过程之后,我们再简单看下mapper文件被添加到configuration(mybatis核心配置文件)的过程。

六、mapper文件被添加的过程

ISqlInjector:Sql注入器

MybatisMapperAnnotationBuilder:mapper解析器

MybatisMapperAnnotationBuilder中的parse方法获取了sqlInjector(Sql注入器)来进行SQL注入。

Mybatis添加mapper的固有流程:MybatisMapperRegistry

调用MapperAnnotionBuilder解析器进行解析

MybatisConfiguration.addMapper

MybatisXMLConfigBuilder.mapperElemnt

MybayisXMLConfigBuilder.parseConfiguration

添加mapper文件的过程分析到这里就完成了。

七、总结

7.1 流程梳理

下面总结梳理了一下mybatis-plus解析mapper文件自动注入sql的主要流程。

7.2 Mybatis-plus的ORM的核心思想

1)实体类和数据库表通过自定义注解来完成一一映射。 2)对象属性和字段同样使用注解来一一对应(命名注意要相同)。 3)为了提高复用性使得具体的mapper继承通用的增删改查接口。 4)利用模板方法和对象属性值动态拼接SQL。

八、参考文档

MyBatis-plus官方文档:https://mp.baomidou.com/

作者:vivo互联网服务器团队-Li Lei

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • mybatis-plus思维导图,让mybatis-plus不再难懂

    1 mybatis-plus与mybatis mybatis Mybatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis...

    java思维导图
  • 工作量减半的开发神器,MyBatisPlus入门和部分源码讲解

        我们可以发现传统的MyBatis存在很致命的问题,每个实体表对应一个实体类,对应一个Mapper.java接口,对应一个Mapper.xml配置文件每个...

    XiaoLin_Java
  • mybatis-plus思维导图,让mybatis-plus不再难懂

     Mybatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果...

    java思维导图
  • SpringBoot mybatisplus

    spring boot约定优于配置的思想让我们的开发更加专注,mybatis plus让orm开发更加有效率。MyBatis-Plus(简称 MP)是一个 My...

    码哥字节
  • (一)初识Mybatis-Plus

    mybatis 在持久层框架中还是比较火的,使用也很方便。虽然mybatis可以直接在xml中通过SQL语句操作数据库,很是灵活。但正其操作都要通过SQL语句进...

    Java那些事儿
  • mybatis-plus源码分析之sql注入器

    mybatis-plus是完全基于mybatis开发的一个增强工具,它的设计理念是在mybatis的基础上只做增强不做改变,为简化开发、提高效率而生,它在myb...

    张乘辉
  • 小书MybatisPlus第3篇-自定义SQL

    书接上回,虽然Mybatis Plus帮我们提供了大量的默认方法,但我们为了实现多表关联查询,或者根据不同的查询条件传参,实现不同的动态SQL。在这种情况下我们...

    字母哥博客
  • Mybatis从浅入深-Plus(IDEA版通俗易懂)

    引入: 大家之前都学过面向对象编程,也学习过接口,但在真正的开发中,很多时候我们会选择面向接口编程

    Java程序猿阿谷
  • 肝九千字长文 | MyBatis-Plus 码之重器 lambda 表达式使用指南,开发效率瞬间提升80%

    现在越来越流行基于 SpringBoot 开发 Web 应用,其中利用 Mybatis 作为数据库 CRUD 操作已成为主流。楼主以 MySQL 为例,总结了九...

    猿芯
  • mybatis-plus源码分析之sql注入器

    mybatis-plus是完全基于mybatis开发的一个增强工具,它的设计理念是在mybatis的基础上只做增强不做改变,为简化开发、提高效率而生,它在myb...

    张乘辉
  • SpringBoot + Mybatis系列之插件机制 Interceptor

    在 Mybatis 中,插件机制提供了非常强大的扩展能力,在 sql 最终执行之前,提供了四个拦截点,支持不同场景的功能扩展

    一灰灰blog
  • 推荐一款 MyBatis 开发神器,为简化而生!

    愿景就是成为 MyBatis 最好的搭档,就像魂斗罗中的 1P、2P,基友搭配,效率翻倍。

    Java技术栈
  • 提高开发效率的mybatis-plus

    mybatis-plus也是我在项目中发现的一个好用的框架,可能知道的人不多,所以很少看到关于它的介绍。正如官方介绍的:“我们的愿景是成为MyBatis最好的搭...

    Java艺术
  • 芋道 Spring Boot MyBatis 入门(三)之 MyBatis-Plus

    关于 MyBatis-Plus 的介绍,直接到 https://mybatis.plus/ 官网,艿艿就不多哔哔,嘿嘿。

    芋道源码
  • 芋道 Spring Boot 分库分表入门

    因为市面上已经非常不错的分库分表的资料,所以艿艿就不在尴尬的瞎哔哔一些内容。推荐阅读两个资料:

    芋道源码
  • ThreadLocal的原理解析以及应用场景分析

    JDK对ThreadLocal的定义如下:TheadLocal提供了线程内部的局部变量:每个线程都有自己的独立的副本;ThreadLocal实例通常是类中的pr...

    码农飞哥
  • Spring Boot集成Mybatis-Plus多租户架构实战

    目前公司产品就是对外企业服务,入职后了解到SaaS模式和私有部署,当我第一次听到SaaS时,我不是很理解。经过查阅资料,以及在后续研发功能时,不断的加深了对多租...

    小东啊
  • 小议mybatis plus相比传统mybatis手写SQL的好处

    1、 发送通知需求:某一特定类别的商品,购买成功后需要发送通知给下单的客户,下单后默认通知状态为未发送,发送成功标记已发送。

    宜信技术学院
  • 干掉 XML Mapper,新出的 Fluent Mybatis 真香!

    使用FluentMybatis可以不用写具体的xml文件,通过java api可以构造出比较复杂的业务sql语句,做到代码逻辑和sql逻辑的合一。不再需要在Da...

    搜云库技术团队

扫码关注云+社区

领取腾讯云代金券