Java EE 进阶:10. MyBatis-Plus使用(第一弹)

目录

[1.MyBatis-Plus 介绍](#1.MyBatis-Plus 介绍)

2.快速上手

[2.1 准备工作](#2.1 准备工作)

[2.1.1 数据准备](#2.1.1 数据准备)

[2.1.2 项目准备](#2.1.2 项目准备)

[2.2 编码](#2.2 编码)

[2.3 CRUD 单元测试](#2.3 CRUD 单元测试)

[3.MyBatis-Plus 复杂操作](#3.MyBatis-Plus 复杂操作)

[3.1 打印日志](#3.1 打印日志)

[3.2 常见注解](#3.2 常见注解)

[3.2.1 @TableName](#3.2.1 @TableName)

[3.2.2 @TableField](#3.2.2 @TableField)

[3.2.3 @TableId](#3.2.3 @TableId)


本节目标

  1. 学习使用MyBatis-Plus完成基础的增删改查

  2. 学习使用MyBatis-Plus的条件构造器以及自定义SQL完成一些复杂的查询

1.MyBatis-Plus 介绍

上篇博客讲述了用 MyBatis Generator 来生成代码,下面学习用 MyBatis-Plus 更简单的生成代码~~

刚刚我们的 MyBatis Generator,我只要告诉你了我的数据库连接信息,你都可以帮我把 SQL 生成了,那你为什么不能帮我把这些东西再封装一下呢?又何必再让我点一下 generate 呢?我们就是如此的懒,你都帮我做到这一步,就不能再多帮我做一点嘛?MyBatis 没有帮我们做,但是 MyBatis-Plus 帮我们做了,我们就直接不写 SQL 了~~

MyBatis-Plus(简称 MP) 是一个 MyBatis 的增强工具, 在 MyBatis 的基础上只做增强不做改变, 为简化开发. 提高效率而生

特性:

• 润物无声: 只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑.

• 效率至上: 只需简单配置,即可快速进行单表 CRUD 操作,从而节省大量时间.

• 丰富功能: 代码生成、自动分页、逻辑删除、自动填充、拦截器等功能一应俱全.

• 广泛认可: 连续 5 年获得开源中国年度最佳开源项目殊荣,Github 累计 16K Star.

支持数据库:

PostgreSQL, MySQL, MariaDB, Oracle, SQL Server, OceanBase, H2, DB2...

(任何能使用 MyBatis 进行增删改查,并且支持标准 SQL 的数据库应该都在 MyBatis-Plus 的支持范围内)

官网地址: MyBatis-Plus 🚀 为简化开发而生

​

闲聊:总之就是好用~~

2.快速上手

Mybatis-Plus操作数据库的步骤:

  1. 准备工作(数据准备, 项目准备, 引入依赖, 配置数据库连接信息)

  2. 编码(数据库表对应的实体类, 以及数据操作的Mapper文件)

  3. 测试

2.1 准备工作

咱们再新建个项目,这次只用 Web 和 MySQL驱动就行了👇(补充:再加个 Lombok,后续要用)

依旧把没有的东西删掉👇

2.1.1 数据准备

创建用户表,并创建对应的实体类 User

继续使用 MyBatis 学习阶段的数据库表就可以

sql 复制代码
-- 创建数据库
DROP DATABASE IF EXISTS mybatis_test;
CREATE DATABASE mybatis_test DEFAULT CHARACTER SET utf8mb4;

-- 使用数据库
USE mybatis_test;

-- 创建表[用户表]
DROP TABLE IF EXISTS user_info;

CREATE TABLE `user_info` (
    `id` INT ( 11 ) NOT NULL AUTO_INCREMENT,
    `username` VARCHAR ( 127 ) NOT NULL,
    `password` VARCHAR ( 127 ) NOT NULL,
    `age` TINYINT ( 4 ) NOT NULL,
    `gender` TINYINT ( 4 ) DEFAULT '0' COMMENT '1-男 2-女 0-默认',
    `phone` VARCHAR ( 15 ) DEFAULT NULL,
    `delete_flag` TINYINT ( 4 ) DEFAULT 0 COMMENT '0-正常,1-删除',
    `create_time` DATETIME DEFAULT now(),
    `update_time` DATETIME DEFAULT now(),
    PRIMARY KEY ( `id` )
) ENGINE = INNODB DEFAULT CHARSET = utf8mb4;

-- 添加用户信息
INSERT INTO mybatis_test.user_info( username, `password`, age, gender, phone )
VALUES ( 'admin', 'admin', 18, 1, '18612340001' );
INSERT INTO mybatis_test.user_info( username, `password`, age, gender, phone )
VALUES ( 'zhangsan', 'zhangsan', 18, 1, '18612340002' );
INSERT INTO mybatis_test.user_info( username, `password`, age, gender, phone )
VALUES ( 'lisi', 'lisi', 18, 1, '18612340003' );
INSERT INTO mybatis_test.user_info( username, `password`, age, gender, phone )
VALUES ( 'wangwu', 'wangwu', 18, 1, '18612340004' );

2.1.2 项目准备

  1. 创建springboot工程

  2. 添加 MyBatis-Plus 和 MySQL 依赖, 配置数据库连接信息

(我们后续可以不用重复引用 MyBatis 依赖了,直接引用 MyBatis-Plus 依赖就可以了)

添加依赖

你用的是 SpringBoot 多少就添加对应依赖👇

在这里看,开头是多少就是 SpringBoot 多少👇

Spring Boot2

XML 复制代码
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.18</version>
</dependency>

Spring Boot3

XML 复制代码
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
    <version>3.5.18</version>
</dependency>

SpringBoot4(自3.5.13开始)

XML 复制代码
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-spring-boot4-starter</artifactId>
    <version>3.5.18</version>
</dependency>

直接 CV 过来👇

MySQL

XML 复制代码
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <scope>runtime</scope>
</dependency>

配置数据库

不管多强大的工具都需要告诉它你要操作的数据库以及你的账号和密码~~

application.yml文件, 配置内容如下:

XML 复制代码
spring:
  application:
    name: mybatis-plus-demo
  # 数据库连接配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/mybatis_test?characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=true
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

application.properties文件, 配置内容如下:(课件内容)

java 复制代码
#驱动类名称
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#数据库连接的url
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/mybatis_test?characterEncoding=utf8&useSSL=false
#连接数据库的用户名
spring.datasource.username=root
#连接数据库的密码
spring.datasource.password=root

2.2 编码

创建实体类 UserInfo

实体类的属性名与表中的字段名一 对应

java 复制代码
import lombok.Data;
import java.util.Date;

@Data
public class UserInfo {
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private Integer gender;
    private String phone;
    private Integer deleteFlag;
    private Date createTime;
    private Date updateTime;
}

编写Mapper接口类

MybatisPlus 提供了一个基础的 BaseMapper 接口,已经实现了单表的CRUD, 我们自定义的
Mapper 只需要继承这个 BaseMapper, 就无需自己实现单表CRUD了

BaseMapper<> 是一个泛型,里面是你要操作的对象,比如说像 insert👇​

java 复制代码
@Mapper
public interface UserInfoMapper extends BaseMapper<UserInfo> {
}

也可以在启动类上添加 @MapperScan , 扫描Mapper文件夹, 二选一即可.

BaseMapper 给我们提供了多种多样的 CRUD 方法👇

此时我们的 Mapper 就写完了,直接进行测试👇

2.3 CRUD 单元测试

在创建出来的SpringBoot工程中,在 src 下的 test 目录下,已经自动帮我们创建好了测试类 ,我们可以直接使用这个测试类来进行测试.

比如 insert,我们写的时候就能发现它给我们提供了多种方式,我们可以传对象,也可以传集合(用于批量插入)👇

先把数据库中的 user_info 表清理一下,全删掉👇

下面来伪造数据,先测一下插入👇

java 复制代码
package com.bit.mybatis.plus.mapper;

import com.bit.mybatis.plus.model.UserInfo;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class UserInfoMapperTest {
    private UserInfoMapper userInfoMapper;

    @Test
    void insert(){
        UserInfo userInfo = new UserInfo();
        userInfo.setUsername("admin");
        userInfo.setPassword("123456");
        userInfo.setAge(15);
        userInfo.setPhone("45667788");
        userInfoMapper.insert(userInfo);
    }
}

发现值为 null👇

这是因为 userinfoMapper 咱只是声明了一下没有注入,下面加上 @Autowired 注入,再来测试👇

发现确实插入成功了👇

从这就能看出来,我们不用再去声明了,也不用再写 SQL 语句了,直接就能 insert

但是大家发没发现,这个 id 不太对劲儿,我们再来执行一次插入,发现我们设置的是自增的,但是这里不是自增的👇

这是因为我们的 MyBatis-Plus 按照一定的规则把 id 给生成了然后进行插入,但是我们并不需要它生成 id,这时候需要我们在实体类里面写一个 @TableId 注释,表示这是一个主键👇

java 复制代码
@Data
public class UserInfo {
    @TableId()
    //......
}

点进去我们发现会有一个 type👇

这个 type 默认是个 NONE,我们需要把它设置成 AUTO👇

这时就会变成自增 Id 了,我们再插入两次,发现它是在原有基础上自增的👇

这时候就需要我们手动改成 1、2、3、4,然后在这个地方改成5👇

点击保存就好了,我们再来插入一条,发现就没问题了👇

java 复制代码
package com.bit.mybatis.plus.model;

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

import java.util.Date;

@Data
public class UserInfo {
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private Integer gender;
    private String phone;
    private Integer deleteFlag;
    private Date createTime;
    private Date updateTime;
}

下面再来测试删、改、查:

测试删除:删除 Id 为 5 的数据

java 复制代码
    @Test
    void delete(){
        userInfoMapper.deleteById(5);
    }

刷新后发现删除成功👇

测试更新:更新 Id 为 4 的数据

java 复制代码
    @Test
    void update(){
        UserInfo userInfo = new UserInfo();
        userInfo.setId(4);
        userInfo.setUsername("admin444");
        userInfo.setPassword("admin444");
        userInfo.setAge(4);
//        userInfo.setPhone("45667788");//电话号码不更新了
        userInfoMapper.updateById(userInfo);
    }

发现更新成功👇

测试查询:查询 Id 为 4 的数据

java 复制代码
    @Test
    void select(){
        UserInfo userInfo = userInfoMapper.selectById(4);
        System.out.println(userInfo);
    }

发现确实查询出来了👇

3.MyBatis-Plus 复杂操作

3.1 打印日志

为了方便学习, 我们可以借助日志, 查看 Mybatis-Plus 执行的SQL语句, 参数和执行结果

Mybatis-Plus 配置日志如下:

java 复制代码
mybatis-plus:
    configuration: # 配置打印 MyBatis日志
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

此时的配置文件👇

java 复制代码
spring:
  application:
    name: mybatis-plus-demo
  # 数据库连接配置
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/mybatis_test?characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=true
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
mybatis-plus:
  configuration: # 配置打印 MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

再执行一下上面的查询语句,可以发现日志已经把我们对应的 SQL 语句都打印出来了👇

3.2 常见注解

在上面的程序中, MyBatis是如何知道, 我们要操作的是哪张表, 表里有哪些字段呢?

我们来看下咱们 Mapper 的代码,可以说啥都没有👇

java 复制代码
@Mapper
public interface UserInfoMapper extends BaseMapper<UserInfo> {
}

Mybatis 怎么就知道我调用了 userInfoMapper,它怎么就知道我要查询的是 user_info 表,而不是 message_info 表?不是 article_info 表呢??

其实是通过实体类的名称来区分的,MyBatis 会根据你的实体类的名称来推断你的表名,它知道我们 Java 的开发规则,然后知道数据库的开发规则,就可以推断出你的表名,比如:

实体类:ArticleInfo→表:article_info

实体类:MessageInfo→表:message_info

实体类:UserInfo→表:user_info

这也体现出规范命名的重要性~~

UserInfoMapper 在继承 BaseMapper 时, 指定了一个泛型, 这个 UserInfo 就是与数据库表相对应的实体类.
MyBatis-Plus 会根据这个实体类来推断表的信息.
默认情况下:

  1. 表名: 实体类的驼峰表示法转换成蛇形表示法(下划线分割), 作为表名. 比如 UserInfo -> user_info
  2. 字段: 根据实体类的属性名 转换为蛇形表示法作为字段名. 比如 deleteFlag -> delete_flag
  3. 主键: 默认为id

那如果实体类和数据库不是按照上述规则定义的呢? 比如一些资历不深的程序员压根都不知道这些规范呢?MyBatis-Plus也给我们提供了一下注解, 让我们标识表的信息.

3.2.1 @TableName

修改实体类名 UserInfo为 Userinfo👇

java 复制代码
@Data
public class Userinfo {
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private Integer gender;
    private String phone;
    private Integer deleteFlag;
    private Date createTime;
    private Date updateTime;
}

重新执行测试查询👇发现报错了,表名不存在​

从日志可以看到, 默认查找的表名为 userinfo,但是没找到~~

我们可以通过@TableName 来标识实体类对应的表

java 复制代码
@Data
@TableName("user_info")
public class Userinfo {
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private Integer gender;
    private String phone;
    private Integer deleteFlag;
    private Date createTime;
    private Date updateTime;
}

再次运行程序, 程序运行结果正常👇

3.2.2 @TableField

如果说我们的字段也不规范呢??修改属性名 deleteFlag 为 deleteflag👇重新执行测试查询方法

java 复制代码
@Data
@TableName("user_info")
public class Userinfo {
    //......
    private Integer deleteflag;
    //......
}

运行结果👇显示 deleteflag 这个列不存在

​

从日志可以看到, 根据属性名转换后的字段名为: deleteflag.

我们可以通过@TableField 来标识 对应的字段名

java 复制代码
@Data
@TableName("user_info")
public class Userinfo {
    @TableId(type = IdType.AUTO)
    private Integer id;
    private String username;
    private String password;
    private Integer age;
    private Integer gender;
    private String phone;
    @TableField("delete_flag")
    private Integer deleteflag;
    private Date createTime;
    private Date updateTime;
}

再次运行程序, 程序运行结果正常👇

闲聊:所以说对于 MyBatis-Plus,你要是规范,啥都可以不写,它会自动根据我们的实体类去拼接 SQL,但要是不规范,就要去指定了~~

3.2.3 @TableId

在 2.3 CRUD 单元测试部分讲过了,那么当我们的 id 不为主键的时候,我们应该如何去做?

修改属性名 id 为 userId👇

把实体类名称也相应从 id 改为 userId,并重新执行查询方法

java 复制代码
@Data
@TableName("user_info")
public class Userinfo {
    private Integer userId;
    //......
}

更新这里也改成 UserId,不然报错👇

java 复制代码
    @Test
    void update(){
        Userinfo userInfo = new Userinfo();
        userInfo.setUserId(4);
        //......
    }

运行结果👇我们发现它没找到

​

因为我们默认主键为:id,而此时是 userId,也没加注释,自然找不到

我们可以通过@TableId 来 指定对应的主键

java 复制代码
@Data
@TableName("user_info")
public class Userinfo {
    @TableId(type = IdType.AUTO)
    private Integer userId;
    //......
}

此时就好了👇

如果属性名和字段名不一致, 需要在@TableId 指明对应的字段名
属性名和字段一致的情况下, 直接加@TableId 注解就可以.

再次运行程序, 程序运行结果正常.

相关推荐
一条Go1 小时前
状态页与 SLA:对外承诺是怎么算出来的
后端·架构·github
喵个咪1 小时前
GoWind IM 场景:乙方怎么用一套 IM 平台交付多个客户——档位、租户与离线交付
后端·go·saas
大胖爱学习_MJ2 小时前
超越向量检索:用 Spring Boot + Neo4j 手搓 GraphRAG 知识图谱记忆
java·后端·python
吃我一窝jio3 小时前
Java博客极简写作三支柱
java
知识搬运临时工3 小时前
双路服务器跑得比单路慢:JVM 没看见内存的距离
java·后端
Gopher_HBo3 小时前
mprof.go全程跟拍-跟着一个请求走完四种采集
后端
吃我一窝jio3 小时前
Java Bug复盘与性能优化实战
java·开发语言·笔记
tong_li3 小时前
给娃做个 AI 陪写作业助手:LangChain4j 入门(三):配本古诗书(RAG 入门),答得不瞎编
后端
用户48678952533904 小时前
多租户第二集:读隔离做完之后,写路径才是真坑
后端