1 MybatisPlus简介

1.1 MybatisPlus概述

​ MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生（提供了快速使用mybatis的方式）。

官网：https://mybatis.plus/https://mybatis.plus/ 或 Redirecthttps://mp.baomidou.com/

1.2 MP特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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.3 开发MP版本

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>3.5.7</version>
</dependency>

2 MP快速入门

2.1 MP入门流程分析

SpringBoot 整合 MyBatis-Plus，并==实现根据Id查询功能==。

1. 数据库环境准备
2. 创建SpringBoot工程，引入MyBatisPlus场景依赖
3. 在yml中编写DataSource相关配置
4. 编写mapper
5. 测试

2.2 数据库环境准备

-- 创建数据库 mp
CREATE DATABASE IF NOT EXISTS mp;

-- 使用数据库 mp
USE mp;

-- 创建表 tb_user
CREATE TABLE IF NOT EXISTS tb_user (
    id BIGINT PRIMARY KEY AUTO_INCREMENT,
    user_name VARCHAR(255) NOT NULL,
    password VARCHAR(255) NOT NULL,
    name VARCHAR(255),
    age INT,
    email VARCHAR(255)
);


-- 插入假数据
INSERT INTO tb_user (user_name, password, name, age, email) VALUES
('user1', 'password1', '张三', 25, 'user1@example.com'),
('user2', 'password2', '李四', 30, 'user2@example.com'),
('user3', 'password3', '王五', 28, 'user3@example.com'),
('user4', 'password4', '赵六', 22, 'user4@example.com'),
('user5', 'password5', '孙七', 35, 'user5@example.com');

2.3 创建工程，引入场景依赖

  <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.4</version>
    </parent>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

     <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--mybatisplus起步依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
            <version>3.5.7</version>
        </dependency>

     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>8.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

2.4 编写DataSource相关配置

#配置数据源
spring:
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://localhost:3306/mp?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC&useSSL=false
    driver-class-name: com.mysql.cj.jdbc.Driver
# 设置mp运行时行为
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

2.5 编码

编写实体类：

package com.loong.pojo;

import com.baomidou.mybatisplus.annotation.TableName;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@TableName("tb_user") // 指定表名
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class User {
    private Long id;
    private String userName;
    private String password;
    private String name;
    private Integer age;
    private String email;
}

