MybatisPlus

Java JavaWeb
Java
发布日期:   2022-05-01
更新日期:   2022-05-17
文章字数:   2.8k
阅读时长:   12 分

MyBatisPlus简介

MyBatisPlus（简称MP）是基于MyBatis框架基础上开发的增强型工具，旨在简化开发、提高效率

入门案例

SpringBoot整合MyBatisPlus

  1. 创建Spring项目
  2. 手动添加MyBatisPlus起步依赖
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.16</version>
</dependency>

由于mp并未被收录到idea的系统内置配置，无法直接选择加入

  1. 创建数据库以及实体类

    数据库自定义id，我写了这几个属性name，password，age，tel。

  2. 设置JDBC参数在application.yml配置文件（与Mybatis一致）

  3. 定义数据接口，继承BaseMapper

    public interface UserDao extends BaseMapper<User> {
}

  4. 测试类中注入dao接口，测试功能

    @SpringBootTest
public class Mybatisplus01QuickstartApplicationTests {

    @Autowired
    private UserDao userDao;

    @Test
    void testGetAll() {
        List<User> userList = userDao.selectList(null);
        System.out.println(userList);
    }
}

MyBatisPlus概述

MyBatisPlus特性

  • 无侵入：只做增强不做改变，不会对现有工程产生影响
  • 强大的 CRUD 操作：内置通用 Mapper，少量配置即可实现单表CRUD 操作
  • 支持 Lambda：编写查询条件无需担心字段写错
  • 支持主键自动生成
  • 内置分页插件

标准数据层开发

MP的CRUD操作

代码样例

@SpringBootTest
class Mybatisplus01QuickstartApplicationTests {

    @Autowired
    private UserDao userDao;

    @Test
    void testSave() {
        User user = new User();
        user.setName("小小星仔");
        user.setPassword("yanggg");
        user.setAge(12);
        user.setTel("400823823");
        userDao.insert(user);
    }

    @Test
    void testDelete() {
        userDao.deleteById(1234567);
    }

    @Test
    void testUpdate() {
        User user = new User();
        user.setId(1L);
        user.setName("Tomcc");
        user.setPassword("tomcc");
        userDao.updateById(user);
    }

    @Test
    void testGetById() {
        User user = userDao.selectById(2L);
        System.out.println(user);
    }


    @Test
    void testGetAll() {
        List<User> userList = userDao.selectList(null);
        System.out.println(userList);
    }
}

Lombok插件介绍

Lombok，一个Java类库，提供了一组注解，简化POJO实体类开发。可以自动生成实体类的GET、SET方法。

  • 常用注解：**@Data**，为当前实体类在编译期设置对应的get/set方法，无参/无参构造方法，toString方法，hashCode方法，equals方法等

MyBatisPlus分页功能

分页作用

设置分页拦截器作为Spring管理的bean

@Configuration
public class MybatisPlusConfig {
    
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        //1 创建MybatisPlusInterceptor拦截器对象
        MybatisPlusInterceptor mpInterceptor=new MybatisPlusInterceptor();
        //2 添加分页拦截器
        mpInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return mpInterceptor;
    }
}

执行分页查询

@Test
void testSelectPage(){
    //1 创建IPage分页对象,设置分页参数
    IPage<User> page=new Page<>(1,3);
    //2 执行分页查询
    userDao.selectPage(page,null);
    //3 获取分页结果
    System.out.println("当前页码值："+page.getCurrent());
    System.out.println("每页显示数："+page.getSize());
    System.out.println("总页数："+page.getPages());
    System.out.println("总条数："+page.getTotal());
    System.out.println("当前页数据："+page.getRecords());
}

开启MyBatisPlus日志

在application.yml开启日志

# 开启mp的日志（输出到控制台）
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    banner: off # 关闭mybatisplus启动图标
spring:
  main:
    banner-mode: off # 关闭SpringBoot启动图标(banner)

如果显示日志内容过多，在resources下新建一个logback.xml文件，名称固定，内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

</configuration>

具体配置可以参考网络。

DQL编程控制

主要是数据库查询控制

条件查询方式

MyBatisPlus将书写复杂的SQL查询条件进行了封装，使用编程的形式完成查询条件的组合。

按条件查询

QueryWrapper<User> qw=new QueryWrapper<>();
qw.lt("age", 18);
List<User> userList = userDao.selectList(qw);
System.out.println(userList);

lambda格式按条件查询

