MyBatisPlus：实现DAO的增删改查分页+属性设置，代码生成器（代码模板）

让我们来学习这一节MyBatisPlus的入门案例与简介，这个和其他课程都不太一样，其他的课程都是先介绍概念，然后再写入门案例。而对于MyBatisPlus我们调整了学习顺序的主要原因MyBatisPlus主要是对MyBatis简化，让我们先了解它在哪里简化，然后学习它是什么，它帮助我们做什么。

• MybatisPlus(简称MP)是基于MyBatis以框架为基础的增强工具旨在简化开发，提供效率。

• 开发方式

  • 基于MyBatis使用MyBatisPlus
  • 基于Spring使用MyBatisPlus
  • 基于SpringBoot使用MyBatisPlus

SpringBoot我们刚刚完成了学习，它可以快速构建Spring整合其他技术开发环境非常简单MP我们也基于学习SpringBoot构建学习。

在学习之前，我们先回顾一下，SpringBoot整合Mybatis开发过程：

• 创建SpringBoot工程

• 勾选配置中使用的技术可以自动添加起始依赖于包

• 设置dataSource相关属性(JDBC参数)

• 定义数据层接口映射配置

我们可以参考上述实现步骤

把SpringBoot整合MyBatisPlus具体实现步骤如下：

不同：不需要在DAO编写方法和接口SQL句子，只需要继承BaseMapper接口即可

create database if not exists mybatisplus_db character set utf8; use mybatisplus_db; CREATE TABLE user (     id bigint(20) primary key auto_increment,     name varchar(32) not null,     password  varchar(32) not null,     age int(3) not null ,     tel varchar(32) not null ); insert into user values(1,'Tom','tom',3,'18866668888'); insert into user values(2,'Jerry','jerry',4,'16688886666'); insert into user values(3,'Jock','123456',41,'18812345678');
insert into user values(4,'传智播客','itcast',15,'4006184000');

说明:

• 由于MP并未被收录到idea的系统内置配置，无法直接选择加入，需要手动在pom.xml中配置添加

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

说明:

• druid数据源可以加也可以不加，SpringBoot有内置的数据源，可以配置成使用Druid数据源

• 从MP的依赖关系可以看出，通过依赖传递已经将MyBatis与MyBatis整合Spring的jar包导入，我们不需要额外在添加MyBatis的相关jar包

resources默认生成的是properties配置文件，可以将其替换成yml文件，并在文件中配置数据库连接的相关信息:application.yml

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC 
    username: root
    password: root

说明:serverTimezone是用来设置时区，UTC是标准时区，和咱们的时间差8小时，所以可以将其修改为Asia/Shanghai

public class User { 
           
    private Long id;
    private String name;
    private String password;
    private Integer age;
    private String tel;
    //setter...getter...toString方法略
}

@Mapper
public interface UserDao extends BaseMapper<User>{ 
        
}

@SpringBootApplication
//@MapperScan("com.itheima.dao")
public class Mybatisplus01QuickstartApplication { 
        
    public static void main(String[] args) { 
        
        SpringApplication.run(Mybatisplus01QuickstartApplication.class, args);
    }

}

**说明:**Dao接口要想被容器扫描到，有两种解决方案:

• 方案一:在Dao接口上添加@Mapper注解，并且确保Dao处在引导类所在包或其子包中
  • 该方案的缺点是需要在每一Dao接口中添加注解
• 方案二:在引导类上添加@MapperScan注解，其属性为所要扫描的Dao所在包
  • 该方案的好处是只需要写一次，则指定包下的所有Dao接口都能被扫描到，@Mapper就可以不写。

@SpringBootTest
class MpDemoApplicationTests { 
        

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

说明:

userDao注入的时候下面有红线提示的原因是什么?

• UserDao是一个接口，不能实例化对象

• 只有在服务器启动IOC容器初始化后，由框架创建DAO接口的代理对象来注入

• 现在服务器并未启动，所以代理对象也未创建，IDEA查找不到对应的对象注入，所以提示报红

• 一旦服务启动，就能注入其代理对象，所以该错误提示不影响正常运行。

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

MyBatisPlus的官网为:https://mp.baomidou.com/ MP旨在成为MyBatis的最好搭档，而不是替换MyBatis,所以可以理解为MP是MyBatis的一套增强工具，它是在MyBatis的基础上进行开发的，

对于MP的学习，大家可以参考着官方文档来进行学习，里面都有详细的代码案例。

MP的特性:

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

在这一节中我们重点学习的是数据层标准的CRUD(增删改查)的实现与分页功能。代码比较多，我们一个个来学习。

对于标准的CRUD功能都有哪些以及MP都提供了哪些方法可以使用呢?

• Serializable：参数类型