@TableName("tb_user”) : 如果数据库的表名和实体类一致时可以省略

编写mapper：

package com.loong.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.loong.pojo.User;
import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface UserMapper extends BaseMapper<User> {

}

启动类增加 @MapperScan 注解：

package com.loong;

 import org.mybatis.spring.annotation.MapperScan;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

 @SpringBootApplication
 @MapperScan("com.loong.mapper")
 public class MpApp {

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

 }

2.6 测试

import com.loong.MpApp;
import com.loong.mapper.UserMapper;
import com.loong.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest(classes = MpApp.class)
public class UserMapperTest {

    @Autowired
    private UserMapper userMapper;
    /**
     * 根据id查询
     */
    @Test
    public void testSelectById() { 
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }
}

3 MP实现常规增删改操作

3.1 MP实现插入操作

3.1.1 BaseMapper定义操作方法

注意事项：

1.如果主键对应的实体类属性中没有设置主键的生成策略，那么MP自动为主键生成值，且回填到实体对象下；

2.如果未指定主键生成策略，即使表的主键是主键自增，也不会使用主键自增；

3.1.2 代码测试

@Test
public void testInsert() {
  User user =
    User.builder() 
    .userName("itheima")
    .name("itcast")
    .age(15)
    .email("itcast@itcast.cn")
    .password("111111")
    .build();
  int insert = userMapper.insert(user);
  System.out.println(insert);
}

插入数据时，我们发现表中ID设置默认自增，但是实际生成的id却是很长串的数字？

3.2 MP主键字段注解-@TableId

3.2.1 注解@TableId介绍

@TableId注解作用：

1. 映射表中主键字段与实体类属性的关系（尤其表中主键字段名称与实体类属性名称不一致时）；
2. 定义主键生成策略；

@TableId使用：

添加在实体类的主键对应的成员属性上即可；

@TableName("tb_user") // 指定表名
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class User {
    @TableId(value="id")//字段不一致时，通过value值指定table中主键字段名称
    private Long userId;
    private String userName;
    private String password;
    private String name;
    private Integer age;
    private String email;
}

3.2.2 MP主键生成策略介绍

主键生成策略:

​ 是指为数据库生成主键的方式，我们前面学的数据库主键自增也是一种生成主键的策略，当然除了数据库服务端帮助我们维护主键之外，客户端也可以对主键值进行生成维护。

MP主键生成策略示例：

//指定主键自增的生成策略
@TableId(value = "user_id",type = IdType.AUTO)
private Integet userId;

3.2.3 MP常用主键生成策略

MP提供的常用主键生成策略如下：

生成策略	应用场景	特点
IdType.AUTO	数据库主键自增(确保数据库设置了 主键自增 否则无效)	1.使用数据库自带的主键自增值； 2.数据库自增的主键值会回填到实体类中； 3.数据库服务端生成的；
IdType.ASSIGN_ID	主键类型为number类型或数字类型String	1.MP客户端生成的主键值； 2.生成的主键值是数字形式的字符串 3.主键对应的类型可以是数字类型或者数字类型的字符串 4.底层基于雪花算法，让数据库的唯一标识也参与id的生成运算，保证id在分布式环境下，全局唯一（避免id的主键冲突问题）；
IdType.ASSIGN_UUID	主键类型为 string（包含数字和字母组成）	1.生成的主键值包含数字和字母组成的字符串； 2.注意事项：如果数据库中主键值是number类型的，可不可用

3.2.4 雪花算法(了解)

通过翻阅源码，我们发现IdType.ASSIGN_ID底层基于雪花算法保证主键ID的唯一性：

说明：生成ID的过程让时间戳、数据库服务器标识、序列化号等参与运算，保证分布式环境下ID的唯一性，避免主键冲突；

雪花算法：说白了就是指定在那个机房（机房id）的那台机器（机器的id）
在什么时间点（时间戳）下生成的，
如果同一台机器存在并发生成主键值，则序列号参（并发的版本号）数运算；

3.3 普通列注解-@TableField

3.3.1 注解@TableField作用

注解@TableField作用：

• 指定表中普通字段与实体类属性之间的映射关系；
• 忽略实体类中多余属性与表中字段的映射关系(@TableField(exist = false))；

以下情况可以省略：

• 名称一样
• 数据库字段使用_分割，实体类属性名使用驼峰名称（自动开启驼峰映射）

3.3.2 代码示例

/**
 * 实体类的属性名和数据库的字段名自动映射：
 *  1. 名称一样
 *  2. 数据库字段使用_分割，实体类属性名使用驼峰名称
 */

@TableName("tb_user")
@Data
public class User {
    //设置id生成策略:AUTO 数据库自增
    @TableId(type = IdType.AUTO)
    private Long id;
    //@TableField("user_name")
    private String userName;

    private String password;
  
    @TableField("t_name")
    private String name;
    private Integer age;
    private String email;
    //增删改查操作时，忽略该属性
    @TableField(exist = false)
    private String address;
}

3.4.MP实现删除操作

3.4.1 根据id删除

 int count = userMapper.deleteById(8L);

3.4.2 根据id集合批量删除

 List ids = new ArrayList();
        ids.add(6);
        ids.add(7);
userMapper.deleteBatchIds(ids);

3.4.3 根据map构造条件，删除

Map<String, Object> map = new HashMap<>();

//delete from tb_user where user_name = ? and age = ?
map.put("user_name","itcast");
map.put("age","18");

userMapper.deleteByMap(map);

3.5 MP实现更新操作

根据实体对象中的id更新数据

注意事项：只更新实体类中存在的数据，如果对应的属性为null，不更新；

@Test
public void testUpdateById() {
  User user = new User();
  user.setId(2L);
  user.setPassword("1111111");
  int count = userMapper.updateById(user);
}

4.MP实现查询操作

4.1 MP实现分页查询

4.1.1 配置分页拦截器

package com.loong.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        PaginationInnerInterceptor paginationInterceptor = new PaginationInnerInterceptor(DbType.MYSQL);
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        // paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，-1不受限制
        paginationInterceptor.setMaxLimit(-1L);
        interceptor.addInnerInterceptor(paginationInterceptor);
        return interceptor;
    } 
}

