MyBatis-Plus 基础入门教程（三）

如下教程学习自尚硅谷杨博超老师的MyBatis-Plus教程

条件构造器

1.Wrapper介绍

• Wrapper： 条件构造抽象类，最顶端父类

  • AbstractWrapper： 用于查询条件封装，生成 sql 的 where 条件

    • QueryWrapper： 查询条件封装

    • UpdateWrapper： Update 条件封装

    • AbstractLambdaWrapper： 使用Lambda 语法

      • LambdaQueryWrapper：用于Lambda语法使用的查询Wrapper

      • LambdaUpdateWrapper： Lambda 更新封装Wrapper

2.QueryWrapper

• 组装查询条件

  执行SQL：SELECT uid AS id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (username LIKE ? AND age BETWEEN ? AND ? AND email IS NOT NULL)

  1 2 3 4 5 6 7

  public void test01(){ //查询用户名包含a，年龄在20到30之间，邮箱信息不为null的用户信息 QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.like("username","a").between("age",20,30).isNotNull("email"); List<User> users = userMapper.selectList(queryWrapper); users.forEach(System.out::println); }

• 组装排序条件

  执行SQL：SELECT uid AS id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 ORDER BY age DESC,id ASC

  1 2 3 4 5 6 7

  public void test02(){ //查询用户信息，按照年龄的降序排序，若年龄相同，则按照id升序排序 QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.orderByDesc("age").orderByAsc("id"); List<User> users = userMapper.selectList(queryWrapper); users.forEach(System.out::println); }

• 组装删除条件

  执行SQL：UPDATE t_user SET is_deleted=1 WHERE is_deleted=0 AND (email IS NULL)

  1 2 3 4 5 6 7 8

  public void test03(){ //删除邮箱地址为null的用户信息 QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.isNull("email"); int result = userMapper.delete(queryWrapper); System.out.println(result > 0 ? "删除成功！" : "删除失败！"); System.out.println("受影响的行数为：" + result); }

• 条件的优先级

  执行SQL：UPDATE t_user SET user_name=?, email=? WHERE is_deleted=0 AND (age > ? AND user_name LIKE ? OR email IS NULL)

  1 2 3 4 5 6 7 8 9 10 11 12

  public void test04(){ //将（年龄大于20并且用户名中包含有a）或邮箱为null的用户信息修改 UpdateWrapper<User> updateWrapper = new UpdateWrapper<>(); updateWrapper.gt("age",20).like("username","a").or().isNull("email"); User user = new User(); user.setName("Oz"); user.setEmail("test@oz6.com"); int result = userMapper.update(user, updateWrapper); System.out.println(result > 0 ? "修改成功！" : "修改失败！"); System.out.println("受影响的行数为：" + result); }

  执行SQL：UPDATE t_user SET username=?, email=? WHERE is_deleted=0 AND (username LIKE ? AND (age > ? OR email IS NULL))

  1 2 3 4 5 6 7 8 9 10 11 12

  public void test05(){ //将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改 UpdateWrapper<User> updateWrapper = new UpdateWrapper<>(); updateWrapper.like("username","a").and(i->i.gt("age",20).or().isNull("email")); User user = new User(); user.setName("Vz7797"); user.setEmail("test@ss8o.com"); int result = userMapper.update(user, updateWrapper); System.out.println(result > 0 ? "修改成功！" : "修改失败！"); System.out.println("受影响的行数为：" + result); }

• 组装select子句

  执行SQL：SELECT username,age,email FROM t_user WHERE is_deleted=0

  1 2 3 4 5 6 7

  public void test06(){ //查询用户的用户名、年龄、邮箱信息 QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.select("username","age","email"); List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper); maps.forEach(System.out::println); }

• 实现子查询

  执行SQL：SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (uid IN (select uid from t_user where uid <= 100))

  1 2 3 4 5 6 7

  public void test07(){ //查询id小于等于100的用户信息 QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.inSql("uid", "select uid from t_user where uid <= 100"); List<User> list = userMapper.selectList(queryWrapper); list.forEach(System.out::println); }

3.UpdateWrapper

UpdateWrapper不仅拥有QueryWrapper的组装条件功能，还提供了set方法进行修改对应条件的数据库信息

1
2
3
4
5
6
7
8

public void test08(){
    //将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改
    UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
    updateWrapper.like("username","a").and( i -> i.gt("age",20).or().isNull("email")).set("email","svip@qq.com");
    int result = userMapper.update(null, updateWrapper);
    System.out.println(result > 0 ? "修改成功！" : "修改失败！");
    System.out.println("受影响的行数为：" + result);
}

4.condition

在真正开发的过程中，组装条件是常见的功能，而这些条件数据来源于用户输入，是可选的，因此我们在组装这些条件时，必须先判断用户是否选择了这些条件，若选择则需要组装该条件，若没有选择则一定不能组装，以免影响SQL执行的结果

• 思路一

  执行SQL：SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 AND (user_name LIKE ? AND age <= ?)

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

  public void test09(){ String username = "a"; Integer ageBegin = null; Integer ageEnd = 30; QueryWrapper<User> queryWrapper = new QueryWrapper<>(); if(StringUtils.isNotBlank(username)){ //isNotBlank判断某个字符创是否不为空字符串、不为null、不为空白符 queryWrapper.like("user_name", username); } if(ageBegin != null){ queryWrapper.ge("age", ageBegin); } if(ageEnd != null){ queryWrapper.le("age", ageEnd); } List<User> list = userMapper.selectList(queryWrapper); list.forEach(System.out::println); }

• 思路二

  上面的实现方案没有问题，但是代码比较复杂，我们可以使用带condition参数的重载方法构建查询条件，简化代码的编写

  1 2 3 4 5 6 7 8 9 10 11

  public void test10(){ String username = "a"; Integer ageBegin = null; Integer ageEnd = 30; QueryWrapper<User> queryWrapper = new QueryWrapper<>(); queryWrapper.like(StringUtils.isNotBlank(username), "user_name", username) .ge(ageBegin != null, "age", ageBegin) .le(ageEnd != null, "age", ageEnd); List<User> list = userMapper.selectList(queryWrapper); list.forEach(System.out::println); }

5.LambdaQueryWrapper

功能等同于QueryWrapper，提供了Lambda表达式的语法可以避免填错列名。

1
2
3
4
5
6
7
8
9
10
11

public void test11(){
    String username = "a";
    Integer ageBegin = null;
    Integer ageEnd = 30;
    LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
    queryWrapper.like(StringUtils.isNotBlank(username), User::getName, username)
        .ge(ageBegin != null, User::getAge, ageBegin)
        .le(ageEnd != null, User::getAge, ageEnd);
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

6.LambdaUpdateWrapper

功能等同于UpdateWrapper，提供了Lambda表达式的语法可以避免填错列名。

1
2
3
4
5
6
7
8
9

public void test12(){
    //将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改
    LambdaUpdateWrapper<User> updateWrapper = new LambdaUpdateWrapper<>();
    updateWrapper.like(User::getName, "a")
        .and(i -> i.gt(User::getAge, 20).or().isNull(User::getEmail));
    updateWrapper.set(User::getName, "小黑").set(User::getEmail,"abc@atguigu.com");
    int result = userMapper.update(null, updateWrapper);
    System.out.println("result："+result);
}

常用插件

1.分页插件

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能

• 添加配置类MyBatisPlusConfig

  1 2 3 4 5 6 7 8 9 10 11

  @Configuration @MapperScan("com.atguigu.mybatisplus.mapper") public class MyBatisPlusConfig { @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){ MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); //添加分页插件 interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); return interceptor; } }

• 编写测试方法

  1 2 3 4 5 6 7

  @Test public void testPage(){ //new Page()中的两个参数分别是当前页码，每页显示数量 Page<User> page = userMapper.selectPage(new Page<>(1, 2), null); List<User> users = page.getRecords(); users.forEach(System.out::println); }

2.自定义分页

上面调用的是MyBatis-Plus提供的带有分页的方法，那么我们自己定义的方法如何实现分页呢？

• 在UserMapper接口中定义一个方法

  1 2 3 4 5 6 7

  /** * 根据年龄查询用户列表，分页显示 * @param page 分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页,必须放在第一位 * @param age 年龄 * @return */ Page<User> selectPageVo(@Param("page") Page<User> page,@Param("age") Integer age);

• 在UserMapper.xml中编写SQL实现该方法

  1 2 3

  <select id="selectPageVo" resultType="User"> select id,username as name,age,email from t_user where age > #{age} </select>

• 编写测试方法

  1 2 3 4 5 6

  @Test public void testPageVo(){ Page<User> page = userMapper.selectPageVo(new Page<User>(1,2), 20); List<User> users = page.getRecords(); users.forEach(System.out::println); }

3.乐观锁

作用：当要更新一条记录的时候，希望这条记录没有被别人更新

乐观锁的实现方式：

• 取出记录时，获取当前 version
• 更新时，带上这个 version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果 version 不对，就更新失败

3.1 场景

• 一件商品，成本价是80元，售价是100元。老板先是通知小李，说你去把商品价格增加50元。小李正在玩游戏，耽搁了一个小时。正好一个小时后，老板觉得商品价格增加到150元，价格太高，可能会影响销量。又通知小王，你把商品价格降低30元。
• 此时，小李和小王同时操作商品后台系统。小李操作的时候，系统先取出商品价格100元；小王也在操作，取出的商品价格也是100元。小李将价格加了50元，并将100+50=150元存入了数据库；小王将商品减了30元，并将100-30=70元存入了数据库。是的，如果没有锁，小李的操作就完全被小王的覆盖了。
• 现在商品价格是70元，比成本价低10元。几分钟后，这个商品很快出售了1千多件商品，老板亏1万多。

3.2 乐观锁与悲观锁

• 上面的故事，如果是乐观锁，小王保存价格前，会检查下价格是否被人修改过了。如果被修改过了，则重新取出的被修改后的价格，150元，这样他会将120元存入数据库。
• 如果是悲观锁，小李取出数据后，小王只能等小李操作完之后，才能对价格进行操作，也会保证最终的价格是120元。

3.3 模拟修改冲突

• 数据库中增加商品表

  1 2 3 4 5 6 7

  CREATE TABLE t_product ( id BIGINT(20) NOT NULL COMMENT '主键ID', NAME VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称', price INT(11) DEFAULT 0 COMMENT '价格', VERSION INT(11) DEFAULT 0 COMMENT '乐观锁版本号', PRIMARY KEY (id) );

• 添加一条数据

  1	INSERT INTO t_product (id, NAME, price) VALUES (1, '外星人笔记本', 100);

• 添加一个实体类Product

  1 2 3 4 5 6 7

  @Data public class Product { private Long id; private String name; private Integer price; private Integer version; }

• 添加一个Mapper接口ProductMapper

  1	public interface ProductMapper extends BaseMapper<Product> {}

• 测试方法

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

  @Test public void testProduct01(){ //1.小李获取商品价格 Product productLi = productMapper.selectById(1); System.out.println("小李获取的商品价格为：" + productLi.getPrice()); //2.小王获取商品价格 Product productWang = productMapper.selectById(1); System.out.println("小李获取的商品价格为：" + productWang.getPrice()); //3.小李修改商品价格+50 productLi.setPrice(productLi.getPrice()+50); productMapper.updateById(productLi); //4.小王修改商品价格-30 productWang.setPrice(productWang.getPrice()-30); productMapper.updateById(productWang); //5.老板查询商品价格 Product productBoss = productMapper.selectById(1); System.out.println("老板获取的商品价格为：" + productBoss.getPrice()); }

• 执行结果

  

3.4 乐观锁解决问题

• 实体类version字段添加注解@Version

  1 2 3 4 5 6 7 8

  @Data public class Product { private Long id; private String name; private Integer price; @Version private Integer version; }

• 添加乐观锁插件配置

  1 2 3 4 5 6 7 8 9

  @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){ MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor(); //添加分页插件 interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL)); //添加乐观锁插件 interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return interceptor; }

• 再次执行测试方法

  小李查询商品信息：

  ​ SELECT id,name,price,version FROM t_product WHERE id=?

  小王查询商品信息：

  ​ SELECT id,name,price,version FROM t_product WHERE id=?

  小李修改商品价格，自动将version+1

  ​ UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?

  ​ Parameters: 外星人笔记本(String), 150(Integer), 1(Integer), 1(Long), 0(Integer)

  小王修改商品价格，此时version已更新，条件不成立，修改失败

  ​ UPDATE t_product SET name=?, price=?, version=? WHERE id=? AND version=?

  ​ Parameters: 外星人笔记本(String), 70(Integer), 1(Integer), 1(Long), 0(Integer)

  最终，小王修改失败，查询价格：150

  ​ SELECT id,name,price,version FROM t_product WHERE id=?

• 优化执行流程

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

  @Test public void testProduct01(){ //1.小李获取商品价格 Product productLi = productMapper.selectById(1); System.out.println("小李获取的商品价格为：" + productLi.getPrice()); //2.小王获取商品价格 Product productWang = productMapper.selectById(1); System.out.println("小李获取的商品价格为：" + productWang.getPrice()); //3.小李修改商品价格+50 productLi.setPrice(productLi.getPrice()+50); productMapper.updateById(productLi); //4.小王修改商品价格-30 productWang.setPrice(productWang.getPrice()-30); int result = productMapper.updateById(productWang); if(result == 0){ //操作失败，重试 Product productNew = productMapper.selectById(1); productNew.setPrice(productNew.getPrice()-30); productMapper.updateById(productNew); } //5.老板查询商品价格 Product productBoss = productMapper.selectById(1); System.out.println("老板获取的商品价格为：" + productBoss.getPrice()); }

  

通用枚举

表中的有些字段值是固定的，例如性别（男或女），此时我们可以使用MyBatis-Plus的通用枚举来实现

• 数据库表添加字段sex

  

• 创建通用枚举类型

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  @Getter public enum SexEnum { MALE(1, "男"), FEMALE(2, "女"); @EnumValue //将注解所标识的属性的值存储到数据库中 private int sex; private String sexName; SexEnum(Integer sex, String sexName) { this.sex = sex; this.sexName = sexName; } }

• User实体类中添加属性sex

  1 2 3 4 5 6 7 8 9 10 11 12

  public class User { private Long id; @TableField("username") private String name; private Integer age; private String email; @TableLogic private int isDeleted; //逻辑删除 private SexEnum sex; }

• 配置扫描通用枚举

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

  #MyBatis-Plus相关配置 mybatis-plus: #指定mapper文件所在的地址 mapper-locations: classpath:mapper/*.xml configuration: #配置日志 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl global-config: banner: off db-config: #配置mp的主键策略为自增 id-type: auto # 设置实体类所对应的表的统一前缀 table-prefix: t_ #配置类型别名所对应的包 type-aliases-package: com.atguigu.mybatisplus.pojo # 扫描通用枚举的包 type-enums-package: com.atguigu.mybatisplus.enums

• 执行测试方法

  1 2 3 4 5 6 7 8 9

  @Test public void test(){ User user = new User(); user.setName("admin"); user.setAge(33); user.setSex(SexEnum.MALE); int result = userMapper.insert(user); System.out.println("result:"+result); }

多数据源

适用于多种场景：纯粹多库、 读写分离、 一主多从、 混合模式等

场景说明：

我们创建两个库，分别为：mybatis_plus（以前的库不动）与mybatis_plus_1（新建），将mybatis_plus库的product表移动到mybatis_plus_1库，这样每个库一张表，通过一个测试用例分别获取用户数据与商品数据，如果获取到说明多库模拟成功

1.创建数据库及表

• 创建数据库mybatis_plus_1和表`product

  1 2 3 4 5 6 7 8 9

  CREATE DATABASE `mybatis_plus_1` /*!40100 DEFAULT CHARACTER SET utf8mb4 */; use `mybatis_plus_1`; CREATE TABLE product ( id BIGINT(20) NOT NULL COMMENT '主键ID', name VARCHAR(30) NULL DEFAULT NULL COMMENT '商品名称', price INT(11) DEFAULT 0 COMMENT '价格', version INT(11) DEFAULT 0 COMMENT '乐观锁版本号', PRIMARY KEY (id) );

• 添加测试数据

  1	INSERT INTO product (id, NAME, price) VALUES (1, '外星人笔记本', 100);

• 删除mybatis_plus库中的product表

  1 2	use mybatis_plus; DROP TABLE IF EXISTS product;

2.新建工程引入依赖

自行新建一个Spring Boot工程并选择MySQL驱动及Lombok依赖

引入MyBaits-Plus的依赖及多数据源的依赖

1
2
3
4
5
6
7
8
9
10
11

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version>
</dependency>

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>

3.编写配置文件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

spring:
  # 配置数据源信息
  datasource:
    dynamic:
      # 设置默认的数据源或者数据源组,默认值即为master
      primary: master
      # 严格匹配数据源,默认false.true未匹配到指定数据源时抛异常,false使用默认数据源
      strict: false
      datasource:
        master:
          url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
          driver-class-name: com.mysql.cj.jdbc.Driver
          username: root
          password: 132537
        slave_1:
          url: jdbc:mysql://localhost:3306/mybatis_plus_1?characterEncoding=utf-8&useSSL=false
          driver-class-name: com.mysql.cj.jdbc.Driver
          username: root
          password: 132537

4.创建实体类

• 新建一个User实体类（如果数据库表名有t_前缀记得配置）

  1 2 3 4 5 6 7

  @Data public class User { private Long id; private String name; private Integer age; private String email; }

• 新建一个实体类Product

  1 2 3 4 5 6 7

  @Data public class Product { private Long id; private String name; private Integer price; private Integer version; }

5.创建Mapper及Service

• 新建接口UserMapper

  1	public interface UserMapper extends BaseMapper<User> {}

• 新建接口ProductMapper

  1	public interface ProductMapper extends BaseMapper<Product> {}

• 新建Service接口UserService指定操作的数据源

  1 2	@DS("master") //指定操作的数据源，master为user表 public interface UserService extends IService<User> {}

• 新建Service接口ProductService指定操作的数据源

  1 2	@DS("slave_1") public interface ProductService extends IService<Product> {}

• 自行建立Service的实现类

  1

  ...

6.编写测试方法

记得在启动类中添加注解@MapperScan()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

class TestDatasourceApplicationTests {
	@Resource
	UserService userService;

	@Resource
	ProductService productService;

	@Test
	void contextLoads() {
		User user = userService.getById(1L);
		Product product = productService.getById(1L);
		System.out.println("User = " + user);
		System.out.println("Product = " + product);
	}

}

MyBatisX插件

MyBatis-Plus为我们提供了强大的mapper和service模板，能够大大的提高开发效率。

但是在真正开发过程中，MyBatis-Plus并不能为我们解决所有问题，例如一些复杂的SQL，多表联查，我们就需要自己去编写代码和SQL语句，我们该如何快速的解决这个问题呢，这个时候可以使用MyBatisX插件。

MyBatisX一款基于 IDEA 的快速开发插件，为效率而生。

1.安装MyBatisX插件

打开IDEA，File-> Setteings->Plugins->MyBatisX，搜索栏搜索MyBatisX然后安装。

2.快速生成代码

• 新建一个Spring Boot项目引入依赖（创建工程时记得勾选lombok及mysql驱动）

  1 2 3 4 5 6 7 8 9 10 11

  <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.1</version> </dependency> <dependency> <groupId>com.baomidou</groupId> <artifactId>dynamic-datasource-spring-boot-starter</artifactId> <version>3.5.0</version> </dependency>

• 配置数据源信息

  1 2 3 4 5 6 7

  spring: datasource: type: com.zaxxer.hikari.HikariDataSource driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false username: root password: 132537

• 在IDEA中与数据库建立链接

  

• 填写数据库信息并保存

  

• 找到我们需要生成的表点击右键

  

• 填写完信息以后下一步

  

• 继续填写信息

  

• 大功告成

  

3.快速生成CRUD

MyBaitsX可以根据我们在Mapper接口中输入的方法名快速帮我们生成对应的sql语句