  • 思考:参数类型为什么是一个序列化类?
    • String和Number是Serializable的子类，
    • Number又是Float,Double,Integer等类的父类，
    • 能作为主键的数据类型都已经是Serializable的子类，
    • MP使用Serializable作为参数类型，就好比我们可以用Object接收任何数据类型一样。

• int:返回值类型，数据操作成功返回1，未操作数据返回0。

• T:返回一条数据

List<T> selectList(Wrapper<T> queryWrapper)

• Wrapper：用来构建条件查询的条件，没有可直接传为Null
• List:因为查询的是所有，所以返回的数据是一个集合

上述可调用的方法都是来自于DAO接口继承的BaseMapper类中。 =》DAO接口类的编写变成最简单的了，里面什么都不用写

模型类的编写都需要哪些内容:

• 私有属性
• setter…getter…方法
• toString方法
• 构造函数

模型类的编写的优化方法：Lombok。

• Lombok，一个Java类库，提供了一组注解，简化POJO实体类开发。

**注意：**版本可以不用写，因为SpringBoot中已经管理了lombok的版本。

新版本IDEA已经内置了该插件，如果删除setter和getter方法程序有报红，则需要安装插件

如果在IDEA中找不到lombok插件，可以访问如下网站

https://plugins.jetbrains.com/plugin/6317-lombok/versions

根据自己IDEA的版本下载对应的lombok插件，下载成功后，在IDEA中采用离线安装的方式进行安装。

Lombok常见的注解有:

• @Setter:为模型类的属性提供setter方法
• @Getter:为模型类的属性提供getter方法
• @ToString:为模型类的属性提供toString方法
• @EqualsAndHashCode:为模型类的属性提供equals和hashcode方法
• @Data:是个组合注解，包含上面的注解的功能
• @NoArgsConstructor:提供一个无参构造函数
• @AllArgsConstructor:提供一个包含所有参数的构造函数

Lombok的注解还有很多，上面标黄的三个是比较常用的。

说明: 也可通过IDEA设置具有部分参数的构造方法

基础的增删改查就已经学习完了，刚才我们在分析基础开发的时候，有一个分页功能还没有实现，在MP中如何实现分页功能，就是咱们接下来要学习的内容。

分页查询使用的方法是:

IPage<T> page=new Page<>(当前页码,每页条数);
IPage<T> selectPage(IPage<T> page, Wrapper<T> queryWrapper)

• IPage:用来构建分页查询条件
• Wrapper：用来构建条件查询的条件，目前我们没有可直接传为Null
• IPage:返回值，你会发现构建分页条件和方法的返回值都是IPage

IPage是一个接口，我们需要找到它的实现类来构建它，具体的实现类，可以进入到IPage类中按ctrl+h,会找到其有一个实现类为Page。

@SpringBootTest
class Mybatisplus01QuickstartApplicationTests { 
        

    @Autowired
    private UserDao userDao;
    
    //分页查询
    @Test
    void testSelectPage(){ 
        
        //1 创建IPage分页对象,设置分页参数,1为当前页码，3为每页显示的记录数
        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());
    }
}

这个拦截器MP已经为我们提供好了，我们只需要将其配置成Spring管理的bean对象即可。

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

**说明:**上面的代码记不住咋办呢?

这些内容在MP的官方文档中有详细的说明，我们可以查看官方文档类配置

如果想查看MP执行的SQL语句，可以修改application.yml配置文件，

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #打印SQL日志到控制台

打开日志后，就可以在控制台打印出对应的SQL语句，开启日志功能性能就会受到影响，调试完后记得关闭。

增删改查四个操作中，查询是非常重要的也是非常复杂的操作，这块需要我们重点学习下，这节我们主要学习的内容有:

• 条件查询方式
• 查询投影
• 查询条件设定
• 字段映射与表名映射

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

这个我们在前面都有见过，比如查询所有和分页查询的时候，都有看到过一个Wrapper类，这个类就是用来构建查询条件的。

那么条件查询如何使用Wrapper来构建呢?

在构建条件查询之前，我们先来准备下环境

• 创建一个SpringBoot项目