4.1.2 查询测试

/**
  * 分页查询：
  *  1. 当前页码：currentPage
  *  2. 每页显示条数：size
  *
  *  注意：使用mp的分页要设置一个拦截器！！！
*/
@Test
public void testSelectPage() {
  int current = 1;//当前页码
  int size = 2;//每页显示条数
  IPage<User> page = new Page(current,size);
  userMapper.selectPage(page,null);
  List<User> records = page.getRecords();//当前页的数据
  long pages = page.getPages();//总页数 2
  long total = page.getTotal();//总记录数 4
  System.out.println(records);
  System.out.println(pages);
  System.out.println(total);
}

4.2 QueryWrapper实现基础查询

/**
 * 基础比较查询
 * Wrapper接口:
 *  1.QueryWrapper
 *    LambdaQueryWrapper //查询
 *  2.UpdateWrapper
 *    LambdaUpdateWrapper //更新
 */

4.2.1 QueryWrapper常用API

eq( ) :  等于 =
ne( ) :  不等于 <> 或者 !=
gt( ) :  大于 >
ge( ) :  大于等于  >=
lt( ) :  小于 <
le( ) :  小于等于 <=
between ( ) :  BETWEEN 值1 AND 值2 
notBetween ( ) :  NOT BETWEEN 值1 AND 值2 
in( ) :  in
notIn( ) ：not in

sql中反向查询eg:not like != 等等，查询时是不会走索引的；

4.2.2 查询实现

要求：查询用户中姓名包含"张"，密码为"password1",且年龄为19或者25或者29，查询结果按照年龄降序排序；

/**
     * @Description 测试条件查询
     * 要求：查询用户中姓名包含"伤"，密码为"123456",且年龄为19或者25或者29，查询结果按照年龄降序排序；
     * 如果查询的条件过于复杂，mp还适合么？
     *        简单的操作，直接使用mp
     *        但是非常复杂的操作，比如多表关联查询 复杂条件查询等，建议使用xml下sql实现；
     */
    @Test
    public void testcQuery1(){
        //构建添加包装对象
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //设置条件
        wrapper.like("user_name","张")
                .eq("password","password1")
//                .in("age",19,25,29)
                .in("age",Arrays.asList(19,25,29))
                .orderByDesc("age");
        //查询
        /*
        ==> Preparing: SELECT id,user_name,password,name,age,email FROM tb_user WHERE (user_name LIKE ? AND password = ? AND age IN (?,?,?)) ORDER BY age DESC
        ==> Parameters: %张%(String), password1(String), 19(Integer), 25(Integer), 29(Integer)
         */
        List<User> users = userMapper.selectList(wrapper);
        System.out.println(users);
    }

4.3 QueryWrapper逻辑查询or

4.3.1 OR查询说明

1. 通过QueryWrapper多条件查询时，默认使用and关键字拼接SQL;
2. 通过QueryWrapper调用or()方法时，底层会使用or关键字拼接方法左右的查询条件;

4.3.2 代码示例

业务要求：查询用户名为"lisi"或者年龄大于23的用户信息；

