Mybatis-plus使用教程

教程目录：
教程一： Mybatis-plus使用教程
教程二：mybatis-plus的字段自动填充
教程三：Mybatis实现物理删除和逻辑删除
教程四：Mybatis-plus实现乐观锁
教程五：Mybatis-plus实现条件查询

扫码关注公众号，更多资料尽在掌握。
在这里插入图片描述

1.概述。
首先，需要看mybatis-plus的官方文档可以点击此处：mybatis-plus官方文档
mybatis-plus是mybatis的升级版，比它更强大！在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。
首先看下官方给他的描述吧！
无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

废话不多说，想要了解更多，请参考官方文档，接下来直接上手！

2.使用springboot操作Mybatis-plus
2.1.首先在mysql中建立一张user表，随便插入几个数据，
在这里插入图片描述

建表语句：

DROP TABLE IF EXISTS `user`;
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;

2.2.新建一个Springboot项目，引入mybatis-plus等依赖。
在这里插入图片描述
引入相关依赖：

<?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.4.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>mybatis-plus</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mybatis-plus</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

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

        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2.3.在application.properties里配置mysql的相关连接属性。

#连接端口
server.port=8001

# mysql数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root

#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

2.4.编写实体类、Mapper层。
User.java:

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

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

}

注意这里的id是Long类型。

Mapper层：

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

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

这里只需要继承BaseMapper类，把实体传入即可，在BaseMapper类里给我们封装了很多方法，我们只需调用即可。

在这里插入图片描述
在这里插入图片描述

这样完成之后，务必要记得在启动类中添加扫描Mapeper的注解：
在这里插入图片描述

我们测试一下是否跑通，打开测试类 我们先写几个方法。


import com.example.mybatisplus.entity.User;
import com.example.mybatisplus.mapper.UserMapper;
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 MybatisPlusApplicationTests {
    @Autowired
    private UserMapper userMapper;

    //获取user表所有数据
    @Test
    void getData() {
         List<User> users = userMapper.selectList(null);
        System.out.println(users);
    }

    //增加数据手动设置主键ID
//    @Test
//    void insertData() {
//        User user = new User(6l,"张三",20,"1223@qq.com");
//         int result = userMapper.insert(user);
//        System.out.println("返回结果，1代表插入成功，0代表失败："+result);
//    }

    //增加数据不设置主键ID(由mybatis_plus自动生成主键。)
    //利用snowflake算法自动生成一个19位的Long型ID.
    @Test
    void insertDataOne() {
        User user = new User();
        user.setAge(40);
        user.setName("李四四");
        user.setEmail("1221233@qq.com");
        int result1 = userMapper.insert(user);
        System.out.println("返回结果，1代表插入成功，0代表失败："+result1);
    }

    //删除数据
    @Test
    void deleteData() {

    }
    //修改数据
    @Test
    void updateData() {
        User user = new User();
        user.setId(1368889981593976833l);
        user.setName("修改了数据");
        user.setEmail("1231231@qq.com");
         int row = userMapper.updateById(user); //返回的数据是影响的行数
    }
    //条件查询（复杂查询）


}

首先，运行getData()方法，在控制台就会返回user表中的所有数据：
在这里插入图片描述

添加方法，一个是手动传入id,一个是用mybatis-plus自动生成id,添加方法返回是一个数字，返回结果1代表插入成功，0代表失败。自动生成id稍后会讲到。
在这里插入图片描述

到这里，查询和添加方法测试成功了， 其他的就不测试了，具体可下载源码测试。接下来我们来探讨一下表中主键ID的生成策略吧！

ID生成策略

数据库表里通常都会有一个主键id，来作为这条数据的唯一标识。 id的生成策略有很多种。我们来看看

1.数据库自动增长。
这种是最常见的，可以做到全库唯一。即在你设计表的时候选中自动递增即可
在这里插入图片描述

2 UUID
每次都随机生成一个唯一的值，不过因为是随机，所以排序的时候麻烦。

3.Mybatis-plus方式自动生成ID
在我们刚刚测试用户添加的时候，我们并没有设置主键id,但是查看数据库发现自动生成了一位19位数的id.
在这里插入图片描述
这个就是mybatis-plus的自动生成id值
对其配置也很简单，在实体类的主键上加注解，@TableId(type = IdType.ID_WORKER)即可。
在这里插入图片描述
那么这个WROKER代表什么含义呢？刚刚我没有配置这个注解为啥也会自动生成呢？
我们按住ctrl 点击ID_WORKER看下：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by FernFlower decompiler)
//