QueryWrapper<User> qw = new QueryWrapper<User>();
qw.lambda().lt(User::getAge, 10);
List<User> userList = userDao.selectList(qw);
System.out.println(userList);

lambda格式按条件查询（推荐）

LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.lt(User::getAge, 10);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

组合条件

并且关系（and）

//并且关系
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//并且关系：10到30岁之间
lqw.lt(User::getAge, 30).gt(User::getAge, 10);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

或者关系（or）

//或者关系
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//或者关系：小于10岁或者大于30岁
lqw.lt(User::getAge, 10).or().gt(User::getAge, 30);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

NULL值处理

搜索场景，在多条件查询中，有条件的值为空应该怎么解决？

if语句控制条件追加

Integer minAge=10;  //将来有用户传递进来,此处简化成直接定义变量了
Integer maxAge=null;  //将来有用户传递进来,此处简化成直接定义变量了
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
if(minAge!=null){
    lqw.gt(User::getAge, minAge);
}
if(maxAge!=null){
    lqw.lt(User::getAge, maxAge);
}
List<User> userList = userDao.selectList(lqw);
userList.forEach(System.out::println);

条件参数控制

Integer minAge=10;  //将来有用户传递进来,此处简化成直接定义变量了
Integer maxAge=null;  //将来有用户传递进来,此处简化成直接定义变量了
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//参数1：如果表达式为true，那么查询才使用该条件
lqw.gt(minAge!=null,User::getAge, minAge);
lqw.lt(maxAge!=null,User::getAge, maxAge);
List<User> userList = userDao.selectList(lqw);
userList.forEach(System.out::println);

条件参数控制（链式编程）

Integer minAge=10;  //将来有用户传递进来,此处简化成直接定义变量了
Integer maxAge=null;  //将来有用户传递进来,此处简化成直接定义变量了
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//参数1：如果表达式为true，那么查询才使用该条件
lqw.gt(minAge!=null,User::getAge, minAge)
   .lt(maxAge!=null,User::getAge, maxAge);
List<User> userList = userDao.selectList(lqw);
userList.forEach(System.out::println);

查询投影-设置【查询字段、分组、分页】

查询结果包含模型类中部分属性

LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
lqw.select(User::getId, User::getName, User::getAge);
//或者
QueryWrapper<User> lqw = new QueryWrapper<User>();
lqw.select("id", "name", "age", "tel");
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);

查询结果包含模型类中未定义的属性

QueryWrapper<User> lqw = new QueryWrapper<User>();
lqw.select("count(*) as count, tel");
lqw.groupBy("tel");
List<Map<String, Object>> userList = userDao.selectMaps(lqw);
System.out.println(userList);

查询条件设定

多条件查询有哪些组合？

  • 范围匹配（> 、 = 、between）
  • 模糊匹配（like）
  • 空判定（null）
  • 包含性匹配（in）
  • 分组（group）
  • 排序（order）

查询条件

  • 用户登录（eq匹配）
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//等同于=
lqw.eq(User::getName, "Jerry").eq(User::getPassword, "jerry");
User loginUser = userDao.selectOne(lqw);
System.out.println(loginUser);
  • 购物设定价格区间、户籍设定年龄区间（le ge匹配 或 between匹配）
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//范围查询 lt le gt ge eq between
lqw.between(User::getAge, 10, 30);
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
  • 查信息，搜索新闻（非全文检索版：like匹配）
LambdaQueryWrapper<User> lqw = new LambdaQueryWrapper<User>();
//模糊匹配 like
lqw.likeLeft(User::getName, "J");
List<User> userList = userDao.selectList(lqw);
System.out.println(userList);
  • 统计报表（分组查询聚合函数）
QueryWrapper<User> qw = new QueryWrapper<User>();
qw.select("gender","count(*) as nums");
qw.groupBy("gender");
List<Map<String, Object>> maps = userDao.selectMaps(qw);
System.out.println(maps);

字段映射与表名映射

解决表的字段和实体类的属性不对应的策略。

  1. 表字段与编码属性设计不同步

在模型类属性上方，使用**@TableField属性注解，通过value**属性，设置当前属性对应的数据库表中的字段关系。

  1. 编码中添加了数据库中未定义的属性

    在模型类属性上方，使用**@TableField注解，通过exist**属性，设置属性在数据库表字段中是否存在，默认为true。此属性无法与value合并使用。

  2. 采用默认查询开放了更多的字段查看权限

    在模型类属性上方，使用**@TableField注解，通过select**属性：设置该属性是否参与查询。此属性与select()映射配置不冲突。

  3. 表名与编码开发设计不同步

    在模型类上方，使用**@TableName注解，通过value**属性，设置当前类对应的数据库表名称。