@Test
public void testWrapper2(){
    //1.创建查询条件构建器
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //2.设置条件
    wrapper.eq("user_name","李四")
        .or()
        .lt("age",23);
    /*
       select * from tb_user where user_name = ? or age < ? 
    */
    List<User> users = userMapper.selectList(wrapper);
    System.out.println(users);
}

4.4 QueryWrapper模糊查询like

4.4.1 模糊查询常用方法

• like("表列名","条件值"); 作用：查询包含关键字的信息，底层会自动添加匹配关键字，比如:%条件值%
• likeLeft("表列名","条件值"); 作用：左侧模糊搜索，也就是查询以指定条件值结尾的数据，比如:%条件值
• likeRight("表列名","条件值");作用：右侧模糊搜索，也就是查询以指定条件值开头的数据，比如:条件值%

4.4.2 代码演示

/**
     * 模糊查询
     */
    @Test
    public void testWrapper3(){
        //1.创建查询条件构建器
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //2.设置条件
        wrapper.likeLeft("user_name","张");
        /*
            SELECT id,user_name,password,name,age,email
             from tb_user
             where user_name like ?
             %张
         */
        List<User> users = userMapper.selectList(wrapper);
        System.out.println(users);
    }

4.5 QueryWrapper排序查询

4.5.1 核心方法

• orderByAsc 升序排序，方法内可传入多个字段
• orderByDesc 降序排序，方法内可传入多个字段

4.5.2 代码实现

需求：先根据age升序排序，如果年龄相同则按照id降序排序；

@Test
    public void testWrapper4(){
        //1.创建查询条件构建器
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //2.设置条件
        wrapper.eq("user_name","李四")
                .or()
                .lt("age",23)
                .in("name","李四","王五")
                //.orderBy(true,true,"age")
                .orderByDesc("age");
        /*
            select * from tb_user where user_name = ? or age < ? and name in (?,?) order by age asc
         */
        List<User> users = userMapper.selectList(wrapper);
        System.out.println(users);
    }

4.6 QueryWrapper限定字段查询

4.6.1 select方法说明

MP查询时，默认将表中所有字段数据映射查询，但是有时我们仅仅需要查询部分字段信息，这是可以使用select()方法限定返回的字段信息，避免I/O资源的浪费；

示例：

wrapper.select("字段1","字段2",......)

4.6.2 代码示例

@Test
    public void testWrapper5(){
        //1.创建查询条件构建器
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        //2.设置条件
        wrapper.eq("user_name","李四")
                .or()
                .lt("age",23)
                .in("name","李四","王五")
                //.orderBy(true,true,"age")
                .orderByDesc("age")
                .select("id","user_name");
        /*
            select id,user_name from tb_user where user_name = ? or age < ? and name in (?,?) order by age asc
         */
        List<User> users = userMapper.selectList(wrapper);
        System.out.println(users);
    }

4.7 QueryWrapper实现分页条件查询

4.7.1 方法说明

//参数1：分页对象
//参数2：查询条件
mapper.selectPage(page,wrapper);

4.7.2 代码实现

需求：查询年龄大于23的用户信息，并显示第2页，每页大小为3；

@Test
    public void testWrapper6(){
        int current = 1;//当前页码
        int size = 2;//每页显示条数
        //1. 构建分页对象
        Page<User> page = new Page<>(current,size);
        //2. 构建条件对象
        QueryWrapper<User> wrapper = new QueryWrapper();
        wrapper.lt("age",23);
        userMapper.selectPage(page,wrapper);
        List<User> records = page.getRecords();
        long total = page.getTotal();
        long pages = page.getPages();
        System.out.println(records);
        System.out.println(total);//2
        System.out.println(pages);//1
    }

4.8 LambdaQueryWrapper查询

4.8.1 使用QueryWrapper开发存在的问题

1. 使用QueryWrapper查询数据时需要手写对应表的列名信息，及其容易写错，开发体验不好；
2. 使用QueryWrapper查询数据时，表的列名硬编码书写，后期一旦表结构更改，则会带来很大的修改工作量，维护性较差；

