简介

MyBatis-Plus 是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。它提供了很多实用的功能,使得开发者在使用 MyBatis 时能够更加方便和高效。

特点

  • 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
  • 损耗小:启动即会自动注入基本 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 操作智能分析阻断,也可自定义拦截规则,预防误操作

注解

  • @TableName: 指定表名及全局配置

  • @TableId:指定Id字段及相关配置

    IdType的类型:

    (1)AUTO:自增长,由数据库生成id

    (2) ASSIGN_ID:通过雪花算法,由mp生成id

    (3)INPUT:通过用户输入id

  • @TableFiled:指定普通字段及相关配置

    使用场景

    • 成员变量与数据库名称不一致
    • 成员变量以is开头,且是布尔值
    • 成员变量与数据库关键词冲突
    • 成员变量不是数据库字段

配置

1
2
3
4
5
6
7
8
9
10
11
12
mybatis-plus:
type-aliases-package: #别名扫描包
mapper-locations: "classpath*:/mapper/**/*.xml" #mapper.xml文件地址
configuration:
#在映射实体或者属性时,将数据库中表名和字段名中的下划线去掉,按照驼峰命名法映射
map-underscore-to-camel-case: true
cache-enabled: false #是否开启二级缓存
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
db-config:
id-type: ASSIGN_ID #id为雪花算法生成
update-strategy: not_null #更新策略:只更新非空字段

条件构造器用法

  • QueryWrapper和LambdaQueryWrapper通常用来构建select,delete,update的where条件部分
  • UpdateWrapper和LambdaUpdateWrapper通常只有在set语句比较特殊时才使用
  • 尽量使用LambdaQueryWrapper和LambdaUpdateWrapper,避免硬编码(例User::getId)

自定义sql

由于mp擅长的事where条件的编写,但不擅长select,set等处的编写,此时若在构造器处去拼相应的代码,那么就需要在业务层去构建sql语句,这显然不符合大多数企业的开发规范,此时则需要自定义sql

  • 基于Wrapper构建Where条件

    1
    2
    3
    4
    5
    6
    List<long> ids = List.of(1L,2L,4L);
    int amount = 200;
    //构建条件
    LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<User>().in(User::getId,ids);
    //自定义sql方法调用
    usermapper.updateBalanceByIds(wrapper,amount);
  • 在mapper方法参数中用param注解声明wrapper变量名称,必须是ew

    1
    2
    @Update("update tb_user set balance = balance-#{amount} ${ew.customSqlSegment}")
    void updateBalanceByIds(@param("ew") LambdaQueryWrapper<User> wrapper,@param("amount") int amount);

MP的Service接口使用

  • 自定义Service接口继承IService接口

    1
    public interface UserService extends IService<User>{}
  • 自定义service实现类,实现自定义接口并继承ServiceImpl类

    1
    public class UserServiceImpl extends ServiceImpl<UserMapper,User> implements UserService{}

逻辑删除

在实际业务中,用户删除的一些数据并不是真的删除了,而是采用逻辑删除,例如,用户将购物车中的商品取消,但此时并不是真的删除了这一条数据,因为这些数据对于后期的数据统计非常重要,所以实际开发中,通常会使用一个标记来确定此商品是否真的被删除

MP提供了逻辑删除的功能,无需改变方法调用的方式,而是在底层自动帮我们修改CRUD语句,我们要做的就是在yml文件中配置逻辑删除的字段名称和值即可

1
2
3
4
5
6
mybatis-plus:
global-config:
db-config:
logic-delete-filed: deleted #全局删除的实体字段名,字段类型可以是boolean,integer
logic-delete-value: 1 #逻辑已删除值(默认为1)
logic-not-delete-value: 0 #逻辑未删除值(默认为0)

注意

逻辑删除的问题

  • 会导致数据库表垃圾数据越来越多,影响查询效率
  • SQL中全部需要对逻辑字段做判断,影响查询效率

因此,如果数据不能删除,可以采用将数据迁移到其他表的方法