代码样例：

@Data
@TableName("tbl_user")
public class User {
    /*
        id为Long类型，因为数据库中id为bigint类型，
        并且mybatis有自己的一套id生成方案，生成出来的id必须是Long类型
     */
    private Long id;
    private String name;
    @TableField(value = "pwd",select = false)
    private String password;
    private Integer age;
    private String tel;
    @TableField(exist = false) //表示online字段不参与CRUD操作
    private Boolean online;
}

DML编程控制

数据库操作控制

id生成策略控制（Insert）

主键生成策略

  • 日志：自增（1,2,3,4，……）
  • 购物订单：特殊规则（FQ23948AK3843）
  • 外卖单：关联地区日期等信息（10 04 20200314 34 91）
  • 关系表：可省略id

id生成策略控制(Table注解)

  • 名称：@TableId

  • 类型：属性注解

  • 位置：模型类中用于表示主键的属性定义上方

  • 作用：设置当前类中主键属性的生成策略

  • 相关属性

    ​ type：设置主键属性的生成策略，值参照IdType枚举值

全局策略配置

mybatis-plus:
  global-config:
    db-config:
      id-type: assign_id
      table-prefix: tbl_

表名前缀配置，id是雪花生成算法

多记录操作（批量Delete/Select）

按照主键删除多条记录

//删除指定多条数据
List<Long> list = new ArrayList<>();
list.add(1402551342481838081L);
list.add(1402553134049501186L);
list.add(1402553619611430913L);

userDao.deleteBatchIds(list);

根据主键查询多条记录

//查询指定多条数据
List<Long> list = new ArrayList<>();
list.add(1L);
list.add(3L);
list.add(4L);
userDao.selectBatchIds(list);

逻辑删除（Delete/Update）

逻辑删除：为数据设置是否可用状态字段，删除时设置状态字段为不可用状态，数据保留在数据库中

逻辑删除本质：逻辑删除的本质其实是修改操作。如果加了逻辑删除字段，查询数据时也会自动带上逻辑删除字段

代码示例：

@Data
public class User {

    private Long id;
    
    //逻辑删除字段，标记当前记录是否被删除
    @TableLogic
    private Integer deleted;
    
}
mybatis-plus:
  global-config:
    db-config:
      table-prefix: tbl_
      # 逻辑删除字段名
      logic-delete-field: deleted
      # 逻辑删除字面值：未删除为0
      logic-not-delete-value: 0
      # 逻辑删除字面值：删除为1
      logic-delete-value: 1

乐观锁（UPDATE）

乐观锁：在操作数据时非常乐观，认为别人不会同时修改数据。因此乐观锁不会上锁，只是在执行更新的时候判断一下在此期间别人是否修改了数据：如果别人修改了数据则放弃操作，否则执行操作。

案例：

  1. 数据库表中添加锁标记字段（version）

  2. 实体类中添加对应字段，并设定当前字段为逻辑删除标记字段

    @Data
public class User {

	private Long id;
	
    @Version
    private Integer version;
}

  3. 配置乐观锁拦截器实现锁机制对应的动态SQL语句拼装

    @Configuration
public class MpConfig {
    @Bean
    public MybatisPlusInterceptor mpInterceptor() {
        //1.定义Mp拦截器
        MybatisPlusInterceptor mpInterceptor = new MybatisPlusInterceptor();

        //2.添加乐观锁拦截器
        mpInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        
        return mpInterceptor;
    }
}

  4. 使用乐观锁机制在修改前必须先获取到对应数据的verion方可正常进行

    @Test
public void testUpdate() {
    
    //1.先通过要修改的数据id将当前数据查询出来
    User user = userDao.selectById(3L);     //version=3
    User user2 = userDao.selectById(3L);    //version=3
    user2.setName("Jock aaa");
    userDao.updateById(user2);              //version=>4
    user.setName("Jock bbb");
    userDao.updateById(user);               //verion=3?条件还成立吗？
}
文章作者: 小小星仔
文章链接: https://deades-coder.github.io/2022/05/01/mybatis-plus/
版权声明: 本博客所有文章除特別声明外，均采用 CC BY 4.0 许可协议。转载请注明来源 小小星仔 !
Java JavaWeb
评论
  目录