[Java知识库]MyBatis-Plus

一、MyBatis-Plus 简介

MyBatis-Plus 是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

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

特性：

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

支持数据库：

任何能使用MyBatis进行 CRUD, 并且支持标准 SQL 的数据库，具体支持情况如下

• MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，Firebird，Cubrid，Goldilocks，csiidb
• 达梦数据库，虚谷数据库，人大金仓数据库，南大通用(华库)数据库，南大通用数据库，神通数据
  库，瀚高数据库

框架结构：

二、入门案例

① 开发环境

• IDE：idea 2021.2
• JDK：JDK8
• 构建工具：maven 3.5.4
• MySQL版本：MySQL 5.7
• Spring Boot：2.6.3
• MyBatis-Plus：3.5.1

② 创建数据库及表

创建表：

CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus`;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT '主键ID',
`name` varchar(30) DEFAULT NULL COMMENT '姓名',
`age` int(11) DEFAULT NULL COMMENT '年龄',
`email` varchar(50) DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

添加数据：

CREATE DATABASE `mybatis_plus` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
use `mybatis_plus`;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT '主键ID',
`name` varchar(30) DEFAULT NULL COMMENT '姓名',
`age` int(11) DEFAULT NULL COMMENT '年龄',
`email` varchar(50) DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

③ 引入依赖

<dependencies>
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter</artifactId>
   </dependency>
   <dependency>
       <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
   </dependency>
   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>3.5.1</version>
   </dependency>
   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <optional>true</optional>
   </dependency>
   <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <scope>runtime</scope>
   </dependency>
</dependencies>

④ 配置application.yml

在application.yml配置文件中添加MySQL数据库的相关配置：

spring:
  # 配置数据源信息
  datasource:
    # 配置数据源类型
    type: com.zaxxer.hikari.HikariDataSource
    # 配置连接数据库信息
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.182.150:3306/mybatis-plus?characterEncoding=utf-8&useSSL=false
    username: root
    password: root

1、驱动类driver-class-name

• spring boot 2.0（内置jdbc5驱动），驱动类使用：driver-class-name: com.mysql.jdbc.Driver
• spring boot 2.1及以上（内置jdbc8驱动），驱动类使用：driver-class-name: com.mysql.cj.jdbc.Driver

2、连接地址ur

• MySQL5.7版本的url：jdbc:mysql://localhost:3306/mybatis_plus?characterEncoding=utf-8&useSSL=false
• MySQL8.0版本的url：：jdbc:mysql://localhost:3306/mybatis_plusserverTimezone=GMT%2B8&characterEncoding=utf-8&useSSL=false

⑤ 启动类

在Spring Boot启动类中添加@MapperScan注解，扫描mapper包

@SpringBootApplication
@MapperScan("com.hucheng.mybatisplus.mapper")
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }

}

⑥ 添加实体

编写实体类User.java：

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

编写Mapper类UserMapper.java：

public interface UserMapper extends BaseMapper<User> {

}

⑦ 测试

@SpringBootTest
public class MybatisPlusTest {
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelectList() {
        //selectList()根据MP内置的条件构造器查询一个list集合，null表示没有条件，即查询所有
        userMapper.selectList(null).forEach(System.out::println);
    }
}

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。
为了避免报错，可以在mapper接口上添加 @Repository 注解

结果：

⑧ 添加日志

在application.yml中配置日志输出

# 配置MyBatis日
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

三、基本 CRUD

① BaseMapper

MyBatis-Plus中的基本CRUD在内置的BaseMapper中都已得到了实现，我们可以直接使用，接口如
下：

package com.baomidou.mybatisplus.core.mapper;

public interface BaseMapper<T> extends Mapper<T> {

	/**
    * 插入一条记录
    * @param entity 实体对象
    */
   int insert(T entity);

	/**
    * 根据 ID 删除
    * @param id 主键ID
    */
   int deleteById(Serializable id);


	/**
    * 根据实体(ID)删除
    * @param entity 实体对象
    * @since 3.4.4
    */
	int deleteById(T entity);

	/**
    * 根据 columnMap 条件，删除记录
    * @param columnMap 表字段 map 对象
    */
   int deleteByMap(@Param(Constants.COLUMN_MAP) Map<String, Object> columnMap);
   
	/**
    * 根据 entity 条件，删除记录
    * @param queryWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where
语句）
    */
   int delete(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

	 /**
    * 删除（根据ID 批量删除）
    * @param idList 主键ID列表(不能为 null 以及 empty)
    */
   int deleteBatchIds(@Param(Constants.COLLECTION) Collection<? extends
Serializable> idList);

	/**
    * 根据 ID 修改
    * @param entity 实体对象
    */
   int updateById(@Param(Constants.ENTITY) T entity);
   
	 /**
    * 根据 whereEntity 条件，更新记录
    * @param entity       实体对象 (set 条件值,可以为 null)
    * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成
where 语句）
    */
   int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER)
Wrapper<T> updateWrapper);


	/**
    * 根据 ID 查询
    * @param id 主键ID
    */
   T selectById(Serializable id);

	/**
    * 查询（根据ID 批量查询）
    * @param idList 主键ID列表(不能为 null 以及 empty)
    */
   List<T> selectBatchIds(@Param(Constants.COLLECTION) Collection<? extends
Serializable> idList);

	/**
    * 查询（根据 columnMap 条件）
    * @param columnMap 表字段 map 对象
    */
   List<T> selectByMap(@Param(Constants.COLUMN_MAP) Map<String, Object>
columnMap);

	/**
	* 根据 entity 条件，查询一条记录
    * 查询一条记录，例如 qw.last("limit 1") 限制取一条记录, 注意：多条数据会报异常
    * @param queryWrapper 实体对象封装操作类（可以为 null）
    */
   default T selectOne(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper) {
       List<T> ts = this.selectList(queryWrapper);
       if (CollectionUtils.isNotEmpty(ts)) {
           if (ts.size() != 1) {
               throw ExceptionUtils.mpe("One record is expected, but the query
result is multiple records");
          }
           return ts.get(0);
      }
       return null;
  }

	/**
    * 根据 Wrapper 条件，查询总记录数
    * @param queryWrapper 实体对象封装操作类（可以为 null）
    */
   Long selectCount(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
   
   /**
    * 根据 entity 条件，查询全部记录
    * @param queryWrapper 实体对象封装操作类（可以为 null）
    */
   List<T> selectList(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
   
   /**
    * 根据 Wrapper 条件，查询全部记录
    * @param queryWrapper 实体对象封装操作类（可以为 null）
    */
   List<Map<String, Object>> selectMaps(@Param(Constants.WRAPPER) Wrapper<T>
queryWrapper);

   /**
    * 根据 Wrapper 条件，查询全部记录
    * <p>注意： 只返回第一个字段的值</p>
    * @param queryWrapper 实体对象封装操作类（可以为 null）
    */
   List<Object> selectObjs(@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);
   
   /**
    * 根据 entity 条件，查询全部记录（并翻页）
    * @param page         分页查询条件（可以为 RowBounds.DEFAULT）
    * @param queryWrapper 实体对象封装操作类（可以为 null）
    */
   <P extends IPage<T>> P selectPage(P page, @Param(Constants.WRAPPER)
Wrapper<T> queryWrapper);


	/**
    * 根据 Wrapper 条件，查询全部记录（并翻页）
    * @param page         分页查询条件
    * @param queryWrapper 实体对象封装操作类
    */
   <P extends IPage<Map<String, Object>>> P selectMapsPage(P page,
@Param(Constants.WRAPPER) Wrapper<T> queryWrapper);

② 插入

@Test
public void testInsert(){
   User user = new User(null, "张三", 23, "zhangsan@atguigu.com");
   //INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
   int result = userMapper.insert(user);
   System.out.println("受影响行数："+result);
   //1475754982694199298
   System.out.println("id自动获取："+user.getId());

终执行的结果所获取的id为1475754982694199298，这是因为MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id

③ 删除

通过id删除记录：

@Test
public void testDeleteById(){
   //通过id删除用户信息
   //DELETE FROM user WHERE id=?
   int result = userMapper.deleteById(1475754982694199298L);
   System.out.println("受影响行数："+result);
}

通过id批量删除记录：

@Test
public void testDeleteBatchIds(){
   //通过多个id批量删除
   //DELETE FROM user WHERE id IN ( ? , ? , ? )
   List<Long> idList = Arrays.asList(1L, 2L, 3L);
   int result = userMapper.deleteBatchIds(idList);
   System.out.println("受影响行数："+result);
}

通过map条件删除记录：

@Test
public void testDeleteByMap(){
   //根据map集合中所设置的条件删除记录
   //DELETE FROM user WHERE name = ? AND age = ?
   Map<String, Object> map = new HashMap<>();
   map.put("age", 23);
   map.put("name", "张三");
   int result = userMapper.deleteByMap(map);
   System.out.println("受影响行数："+result);
}

④ 修改

@Test
public void testUpdateById(){
   User user = new User(4L, "admin", 22, null);
   //UPDATE user SET name=?, age=? WHERE id=?
   int result = userMapper.updateById(user);
   System.out.println("受影响行数："+result);
}

⑤ 查询

• 根据id查询用户信息

  @Test
  public void testSelectById(){
     //根据id查询用户信息
     //SELECT id,name,age,email FROM user WHERE id=?
     User user = userMapper.selectById(4L);
     System.out.println(user);
  }
  

• 根据多个id查询多个用户信息

  @Test
  public void testSelectBatchIds(){
     //根据多个id查询多个用户信息
     //SELECT id,name,age,email FROM user WHERE id IN ( ? , ? )
     List<Long> idList = Arrays.asList(4L, 5L);
     List<User> list = userMapper.selectBatchIds(idList);
     list.forEach(System.out::println)
  }
  

• 通过map条件查询用户信息

  @Test
  public void testSelectByMap(){
     //通过map条件查询用户信息
     //SELECT id,name,age,email FROM user WHERE name = ? AND age = ?
     Map<String, Object> map = new HashMap<>();
     map.put("age", 22);
     map.put("name", "admin");
     List<User> list = userMapper.selectByMap(map);
     list.forEach(System.out::println);
  }
  

• 查询所有数据

  @Test
  public void testSelectList(){
     //查询所有用户信息
     //SELECT id,name,age,email FROM user
     List<User> list = userMapper.selectList(null);
     list.forEach(System.out::println);
  }
  

通过观察BaseMapper中的方法，大多方法中都有Wrapper类型的形参，此为条件构造器，可针对于SQL语句设置不同的条件，若没有条件，则可以为该形参赋值null，即查询（删除/修改）所有数据

⑥ 自定义功能

和使用mybatis一样，在xml自定义功能即可。

⑦ 通用 Service

说明:

• 通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆
• 泛型 T 为任意实体对象
• 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承Mybatis-Plus 提供的基类

IService：MyBatis-Plus中有一个接口 IService和其实现类 ServiceImpl，封装了常见的业务层逻辑。详情查看源码IService和ServiceImpl

1、创建Service接口和实现类

/**
* UserService继承IService模板提供的基础功能
*/
public interface UserService extends IService<User> {
   
}

/**
* ServiceImpl实现了IService，提供了IService中基础功能的实现
* 若ServiceImpl无法满足业务需求，则可以使用自定的UserService定义方法，并在实现类中实现
*/
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements
UserService {
   
}

2、测试查询记录数

	@Autowired
	private UserService userService;
	
	@Test
	public void testGetCount(){
	   long count = userService.count();
	   System.out.println("总记录数：" + count);
	}

3、测试批量插入

    @Test
    public void testSaveBatch() {
        // SQL长度有限制，海量数据插入单条SQL无法实行，
        // 因此MP将批量插入放在了通用Service中实现，而不是通用Mapper
        List<User> users = new ArrayList<>();
        for (int i = 0; i < 5; i++) {
            User user = new User();
            user.setName("ybc" + i);
            user.setAge(20 + i);
            users.add(user);
        }
        userService.saveBatch(users);
    }

四、常用注解

4.1 @TableName

经过以上的测试，在使用 MyBatis-Plus 实现基本的 CRUD 时，我们并没有指定要操作的表，只是在
Mapper 接口继承 BaseMapper 时，设置了泛型 User ，而操作的表为 user 表。

由此得出结论，MyBatis-Plus 在确定操作的表时，由 BaseMapper 的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致。

若实体类类型的类名和要操作的表的表名不一致，会出现什么问题？

我们将表 user 更名为 t_user，测试查询功能程序抛出异常，Table ‘mybatis_plus.user’ doesn’t exist，因为现在的表名为 t_user，而默认操作的表名和实体类型的类名一致，即 user 表。

解决方式一：通过@TableName解决问题

在实体类类型上添加@TableName("t_user")，标识实体类对应的表，即可成功执行SQL语句。

@TableName属性：

解决方式二：通过全局配置解决问题

在开发的过程中，我们经常遇到以上的问题，即实体类所对应的表都有固定的前缀，例如t_或tbl_
此时，可以使用MyBatis-Plus提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就
不需要在每个实体类上通过@TableName标识实体类对应的表

mybatis-plus:
configuration:
   # 配置MyBatis日志
  log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
  db-config:
     # 配置MyBatis-Plus操作表的默认前缀
    table-prefix: t_

4.2 @TableId

经过以上的测试，MyBatis-Plus 在实现 CRUD 时，会默认将 id 作为主键列，并在插入数据时，默认
基于雪花算法的策略生成id。

若实体类和表中表示主键的不是 id，而是其他字段，例如 uid，MyBatis-Plus 会自动识别 uid 为主键列吗？

我们实体类中的属性id改为uid，将表中的字段id也改为uid，测试添加功能程序抛出异常，Field ‘uid’ doesn’t have a default value，说明MyBatis-Plus没有将uid作为主键。

解决方式：在实体类中uid属性上通过@TableId将其标识为主键，即可成功执行SQL语句

@TableId属性：

IdType类型如下：

配置全局主键策略：

mybatis-plus:
configuration:
   # 配置MyBatis日志
  log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
global-config:
  db-config:
     # 配置MyBatis-Plus操作表的默认前缀
    table-prefix: t_
     # 配置MyBatis-Plus的主键策略
    id-type: auto

雪花算法

需要选择合适的方案去应对数据规模的增长，以应对逐渐增长的访问压力和数据量。数据库的扩展方式主要包括：业务分库、主从复制，数据库分表。

数据库分表

将不同业务数据分散存储到不同的数据库服务器，能够支撑百万甚至千万用户规模的业务，但如果业务
继续发展，同一业务的单表数据也会达到单台数据库服务器的处理瓶颈。例如，淘宝的几亿用户数据，
如果全部存放在一台数据库服务器的一张表中，肯定是无法满足性能要求的，此时就需要对单表数据进
行拆分。

单表数据拆分有两种方式：垂直分表和水平分表。示意图如下

垂直分表

垂直分表适合将表中某些不常用且占了大量空间的列拆分出去。

例如，前面示意图中的 nickname 和 description 字段，假设我们是一个婚恋网站，用户在筛选其他用
户的时候，主要是用 age 和 sex 两个字段进行查询，而 nickname 和 description 两个字段主要用于展
示，一般不会在业务查询中用到。description 本身又比较长，因此我们可以将这两个字段独立到另外
一张表中，这样在查询 age 和 sex 时，就能带来一定的性能提升。

水平分表

水平分表适合表行数特别大的表，有的公司要求单表行数超过 5000 万就必须进行分表，这个数字可以
作为参考，但并不是绝对标准，关键还是要看表的访问性能。对于一些比较复杂的表，可能超过 1000
万就要分表了；而对于一些简单的表，即使存储数据超过 1 亿行，也可以不分表。

但不管怎样，当看到表的数据量达到千万级别时，作为架构师就要警觉起来，因为这很可能是架构的性
能瓶颈或者隐患。

水平分表相比垂直分表，会引入更多的复杂性，例如要求全局唯一的数据id该如何处理

主键自增

以最常见的用户 ID 为例，可以按照 1000000 的范围大小进行分段，1 ~ 999999 放到表 1中，
1000000 ~ 1999999 放到表2中，以此类推。

复杂点：分段大小的选取。分段太小会导致切分后子表数量过多，增加维护复杂度；分段太大可能会
导致单表依然存在性能问题，一般建议分段大小在 100 万至 2000 万之间，具体需要根据业务选取合适
的分段大小。

优点：可以随着数据的增加平滑地扩充新的表。例如，现在的用户是 100 万，如果增加到 1000 万，
只需要增加新的表就可以了，原有的数据不需要动。

缺点：分布不均匀。假如按照 1000 万来进行分表，有可能某个分段实际存储的数据量只有 1 条，而
另外一个分段实际存储的数据量有 1000 万条。

取模

同样以用户 ID 为例，假如我们一开始就规划了 10 个数据库表，可以简单地用 user_id % 10 的值来
表示数据所属的数据库表编号，ID 为 985 的用户放到编号为 5 的子表中，ID 为 10086 的用户放到编号
为 6 的子表中。

复杂点：初始表数量的确定。表数量太多维护比较麻烦，表数量太少又可能导致单表性能存在问题。

优点：表分布比较均匀。

缺点：扩充新的表很麻烦，所有数据都要重分布

雪花算法

雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的
主键的有序性。

长度共64bit（一个long型）。首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，结果约等于69.73年。10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点）。12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID。

优点：整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高

4.3 @TableField

经过以上的测试，我们可以发现，MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致如果实体类中的属性名和字段名不一致的情况，会出现什么问题呢？

情况1

若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格。例如实体类属性userName，表中字段user_name。此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格，相当于在MyBatis中配置。

情况2

若实体类中的属性和表中的字段不满足情况1，例如实体类属性name，表中字段username。此时需要在实体类属性上使用@TableField("username")设置属性所对应的字段名

@TableField属性：

FieldStrategy类型如下：

FieldFill类型如下：

4.4 @TableLogic

@TableLogic标记逻辑删除属性

@TableLogic属性：

4.5 其他注解

• @EnumValue：通枚举类注解(注解在枚举字段上)
• @Version：乐观锁注解、标记@Verison在字段上
• @KeySequence：序列主键策略 oracle
• @InterceptorIgnore：用于插件功能
• @OrderBy：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询

五、条件构造器和常用接口

5.1 Wrapper 介绍

• Wrapper ： 条件构造抽象类，最顶端父类
  • AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件
    • QueryWrapper ： 查询条件封装
    • UpdateWrapper ： Update 条件封装
    • AbstractLambdaWrapper ： 使用Lambda 语法
      • LambdaQueryWrapper ：用于Lambda语法使用的查询Wrapp
      • LambdaUpdateWrapper ： Lambda 更新封装Wrapper

5.2 QueryWrapper

① 组装查询条件

/**
 * 查询用户名包含a，年龄在20到30之间，并且邮箱不为null的用户信息
 */
@Test
public void testTest1() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.like("user_name", "a")
            .between("age", 20, 30)
            .isNotNull("email");
    /**
     * 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 BETWEEN ? AND ? AND email IS NOT NULL)
     */
    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

② 组装排序条件

/**
 * 按年龄降序查询用户，如果年龄相同则按id升序排列
 */
@Test
public void testTest2() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.orderByDesc("age")
            .orderByAsc("uid");
    /**
     * SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user
     * WHERE is_deleted=0 ORDER BY age DESC,uid ASC
     */
    List<User> userList = userMapper.selectList(queryWrapper);
    userList.forEach(System.out::println);
}

③ 组装删除条件

/**
 * 删除email为空的用户
 */
@Test
public void testTest3() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.isNull("email");
    /**
     * UPDATE t_user SET is_deleted=1 WHERE is_deleted=0 AND (email IS NULL)
     */
    int result = userMapper.delete(queryWrapper);
    System.out.println("受影响的行数" + result);
}

④ 组装修改条件

/**
 * 将（年龄大于20并且用户名中包含有a）或邮箱为null的用户信息修改
 */
@Test
public void testTest4() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.gt("age",20)
            .like("user_name","a")
            .or().isNull("email");
    /**
     * UPDATE t_user SET age=?, email=? 
     * WHERE is_deleted=0 AND (age > ? AND user_name LIKE ? OR email IS NULL)
     */
    User user = new User();
    user.setAge(18);
    user.setEmail("user@qq.com");
    int result = userMapper.update(user, queryWrapper);
    System.out.println("受影响的行数" + result);
}

⑤ 条件的优先级

/**
 * 将用户名中包含有a并且（年龄大于20或邮箱为null）的用户信息修改
 */
@Test
public void testTest5() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.like("user_name", "a")
            .and(i -> i.gt("age", 20).or().isNull("email"));
    /**
     *  UPDATE t_user SET age=?, email=? 
     *  WHERE is_deleted=0 AND (user_name LIKE ? AND (age > ? OR email IS NULL))
     */
    User user = new User();
    user.setAge(18);
    user.setEmail("user@qq.com");
    int result = userMapper.update(user, queryWrapper);
    System.out.println("受影响的行数" + result);
}

⑥ 组装select子句

/**
 * 查询用户信息的username和age字段
 */
@Test
public void testTest6() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.select("user_name", "age");
    /**
     *  SELECT user_name,age FROM t_user WHERE is_deleted=0
     */
    //selectMaps()返回Map集合列表，通常配合select()使用，避免User对象中没有被查询到的列值为null
    List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
    maps.forEach(System.out::println);
}

⑦ 实现子查询

/**
 * 查询id小于等于3的用户信息
 */
@Test
public void testTest7() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.inSql("uid", "select uid from t_user where uid <= 3");
    /**
    *  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 <= 3))
    */
    List<User> list = userMapper.selectList(queryWrapper);
    list.forEach(System.out::println);
}

5.3 UpdateWrapper

/**
 * 将（年龄大于20或邮箱为null）并且用户名中包含有a的用户信息修改
 */
@Test
public void testTest8() {
    UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
    //lambda表达式内的逻辑优先运算
    updateWrapper.set("age", 18)
            .set("email", "user@qq.com")
            .and(i -> i.gt("age", 20).or().isNull("email"))
            .like("user_name", "a");
    /**
     *  UPDATE t_user SET age=?,email=?
     *  WHERE is_deleted=0 AND ((age > ? OR email IS NULL) AND user_name LIKE ?)
     */
    int result = userMapper.update(null, updateWrapper);
    System.out.println("受影响的行数" + result);
}

5.4 condition

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

使用带condition参数的重载方法构建查询条件，简化代码的编写。

/**
 * Condition
 */
@Test
public void testTest9Condition() {
    //定义查询条件，有可能为null（用户未输入或未选择）
    String username = null;
    Integer ageBegin = 10;
    Integer ageEnd = 24;
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.like(StringUtils.isNotBlank(username),"username","a")
            .ge(ageBegin != null, "age", ageBegin)
            .le(ageEnd != null, "age", ageBegin);
    /**
     * SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user
     * WHERE is_deleted=0 AND (age >= ? AND age <= ?)
     */
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

5.6 LambdaQueryWrapper

使用 LambdaQueryWrapper 避免使用字符串表示字段，防止运行时错误。

@Test
public void testTest10() {
    //定义查询条件，有可能为null（用户未输入或未选择）
    String username = null;
    Integer ageBegin = 10;
    Integer ageEnd = 24;
    LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
    queryWrapper.like(StringUtils.isNotBlank(username),User::getName,"a")
            .ge(ageBegin != null, User::getAge, ageBegin)
            .le(ageEnd != null, User::getAge, ageBegin);
    /**
     * SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user
     * WHERE is_deleted=0 AND (age >= ? AND age <= ?)
     */
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

六、插件

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

6.1 分页插件

① 添加配置类

@Configuration
@MapperScan("com.hucheng.mybatisplus.mapper")
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new
                PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

② 测试

@Test
public void testSelectPageList() {
    Page<User> page = new Page<>(1, 5);
    /**
     * SELECT uid AS id,user_name AS name,age,email,is_deleted FROM t_user WHERE is_deleted=0 LIMIT ?
     */
    Page<User> pageData = userMapper.selectPage(page, null);
    List<User> records = pageData.getRecords();
    records.forEach(System.out::println);
    System.out.println("当前页："+page.getCurrent());
    System.out.println("每页显示的条数："+page.getSize());
    System.out.println("总记录数："+page.getTotal());
    System.out.println("总页数："+page.getPages());
    System.out.println("是否有上一页："+page.hasPrevious());
    System.out.println("是否有下一页："+page.hasNext());
}

6.2 xml 自定义分页

① UserMapper 中定义接口方法

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

② UserMapper.xml 中编写SQL

<select id="selectPageVo" resultType="User">
    SELECT uid,user_name,age,email FROM t_user WHERE age > #{age}
</select>

③ 测试

@Test
public void testCustomPageList() {
    Page<User> page = new Page<>(1, 5);
    /**
     * SELECT uid,user_name,age,email FROM t_user WHERE age > ? LIMIT ?
     */
    Page<User> pageData = userMapper.selectPageVo(page, 5);
    List<User> records = pageData.getRecords();
    records.forEach(System.out::println);
    System.out.println("当前页："+page.getCurrent());
    System.out.println("每页显示的条数："+page.getSize());
    System.out.println("总记录数："+page.getTotal());
    System.out.println("总页数："+page.getPages());
    System.out.println("是否有上一页："+page.hasPrevious());
    System.out.println("是否有下一页："+page.hasNext());
}

6.3 乐观锁

① 场景

一件商品，成本价是80元，售价是100元。老板先是通知小李，说你去把商品价格增加50元。小李正在玩游戏，耽搁了一个小时。正好一个小时后，老板觉得商品价格增加到150元，价格太高，可能会影响销量。又通知小王，你把商品价格降低30元。

此时，小李和小王同时操作商品后台系统。小李操作的时候，系统先取出商品价格100元；小王也在操作，取出的商品价格也是100元。小李将价格加了50元，并将100+50=150元存入了数据库；小王将商品减了30元，并将100-30=70元存入了数据库。是的，如果没有锁，小李的操作就完全被小王的覆盖了。

现在商品价格是70元，比成本价低10元。几分钟后，这个商品很快出售了1千多件商品，老板亏1万多。

② 乐观锁与悲观锁

上面的故事，如果是乐观锁，小王保存价格前，会检查下价格是否被人修改过了。如果被修改过了，则重新取出的被修改后的价格，150元，这样他会将120元存入数据库。

如果是悲观锁，小李取出数据后，小王只能等小李操作完之后，才能对价格进行操作，也会保证最终的价格是120元。

③ 模拟修改冲突

数据库中增加商品表：

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)
);

添加数据：

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

添加实体：

package com.atguigu.mybatisplus.entity;
import lombok.Data;

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

添加mapper：

public interface ProductMapper extends BaseMapper<Product> {
}

测试：

@Test
public void testConcurrentUpdate() {
	//1、小李
	Product p1 = productMapper.selectById(1L);
	System.out.println("小李取出的价格：" + p1.getPrice());
	//2、小王
	Product p2 = productMapper.selectById(1L);
	System.out.println("小王取出的价格：" + p2.getPrice());
	//3、小李将价格加了50元，存入了数据库
	p1.setPrice(p1.getPrice() + 50);
	int result1 = productMapper.updateById(p1);
	System.out.println("小李修改结果：" + result1);
	//4、小王将商品减了30元，存入了数据库
	p2.setPrice(p2.getPrice() - 30);
	int result2 = productMapper.updateById(p2);
	System.out.println("小王修改结果：" + result2);
	//最后的结果
	Product p3 = productMapper.selectById(1L);
	//价格覆盖，最后的结果：70
	System.out.println("最后的结果：" + p3.getPrice());
}

④ 乐观锁实现流程

数据库中添加version字段

取出记录时，获取当前version：SELECT id,name,price,versionFROM product WHERE id=1

更新时，version + 1，如果where语句中的version版本不对，则更新失败：UPDATE product SET price=price+50, `version`=`version` + 1 WHERE id=1 AND `version`=1

⑤ Mybatis-Plus 实现乐观锁

修改实体类

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

添加乐观锁插件配置：

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

优化流程：

@Test
public void testConcurrentVersionUpdate() {
	//小李取数据
	Product p1 = productMapper.selectById(1L);
	//小王取数据
	Product p2 = productMapper.selectById(1L);
	//小李修改 + 50
	p1.setPrice(p1.getPrice() + 50);
	int result1 = productMapper.updateById(p1);
	System.out.println("小李修改的结果：" + result1);
	//小王修改 - 30
	p2.setPrice(p2.getPrice() - 30);
	int result2 = productMapper.updateById(p2);
	System.out.println("小王修改的结果：" + result2);
	if(result2 == 0){
	//失败重试，重新获取version并更新
	p2 = productMapper.selectById(1L);
	p2.setPrice(p2.getPrice() - 30);
	result2 = productMapper.updateById(p2);
	}
	System.out.println("小王修改重试的结果：" + result2);
	//老板看价格
	Product p3 = productMapper.selectById(1L);
	System.out.println("老板看价格：" + p3.getPrice());
}

七、通用枚举

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

① 数据库表添加字段sex

② 创建通用枚举类型

@Getter
public enum SexEnum {
    MALE(1, "男"),
    FEMALE(2, "女");

    @EnumValue
    private Integer sex;
    private String sexName;

    SexEnum(Integer sex, String sexName){
        this.sex = sex;
        this.sexName = sexName;
    }
}

③ 配置扫描通用枚举

# 配置MyBatis
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  # 设置MyBatis-Plus的全局配置
  global-config:
    db-config:
      table-prefix: t_
  # 配置类型别名所对应的包
  type-aliases-package: com.hucheng.mybatisplus.pojo
  type-enums-package: com.hucheng.mybatisplus.enums

④ 测试

@Test
public void testSexEnum() {
    User user = new User();
    user.setName("Enum");
    user.setAge(20);
    //设置性别信息为枚举项，会将@EnumValue注解所标识的属性值存储到数据库
    user.setSex(SexEnum.MALE);
    userMapper.insert(user);
}

八、代码生成器

引入依赖：

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.5.1</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.31</version>
        </dependency>

快速生成：

public class FastAutoGeneratorTest {
    public static void main(String[] args) {
        FastAutoGenerator.create("jdbc:mysql://192.168.182.150:3306/mybatis-plus?characterEncoding=utf-8&userSSL=false", "root", "root")
                .globalConfig(builder -> {
                    builder.author("test") // 设置作者
                            //.enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("D://mybatis_plus"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.hucheng") // 设置父包名
                            .moduleName("mybatisplus") // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "D://mybatis_plus"));// 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.addInclude("t_user") // 设置需要生成的表名
                            .addTablePrefix("t_", "c_"); // 设置过滤表前缀
                })
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();
    }
}

九、多数据源

适用于多种场景：纯粹多库、 读写分离、 一主多从、 混合模式等。目前我们就来模拟一个纯粹多库的一个场景，其他场景类似。

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

① 创建数据库及表

创建数据库mybatis_plus_1和表product：

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)
);

添加测试数据：

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

删除mybatis_plus库product表：

use mybatis_plus;
DROP TABLE IF EXISTS product;

② 引入依赖

<!--  多数据源配置 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>dynamic-datasource-spring-boot-starter</artifactId>
    <version>3.5.0</version>
</dependency>

③ 配置多数据源

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

④ 创建用户service

public interface UserService extends IService<User> {
}

@DS("master") //指定所操作的数据源
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements
UserService {
}

⑤ 创建商品service

public interface ProductService extends IService<Product> {
}

@DS("slave_1")
@Service
public class ProductServiceImpl extends ServiceImpl<ProductMapper, Product>
implements ProductService {
}

⑥ 测试

@Autowired
private UserService userService;
@Autowired
private ProductService productService;

@Test
public void testDynamicDataSource(){
	System.out.println(userService.getById(1L));
	System.out.println(productService.getById(1L));
}

结果：都能顺利获取对象，则测试成功
······
如果我们实现读写分离，将写操作方法加上主库数据源，读操作方法加上从库数据源，自动切换，是不是就能实现读写分离？