MybatisPlus

1、了解MP

1.1、特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑

损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作，BaseMapper
强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，简单的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.2、框架结构

1.3、依赖导入

spring boos

导入mybatis-plus-boot-starter

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

导入druid连接池

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.1.16</version>
</dependency>

导入lombok依赖包（用于实体类注解开发，省去setter、getter等方法）//不参与最终打包

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>provided</scope>
</dependency>

2、MP快速实现增删改查

2.1、项目搭建

模块结构截图：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DQTUmtZX-1681132482901)(C:\Users\FASQD\AppData\Roaming\Typora\typora-user-images\image-20221126194928310.png)]

2.2、接口UserDao

package com.example.mybatisplus_01_quickstart.dao;


import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.mybatisplus_01_quickstart.domain.User;
import org.apache.ibatis.annotations.Mapper;

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

@Mapper注解

1.使用@Mapper将UserDAO接口交给Spring进行管理

2.不用写Mapper映射文件（XML）

3.为这个UserDAO接口生成一个实现类，让别的类进行引用

继承BaseMapper<//放入实体类>

BaseMapper提供基本的增删改查方法，直接覆写。

2.3、实体类User

package com.example.mybatisplus_01_quickstart.domain;


import lombok.*;

//lombok
//@Setter
//@Getter
//@ToString
//@NoArgsConstructor
//@AllArgsConstructor
//@EqualsAndHashCode

@Data//包含上述所有注解功能，不包含构造方法

//使用lombok依赖直接省去实体类setter、getter、tostring等方法手写。
public class User {
    private Long id;
    private String name;
    private String password;
    private Integer age;
    private String tel;
}

使用@Data注解，直接省去编写实体类setter、getter、tostring等方法。

注意：@Data不包括构造方法

2.4、Mybatisplus01QuickstartApplicationTests测试类

测试增删改查功能

package com.example.mybatisplus_01_quickstart;

import com.example.mybatisplus_01_quickstart.dao.UserDao;
import com.example.mybatisplus_01_quickstart.domain.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class Mybatisplus01QuickstartApplicationTests {
    
    //注解，在bean中创建userDao
    @Autowired
    private UserDao userDao;
	
    
    //插入信息
    @Test
    void testSave(){
        User user = new User();
        user.setName("黑马程序员");
        user.setPassword("itheima");
        user.setAge(12);
        user.setTel("21315432654");
        userDao.insert(user);
    }

	//删除信息
    @Test
    void testDelete(){
        userDao.deleteById(1595246763755708417L);
    }
	
    //更新信息
    @Test
    void testUpdate(){
        User user = new User();
        user.setId(1L);
        user.setName("Tom666");
        user.setPassword("tom666");
        userDao.updateById(user);//相比于mybatis，省去了sql语句的编写，同时可以直接修改对于数据库信息，不用考虑null
    }
	
    
    //获取单条信息
    @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);
    }

}

3、分页查询

1、设置mybatisplus分页拦截器

2、新建IPage对象

3、使用userDao.selectPage(page,null)

3.1、设置MPconfig

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-794gtDiu-1681132482902)(C:\Users\FASQD\AppData\Roaming\Typora\typora-user-images\image-20221201202939168.png)]

package com.example.mybatisplus_01_quickstart.config;

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//告诉spring从哪里获取bean
public class MPconfig {
    @Bean//依赖注入到SpringIoc容器当中作为bean
    public MybatisPlusInterceptor mybatisPlusIntercepor(){
        //定义MP拦截器
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        //添加某种具体拦截器
        mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());//设置分页拦截器
        return mybatisPlusInterceptor;
    }
}

解释：MybatisPlusInterceptor包含mybatisplus中的各种拦截器

3.2、测试方法

@Test
void testGetByPage(){
    IPage page = new Page(1,5);//第1页每页2条
    userDao.selectPage(page,null);
    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());
}

3.3、开启日志查看sql语句

在application.yml配置文件中添加：

#开启mp的日志（输出到控制台）
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

4、条件查询

4.1、设置关闭springboot与mybatisplus的banner标签和日志信息

spring:
  datasource:
    type: com.alibaba.druid.pool.DruidDataSource
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=UTC
    username: root
    password: root
  main:
    banner-mode: off #关闭springboot的标志
#设置banner关闭mp的标志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    banner: false

不显示springboot日志信息：

在resources文件夹中创建logback.xml文件并配置：

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

</configuration>

4.2、测试类实现条件查询

