Mybatis-Plus

一. 简介

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

• 使用Mybatis-Plus，如果实现单表操作，不需要编写sql语句，封装方法，使用封装的这些方法方便实现

• 如果复杂查询，或者多表查询，还需要编写sql语句实现

二. 特性

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

DROP TABLE IF EXISTS `user`;

CREATE TABLE `user`
(
    id BIGINT NOT NULL COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

2> 创建Spring Boot工程，引入依赖

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

3> 配置application.yml配置文件（数据库及mybatis-plus配置）

# 配置文件
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456

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

4> 编写实体类 User.java

package com.nianxi.mybatisplus.entity;

import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;

@Data
@TableName("user")
public class User {

//    @TableId(type = IdType.AUTO)
    private Long id;

    @TableField("name")
    private String name;

    @TableField("age")
    private Integer age;

    @TableField("email")
    private String email;

    @TableLogic //逻辑删除
    private Integer deleted;
}

5> 编写 Mapper 接口类 UserMapper.java,继承BaseMapper

package com.nianxi.mybatisplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.nianxi.mybatisplus.entity.User;


public interface UserMapper extends BaseMapper<User> {

}

6> 创建启动类，指定mapper包

package com.nianxi.mybatisplus;

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

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

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

}

7> 测试代码

@SpringBootTest
public class MpDemo1 {
    
    //注入mapper
    @Autowired
    private UserMapper userMapper;

    //查询所有记录
    @Test
    public void findAll() {
        List<User> list = userMapper.selectList(null);
        list.forEach(user->{
            System.out.println(user.getName());
            System.out.println(user.getAge());
        });
    }
}

使用了junit测试依赖

四. CRUD操作

@SpringBootTest
public class MpDemo1 {

    //注入mapper
    @Autowired
    private UserMapper userMapper;

    //1 查询所有记录 selectList
    @Test
    public void findAll() {
        List<User> list = userMapper.selectList(null);
        list.forEach(user->{
            System.out.println(user.getName()+":"+user.getAge());
        });
    }

    //2 添加操作insert
    @Test
    public void addUser() {
        //创建对象，设置值
        User user = new User();
        user.setName("东方不败");
        user.setAge(30);
        user.setEmail("dfbb@atguigu.com");
        //调用方法
        int rows = userMapper.insert(user);
        System.out.println(rows);
        System.out.println(user);
    }

    //3 根据id查询
    @Test
    public void getUserById() {
        User user = userMapper.selectById(1L);
        System.out.println(user);
    }

    //4 修改操作
    @Test
    public void updateUser() {
        //根据id查询
        User user = userMapper.selectById(1L);

        //设置修改值
        user.setName("岳不群");
        user.setAge(50);

        //调用方法完成修改
        int rows = userMapper.updateById(user);
        System.out.println(rows);
    }

    //5 删除操作
    @Test
    public void deleteUser() {
        userMapper.deleteById(2L);
    }

    //6 条件查询
}

//6 条件查询
//select * from user where name=? and age=?
@Test
public void select1() {
    //封装条件对象
    LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
    wrapper.eq(User::getName,"Tom");
    wrapper.eq(User::getAge,28);
    //调用方法
    List<User> list = userMapper.selectList(wrapper);
    list.forEach(user->{
        System.out.println(user.getName()+":"+user.getAge());
    });
}

//select * from user where age>=28
@Test
public void select2() {
    LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
    wrapper.ge(User::getAge,28);
    //调用方法
    List<User> list = userMapper.selectList(wrapper);
    list.forEach(user->{
        System.out.println(user.getName()+":"+user.getAge());
    });
}

//select * from user name like ?
@Test
public void select3() {
    LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
    wrapper.like(User::getName,"m");
    //调用方法
    List<User> list = userMapper.selectList(wrapper);
    list.forEach(user->{
        System.out.println(user.getName()+":"+user.getAge());
    });
}

删除操作有逻辑删除和物理删除

逻辑删除是在数据库新字段deleted上面进行修改操作

实体使用注释

  @TableLogic //逻辑删除

在配置文件指定逻辑删除规则，默认0没有删除，1删除

• 细节问题：查询时候，只会查询到没有删除的数据（mp封装）

五. 主键策略

mp默认主键策略，生成唯一的值

第一个策略：ASSIGN_ID

• 生成唯一的值，包含数字，表对应字段类型bigint或者varchar类型

第二个策略：ASSIGN_UUID

• 生成唯一的值，包含数字和字母，表对应字段类型varchar类型

第三个策略：AUTO

• 主键自动增长效果，和表字段auto_increment

第四个策略：INPUT

• 需要手动设置id值

以上策略想要实现数据库的属性类型必须匹配，否则会默认生成雪花算法

六. 分页查询

• mp自带分页插件，只需要简单配置，方便实现分页查询操作

1>  创建配置类，配置分页插件

package com.nianxi.mybatisplus.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 MpConfig {
    // 配置分页插件
    /**
     * 分页插件
     */
    @Bean
    public MybatisPlusInterceptor optimisticLockerInnerInterceptor(){
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //向Mybatis过滤器链中添加分页拦截器
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

2> 调用mapper里面方法进行分页查询

//分页查询
@Test
public void selectPage() {
    //创建page对象，传递分页参数：当前页和每页显示记录数
    Page<User> page = new Page<>(1,3);
    
    //调用mapper里面方法实现分页查询，返回Page对象，Page对象里面包含分页之后所有数据
    IPage<User> pageModel = userMapper.selectPage(page, null);
    List<User> list = pageModel.getRecords();
    list.forEach(user->{
        System.out.println(user.getName()+"::"+user.getAge());
    });
    long total = pageModel.getTotal();
    System.out.println(total);
}