LambdaQueryWrapper可以解决上述出现问题，开发推荐使用；

4.8.2 代码实现

@Test
public void testWrapper4() throws Exception{
  // LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
  LambdaQueryWrapper<User> wrapper = Wrappers.<User>lambdaQuery();

  //        wrapper.like("user_name", "%张%")
  //                .eq("password","password1")
  //                .ge("age", 28)
  //                .between("age",29 , 39);  // 包含边界值
  wrapper.like(User::getUserName, "%张%")
    .eq(User::getPassword, "password1")
    .ge(User::getAge, 28)
    .between(User::getAge, 29, 39)
    .orderByDesc(User::getAge)
    .select(User::getId, User::getUserName);
  List<User> users = userMapper.selectList(wrapper);
  System.out.println(users);
}

4.9 LambdaQueryWrapper实现删除和更新操作

4.9.1 条件删除

/**
     * 条件删除
     * @throws Exception
*/
@Test
public void testWrapper5() throws Exception{

  LambdaQueryWrapper<User> wrapper = Wrappers.<User>lambdaQuery().eq(User::getUserName, "张三");
  int i = userMapper.delete(wrapper);
  System.out.println(i);
}

4.9.2 条件更新

/**
     * 条件更新
     * @throws Exception
*/
@Test
public void testWrapper6() throws Exception{

  /**
     * UPDATE tb_user SET t_name=? WHERE (id = ?)
     */
  // 参数1： 最新的值
  User user = new User();
  user.setUserName("张三丰");

  // 参数2：更新时条件
  LambdaQueryWrapper<User> wrapper = Wrappers.<User>lambdaQuery();
  wrapper.eq(User::getId, 1);

  int update = userMapper.update(user, wrapper);
  System.out.println(update);
}


/**
     * 条件更新
     * @throws Exception
     */
@Test
public void testWrapper7() throws Exception{
  /**
         * UPDATE tb_user SET t_name=?, user_name=? WHERE (id = ?)
         */
  // 参数1： 最新的值
  // 参数2：更新时条件
  LambdaUpdateWrapper<User> wrapper = Wrappers.<User>lambdaUpdate();
  wrapper.eq(User::getId, 1)
    .set(User::getUserName, "张三丰666")
    .set(User::getName,"zsf666");

  int update = userMapper.update(null, wrapper);
  System.out.println(update);
}

4.10 自定义查询接口实现分页查询(扩展)

4.10.1 说明

​ 目前我们使用MP自带的分页插件可以很友好的实现分页查询操作，但是如果一些查询需要我们自定义SQL,那该如何实现分页查询操作呢？

4.10.2 实现流程

• 自定义接口中直接传入Page分页对象即可；

  import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  import com.baomidou.mybatisplus.core.metadata.IPage;
  import com.itheima.pojo.User;
  import org.apache.ibatis.annotations.Param;
  
  import java.util.List;
  
  /**
   * @Description 定义mapper接口
   */
  //@Mapper
  public interface UserMapper extends BaseMapper<User> {
      /**
       * 查询大于指定id的用户信息，并分页查询实现
       * @param page
       * @param id
       * @return
       */
      IPage<User> findGtIdByPage(IPage<User> page, @Param("id") Long id);
  }

  定义xml映射文件

  <?xml version="1.0" encoding="UTF-8" ?>
  <!DOCTYPE mapper
          PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
          "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  <mapper namespace="com.loong.mapper.UserMapper">
  
      <select id="findGtIdByPage" resultType="com.itheima.pojo.User">
          select * from tb_user where id > #{id}
      </select>
  </mapper>

• 测试

  /**
       * @Description 自定义sql分页查询实现
       */
  @Test
  public void test19(){
      IPage<User> page=new Page<>(2,3);
      IPage<User> users = userMapper.findGtIdByPage(page, 3l);
      System.out.println(users.getRecords());
      System.out.println(user.getPages());
      System.out.println(user.getTotal());
  }