@Test
    void testGetAll() {

        //方式一：按条件查询
//        QueryWrapper queryWrapper = new QueryWrapper();//条件查询wrapper对象
//        //调用queryWrapper中的方法
//        queryWrapper.lt("age",18);//(列名，数值)
//        List<User> userList = userDao.selectList(queryWrapper);
//        System.out.println(userList);

        //方式二：lambda格式按条件查询
//        QueryWrapper<User> queryWrapper = new QueryWrapper<User>();
//        queryWrapper.lambda().lt(User::getAge,18);//lt()小于函数
//        List<User> userList = userDao.selectList(queryWrapper);
//        System.out.println(userList);

        LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
        //大于10小于30
//        lambdaQueryWrapper.lt(User::getAge,30).gt(User::getAge,10);

        //小于10或者大于30
        lambdaQueryWrapper.lt(User::getAge,10).or().gt(User::getAge,30);
        
        //between
        //lambdaQueryWrapper.between(User::getAge,10,30);
        
        List<User> userList = userDao.selectList(lambdaQueryWrapper);
        System.out.println(userList);
    }

4.3、条件查询的null值处理：

//注意：遇到条件查询注意null值判定
        UserQuery userQuery = new UserQuery();
//        userQuery.setAge(10);
        userQuery.setAge2(30);

        LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
        //原始方法：使用if条件判断
//        lambdaQueryWrapper.lt(User::getAge,userQuery.getAge2());
//        if(userQuery.getAge()!=null) {
//            lambdaQueryWrapper.gt(User::getAge, userQuery.getAge());
//        }
        
        //使用带有条件判断的方法：
        lambdaQueryWrapper.lt(null!=userQuery.getAge2(),User::getAge,userQuery.getAge2())
                          .gt(null!=userQuery.getAge(),User::getAge,userQuery.getAge());
        List<User> userList = userDao.selectList(lambdaQueryWrapper);
        System.out.println(userList);

4.4、查询投影

//查询投影
        LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
        //设置查询字段
        lambdaQueryWrapper.select(User::getId,User::getName,User::getAge);//只适用lambda

        //使用非lambda格式
//        QueryWrapper<User> queryWrapper = new QueryWrapper<User>();
//        queryWrapper.select("id","name","age","tel");


        List<User> userList = userDao.selectList(lambdaQueryWrapper);
        System.out.println(userList);

        //必须用QueryWrapper
        QueryWrapper<User> queryWrapper = new QueryWrapper<User>();
        //实现分组统计
        queryWrapper.select("count(*) as count,tel");
        queryWrapper.groupBy("tel");
        List<Map<String, Object>> userList2 = userDao.selectMaps(queryWrapper);
        System.out.println(userList2);

4.5、等匹配实现

//条件查询
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
//等同于=，实现=匹配
lambdaQueryWrapper.eq(User::getName,"Jerry").eq(User::getPassword,"jerry");

User loginUser = userDao.selectOne(lambdaQueryWrapper);
System.out.println(loginUser);

使用.eq（）进行字段相等匹配。

注意：selectList<>()返回实体类列表，selectOne()返回对应实体类。

4.6、模糊匹配

//模糊匹配
LambdaQueryWrapper<User> lambdaQueryWrapper = new LambdaQueryWrapper<User>();
lambdaQueryWrapper.like(User::getName,"J");
List<User> userList = userDao.selectList(lambdaQueryWrapper);
System.out.println(userList);

注意：.likeRight()方法中的sql语句，%在所要查询字符的右边。例如：J%，也就是J以后的字符不限。

​ .likeLeft()方法中的sql语句，%在所要查询字符左边，例如：%J，也就是J以前的字符不限。

5、字段映射与表名映射

问题一：表字段与编码属性设计不同步

例如：数据库密码对应字段为pwd，但是实体类User对应字段为password。

解决：

@TableField(value = "pwd")
private String password;

问题二：编码中添加了数据库中未定义的属性

例如：实体类User中存在数据库中未设计的属性online。

解决：

@TableField(exist = false)
private Integer online;

问题三：采用默认查询开放了更多的字段查看权限

例如：password在查询过程中默认查询出，返回json数据。

解决：

@TableField(value = "pwd",select = false)//设置select = false告诉MP该字段不参与查询
private String password;

问题四：表名和编码开发设计不匹配

例如：数据库表名tb1_user与实体类User不匹配

解决：

@TableName("tb1_user")
public class User {
    private Long id;
    private String name;
//    @TableField(value = "pwd",select = false)//设置select = false告诉MP该字段不参与查询
    private String password;
    private Integer age;
    private String tel;
    @TableField(exist = false)
    private Integer online;

}

6、DML编程控制

6.1、id生成策略控制（主键）–Insert

名称：@TableId

类型：属性注解

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

设置IDtype：例如：@TableId（type = IdType.AUTO）

AUTO（0）：使用数据库id自增策略控制id生成

NONE（1）：不设置id生成策略