• pom.xml中添加对应的依赖

  <?xml version="1.0" encoding="UTF-8"?>
  <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <parent>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-parent</artifactId>
          <version>2.5.0</version>
      </parent>
      <groupId>com.itheima</groupId>
      <artifactId>mybatisplus_02_dql</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <properties>
          <java.version>1.8</java.version>
      </properties>
      <dependencies>
  
          <dependency>
              <groupId>com.baomidou</groupId>
              <artifactId>mybatis-plus-boot-starter</artifactId>
              <version>3.4.1</version>
          </dependency>
  
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter</artifactId>
          </dependency>
  
          <dependency>
              <groupId>com.alibaba</groupId>
              <artifactId>druid</artifactId>
              <version>1.1.16</version>
          </dependency>
  
          <dependency>
              <groupId>mysql</groupId>
              <artifactId>mysql-connector-java</artifactId>
              <scope>runtime</scope>
          </dependency>
  
          <dependency>
              <groupId>org.springframework.boot</groupId>
              <artifactId>spring-boot-starter-test</artifactId>
              <scope>test</scope>
          </dependency>
  
          <dependency>
              <groupId>org.projectlombok</groupId>
              <artifactId>lombok</artifactId>
          </dependency>
  
      </dependencies>
  
      <build>
          <plugins>
              <plugin>
                  <groupId>org.springframework.boot</groupId>
                  <artifactId>spring-boot-maven-plugin</artifactId>
              </plugin>
          </plugins>
      </build>
  
  </project>
  
  

• 编写UserDao接口

  @Mapper
  public interface UserDao extends BaseMapper<User> { 
            
  }
  

• 编写模型类

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

• 编写引导类

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

• 编写配置文件

  # dataSource
  spring:
    datasource:
      type: com.alibaba.druid.pool.DruidDataSource
      driver-class-name: com.mysql.cj.jdbc.Driver
      url: jdbc:mysql://localhost:3306/mybatisplus_db?serverTimezone=UTC
      username: root
      password: root
  # mp日志
  mybatis-plus:
    configuration:
      log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  

• 编写测试类

  @SpringBootTest
  class Mybatisplus02DqlApplicationTests { 
            
  
      @Autowired
      private UserDao userDao;
      
      @Test
      void testGetAll(){ 
            
          List<User> userList = userDao.selectList(null);
          System.out.println(userList);
      }
  }
  

  最终创建的项目结构为:

  [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1FN5zd8i-1658733689011)(assets/1631033477792.png)]

• 测试的时候，控制台打印的日志比较多，速度有点慢而且不利于查看运行结果，所以接下来我们把这个日志处理下:

  • 取消初始化spring日志打印，resources目录下添加logback.xml，名称固定，内容如下:

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

    **说明:**logback.xml的配置内容，不是我们学习的重点，如果有兴趣可以自行百度查询。

  • 取消MybatisPlus启动banner图标

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-nZYlmIsN-1658733689013)(assets/1631021315906.png)]

    application.yml添加如下内容:

    # mybatis-plus日志控制台输出
    mybatis-plus:
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
      global-config:
        banner: off # 关闭mybatisplus启动图标
    

  • 取消SpringBoot的log打印

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xVPEBMoi-1658733689017)(assets/1631021269422.png)]

    application.yml添加如下内容:

    spring:
      main:
        banner-mode: off # 关闭SpringBoot启动图标(banner)
    

解决控制台打印日志过多的相关操作可以不用去做，一般会被用来方便我们查看程序运行的结果。

在进行查询的时候，我们的入口是在Wrapper这个类上，因为它是一个接口，所以我们需要去找它对应的实现类，关于实现类也有很多，说明我们有多种构建查询条件对象的方式。

1. 常规格式:QueryWrapper

@SpringBootTest
class Mybatisplus02DqlApplicationTests { 
        

    @Autowired
    private UserDao userDao;
    
    @Test
    void testGetAll(){ 
        
        QueryWrapper qw = new QueryWrapper();
        qw.lt("age",18);
        List<User> userList = userDao.selectList(qw);
        System.out.println(userList);
    }
}

• lt: 小于(<) ,最终的sql语句为

  SELECT id,name,password,age,tel FROM user WHERE (age < ?)
  

第一种方式介绍完后，有个小问题就是在写条件的时候，容易出错，比如age写错，就会导致查询不成功

2. lambda格式：QueryWrapper的基础上使用lambda