package com.baomidou.mybatisplus.annotation;

public enum IdType {
    AUTO(0),
    NONE(1),
    INPUT(2),
    ID_WORKER(3),
    UUID(4),
    ID_WORKER_STR(5);

    private int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

你会发现这是一个枚举，列出了几个值，我们分别看下这些值的含义：
AUTO：就是利用数据库自增了
NONE：未设置，需要手动设置值
INPUT： 需要手动设置值
UUID：生成UUID类型的主键id
ID_WORKER：生成19位的值，数字类型
ID_WORKER_STR：生成19位的值，字符串类型

这里强调最后两个ID_WORKER、ID_WORKER_STR。当我们id值为long类型，就默认是ID_WORKER，所以当时没有配置也生效。当我们的id值是string类型，默认ID_WORKER_STR。所以根据自己的情况来设置值。
在这里插入图片描述

关于mybatis-plus的这个19位值的生成，可以做个了解，利用了snowflake算法。
snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。

到这里，id的自动生成策略就介绍完了，其实还有redis生成id这些就不一一赘述了。

接下来我们看看mybatis-plus的字段自动填充。

先说明一下，什么是自动填充？就是我们没有设置该字段的值，但是它会在添加数据的时候自动填充，
使用场景：数据的创建时间，修改时间。这些数据不用我们手动输入，让mybatis-plus来帮我们填充，
而且这些字段也是符合阿里巴巴数据库设计规范的。有了数据的创建时间和修改时间，会让数据更加清晰。
在这里插入图片描述

接下来我们就实现一下吧。

第一步，在数据表中添加两个字段， 一个创建时间，一个修改时间，类型为datetime.
在这里插入图片描述

第二步，在实体类中加上相应的字段。

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.ID_WORKER)
    private Long id;
    private String name;
    private Integer age;
    private String email;

    //create_time
    private Date createTime;
    private  Date updateTime;
}

这里说明一点，在数据表中，名称是create_time，在实体类中就这样写createTime，要遵守驼峰命名。

第三步、在你要自增的字段上添加注解。@TableField(fill = FieldFill.INSERT) 或者 @TableField(fill = FieldFill.INSERT_UPDATE) ，
这里INSERT是插入的时候生效；
INSERT_UPDATE是第一次插入即修改的时候生效。

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Date;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @TableId(type = IdType.ID_WORKER)
    private Long id;
    private String name;
    private Integer age;
    private String email;

    //create_time
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private  Date updateTime;
}

在这里插入图片描述

第四步、自定义实现类 MyMetaObjectHandler ， 我们就把他放在handler目录下。这个类就是实现MetaObjectHandler 类，重写两个方法，一个当mp实现添加操作的时候，这个方法执行，一个当mp实现修改操作的时候，这个方法执行。还有别忘记
添加@Component注解，交给spring管理。

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

  //当mp实现添加操作的时候，这个方法执行
    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    //当mp实现修改操作的时候，这个方法执行
    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);

    }
}

在这里插入图片描述
现在我们来测试一下，这里就只能用insertDataOne()方法了。
在这里插入图片描述

成功之后看一下数据表。成功了。
在这里插入图片描述

我们在来测试一下修改：
在这里插入图片描述

在这里插入图片描述
再看一下数据表中是否修改成功，成功啦，创建时间没有改变，修改时间改变了，符合逻辑！
在这里插入图片描述

总之就先写这么多吧，以后慢慢补充，
学无止境，加油，后浪！

项目源码：

github地址

# 数据库 # mysql # java
Logo
华为云开发者联盟

为开发者提供学习成长、分享交流、生态实践、资源工具等服务，帮助开发者快速成长。

更多推荐

cover

第六届·2024 MindSpore 量子计算黑客松热身赛赛题解读

avatar 华为云开发者联盟
cover

连升三级！openGauss单机版从2.1.0经停3.0.0升级至5.0.0

avatar 华为云开发者联盟
cover

带你熟悉CCE集群增强型CPU管理策略enhanced-static

avatar 华为云开发者联盟