INPUT（2）：用户手工输入id

ASSIGN_ID(3):雪花算法生成id（可兼容数值型和字符串型）

ASSIGN_UUID(4):以UUID生成算法作为id生成策略

全局设置id生成策略：

在application.yml文件中，通过idtype索引快速生成代码：

mybatis-plus:
  global-config:
    db-config:
      id-type: assign_id #设置id生成策略

表名前缀全局设置TableName：

mybatis-plus:
  global-config:
    db-config:
      table-prefix: tb1_ #查表时在表名前自动添加tb1_

6.2、多记录操作–Delete、Select

通过id多表删除、查询：

List<Long> list = new ArrayList<>();
list.add(1645322662953127938L);
userDao.deleteBatchIds(list);

List<Long> list2 = new ArrayList<>();
list2.add(1L);
list2.add(2L);
userDao.selectBatchIds(list2);

6.3、逻辑删除–Delete、Update

删除操作业务问题：业务数据从数据库中丢弃

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

1、数据库中添加逻辑删除字段例如：deleted

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

//逻辑删除字段，标记当前记录是否被删除
@TableLogic(value = "0",delval = "1")
private Integer deleted;

3、或者进行全局配置：

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      id-type: assign_id
      table-prefix: tb1_
      logic-delete-field: deleted #设定逻辑删除字段
      logic-not-delete-value: 0 #设定不删除值
      logic-delete-value: 1 #设定删除值

使用逻辑删除之后，删除语句变成更新语句改变deleted字段值，实际数据库内数据并没有删除。

6.4、乐观锁–Update

1、数据库中添加对应字段，例如：version

2、实体类中添加对应字段，并进行注释

@Version
private Integer version;

3、配置MP拦截器（例如：在MPconfig中配置乐观锁拦截器）

@Configuration
public class MPconfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        //定义MP拦截器
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        //添加分页拦截器，自动修改sql语句
        mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        //添加乐观锁拦截器
        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return mybatisPlusInterceptor;
    }
}

拦截器会自动修改你的sql语句，实现锁机制对应的动态sql语句拼装。

4、例如：

@Test
    void testUpdate(){

//        User user = new User();
//        user.setId(3L);
//        user.setName("Gzx");
//        必须设置version
//        user.setVersion(1);
//        userDao.updateById(user);

        //1、先通过要修改的数据id将当前数据查询出来
        User user = userDao.selectById(3L);
        //2、将要修改的属性逐一设置进去
        user.setName("Gzx1111");
        userDao.updateById(user);
    }

7、代码生成器

模板：MybatisPlus提供

数据库相关配置：读取数据库获取信息

开发者自定义配置：手工配置

1、导入依赖：

<!--        代码生成器-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
<!--        velocity模板引擎-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>

2、创建生成器，并进行配置

数据源配置、全局配置、包名配置、策略配置，等等。

public class Generator {
    public static void main(String[] args) {
        AutoGenerator autoGenerator = new AutoGenerator();
        //配置datasource
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=UTC");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("root");
        autoGenerator.setDataSource(dataSourceConfig);


        //设置全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir("");//设置代码生成位置
        globalConfig.setOpen(false);//设置生成完毕后是否打开生成代码所在的目录
        globalConfig.setAuthor("Gzx");//设置作者
        globalConfig.setFileOverride(false);//设置是否覆盖原始生成文件
        globalConfig.setMapperName("%sMapper");//设置数据层接口名称，%s代指模块名称
        globalConfig.setIdType(IdType.ASSIGN_ID);//设置Id生成策略
        autoGenerator.setGlobalConfig(globalConfig);

        //设置包名相关配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setParent("com.Gzx");//设置生成的包名，和所在代码位置不冲突
        packageConfig.setEntity("domain");//设置实体类包名
        packageConfig.setMapper("mapper");//设置数据层包名
        autoGenerator.setPackageInfo(packageConfig);

        //策略设置
        StrategyConfig strategyConfig = new StrategyConfig();
        strategyConfig.setInclude("tb1_user");//设置当前参与生成的表名，参数为可变参数，生成指定表的代码！
        strategyConfig.setTablePrefix("tb1_");//设置数据库表的前缀名称，模块名=数据库表名-前缀名（tb1_）
        strategyConfig.setRestControllerStyle(true);//设置是否启用Rest风格
        strategyConfig.setVersionFieldName("version");//设置乐观锁字段名称
        strategyConfig.setLogicDeleteFieldName("deleted");//设置逻辑删除字段名
        strategyConfig.setEntityLombokModel(true);//设置是否启用lombok
        autoGenerator.setStrategy(strategyConfig);

        //执行生成操作
        autoGenerator.execute();

    }
}