当前位置：首页 > news >正文

MyBatisPlus-快速入门

news 来源：原创 2025/6/29 23:54:38

Mybatis是持久层框架，主要用于数据库的增删改查。MybatisPlus是对Mybatis的增强，MybatisPlus并不是用于替代Mybatis的，两者之间是协作的关系。MybatisPlus 仅需进行简易配置，就能实现单表的 CRUD 操作。在日常开发中，单表的CRUD功能代码重复度很高，也没有什么难度。而这部分代码量往往比较大，开发起来比较费时。因此，目前企业中都会使用一些组件来简化或省略单表的CRUD开发工作。目前在国内使用较多的一个组件就是MybatisPlus.

官方网站

当然，MybatisPlus不仅仅可以简化单表操作，而且还对Mybatis的功能有很多的增强。可以让我们的开发更加的简单，高效。

学习目标：

能利用MybatisPlus实现基本的CRUD
会使用条件构建造器构建查询和更新语句
会使用MybatisPlus中的常用注解
会使用MybatisPlus处理枚举、JSON类型字段
会使用MybatisPlus实现分页

快速入门

为了方便测试，我们先创建一个新的项目，并准备一些基础数据。

在这里插入图片描述

环境准备

复制课前资料提供好的一个项目到你的工作空间（不要包含空格和特殊字符）：

通过网盘分享的文件：mp-demo等2个文件
链接: https://pan.baidu.com/s/1gQmwIKY4xr_vqLCFkn-xrw?pwd=ejzf 提取码: ejzf
–来自百度网盘超级会员v4的分享

在这里插入图片描述

然后用你的IDEA工具打开，项目结构如下：

在这里插入图片描述

注意配置一下项目的JDK版本，首先点击Project Structure，在弹窗中配置JDK：

在这里插入图片描述

接下来，要导入两张表，在课前资料中已经提供了SQL文件：

在这里插入图片描述

对应的数据库表结构如下：

在这里插入图片描述

最后，在application.yaml中修改jdbc参数为你自己的数据库参数：

spring:datasource:url: jdbc:mysql://127.0.0.1:3306/mp?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghaidriver-class-name: com.mysql.cj.jdbc.Driverusername: rootpassword: 1234
logging:level:com.itheima: debugpattern:dateformat: HH:mm:ss

快速开始

比如我们要实现User表的CRUD，只需要下面几步：

引入MybatisPlus依赖
定义Mapper

引入依赖

MybatisPlus提供了starter，实现了Mybatis以及MybatisPlus的自动装配功能，坐标如下：

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

由于这个starter包含对mybatis的自动装配，因此完全可以替换掉Mybatis的starter。最终，项目的依赖如下：

在这里插入图片描述

定义Mapper

为了简化单表CRUD，MybatisPlus提供了一个基础的BaseMapper接口，其中已经实现了单表的CRUD：

在这里插入图片描述

因此我们自定义的Mapper只要实现了这个BaseMapper，就无需自己实现单表CRUD了。修改mp-demo中的com.itheima.mp.mapper包下的UserMapper接口，让其继承BaseMapper。在继承时要指定泛型为实体类的类型，只有这样才能知道增删改查操作的哪个实体：

在这里插入图片描述

测试

新建一个测试类，编写几个单元测试，测试基本的CRUD功能：

package com.itheima.mp.mapper;import com.itheima.mp.domain.po.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;import java.time.LocalDateTime;
import java.util.List;@SpringBootTest
class UserMapperTest {@Autowiredprivate UserMapper userMapper;@Testvoid testInsert() {User user = new User();user.setId(5L);user.setUsername("Lucy");user.setPassword("123");user.setPhone("18688990011");user.setBalance(200);user.setInfo("{\"age\": 24, \"intro\": \"英文老师\", \"gender\": \"female\"}");user.setCreateTime(LocalDateTime.now());user.setUpdateTime(LocalDateTime.now());userMapper.insert(user);}@Testvoid testSelectById() {User user = userMapper.selectById(5L);System.out.println("user = " + user);}@Testvoid testSelectByIds() {List<User> users = userMapper.selectBatchIds(List.of(1L, 2L, 3L, 4L, 5L));users.forEach(System.out::println);}@Testvoid testUpdateById() {User user = new User();user.setId(5L);user.setBalance(20000);userMapper.updateById(user);}@Testvoid testDelete() {userMapper.deleteById(5L);}
}

可以看到，在运行过程中打印出的SQL日志，非常标准：

11:05:01  INFO 15524 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
11:05:02  INFO 15524 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
11:05:02 DEBUG 15524 --- [           main] c.i.mp.mapper.UserMapper.selectById      : ==>  Preparing: SELECT id,username,password,phone,info,status,balance,create_time,update_time FROM user WHERE id=?
11:05:02 DEBUG 15524 --- [           main] c.i.mp.mapper.UserMapper.selectById      : ==> Parameters: 5(Long)
11:05:02 DEBUG 15524 --- [           main] c.i.mp.mapper.UserMapper.selectById      : <==      Total: 1
user = User(id=5, username=Lucy, password=123, phone=18688990011, info={"age": 21}, status=1, balance=20000, createTime=Fri Jun 30 11:02:30 CST 2023, updateTime=Fri Jun 30 11:02:30 CST 2023)

只需要继承BaseMapper就能省去所有的单表CRUD，是不是非常简单！

常见注解

在刚刚的入门案例中，我们仅仅引入了依赖，继承了BaseMapper就能使用MybatisPlus，非常简单。但是问题来了： MybatisPlus如何知道我们要查询的是哪张表？表中有哪些字段呢？

MP通过扫描实体类，并基于反射获取实体类信息作为数据库表信息。

UserMapper在继承BaseMapper的时候指定了一个泛型，泛型中的User就是与数据库对应的PO（实体类类型）。

在这里插入图片描述

MybatisPlus就是根据PO实体的信息来推断出表的信息，从而生成SQL的。默认情况下：

MybatisPlus会把PO实体的类名驼峰转下划线作为表名
MybatisPlus会把PO实体的所有变量名驼峰转下划线作为表的字段名，并根据变量类型推断字段类型
MybatisPlus会把名为id的字段作为主键

但很多情况下，默认的实现与实际场景不符，因此MybatisPlus提供了一些注解便于我们声明表信息。符合约定就无需配置，不符合约定就需要自己配置。

@TableName

说明：

描述：表名注解，标识实体类对应的表
使用位置：实体类

示例：

表名为tb_name，类名为User，不符合驼峰命名。通过@TableName注解，mp利用反射找到真实的表名。

@TableName("tb_user")
public class User {private Long id;private String name;
}

TableName注解除了指定表名以外，还可以指定很多其它属性：

属性	类型	必须指定	默认值	描述
value	String	否	“”	表名
schema	String	否	“”	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时）
resultMap	String	否	“”	xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）
excludeProperty	String[]	否	{}	需要排除的属性名 @since 3.3.1

@TableId

说明：

描述：主键注解，标识实体类中的主键字段
使用位置：实体类的主键字段

示例：

@TableName("user")
public class User {// @TableId("id")@TableId(value = "id", type = IdType.AUTO)private Long id;private String name;
}

主键可能有特殊的处理，比如AUTO_INCREMENT自增，这个在MP中称为类型或者id策略。可以通过@TableId注解中，通过type属性设置。

TableId注解支持两个属性：

属性	类型	必须指定	默认值	描述
value	String	否	“”	表名
type	Enum	否	IdType.NONE	指定主键类型

IdType支持的类型比较常见的有三种：

AUTO：利用数据库的id自增长
INPUT：通过set方法手动为id赋值
ASSIGN_ID：雪花算法生成Long类型的全局唯一id，这是默认的ID策略。

如果id有自增一定要加上IdType.AUTO类型，否则会默认使用雪花算法插入一个Long类型的整形。

在这里插入图片描述

@TableField

说明：

描述：普通字段注解

示例：

@TableName("tb_user")
public class User {@TableIdprivate Long id;private String name;private Integer age;@TableField("isMarried")private Boolean isMarried;@TableField("`concat`")private String concat;@TableField(exist = false)private String address
}

一般情况下我们并不需要给字段添加@TableField注解，一些特殊情况除外：

成员变量名与数据库字段名不一致
成员变量是以isXXX命名，按照JavaBean的规范，MybatisPlus识别字段时会把is去除，这就导致与数据库不符。
成员变量名与数据库一致，但是与数据库的关键字冲突。使用@TableField注解给字段名添加转义字符：`关键字`
成员变量不是数据库字段，默认情况下会被当成数据库字段，通过exist标记不存在。

支持的其它属性如下：

属性	类型	必填	默认值	描述
value	String	否	“”	数据库字段名
exist	boolean	否	true	是否为数据库表字段
condition	String	否	“”	字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}，参考(opens new window)
update	String	否	“”	字段 update set 部分注入，例如：当在version字段上注解update=“%s+1” 表示更新时会 set version=version+1 （该属性优先级高于 el 属性）
insertStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_NULL insert into table_a(column) values (#{columnProperty})
updateStrategy	Enum	否	FieldStrategy.DEFAULT	举例：IGNORED update table_a set column=#{columnProperty}
whereStrategy	Enum	否	FieldStrategy.DEFAULT	举例：NOT_EMPTY where column=#{columnProperty}
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理
jdbcType	JdbcType	否	JdbcType.UNDEFINED	JDBC 类型 (该默认值不代表会按照该值生效)
typeHandler	TypeHander	否		类型处理器 (该默认值不代表会按照该值生效)
numericScale	String	否	“”	指定小数点后保留的位数

总结

MP是如何获取实现CRUD的数据库表信息的？

约定大于配置，遵循约定就能根据实体类信息反射获取表信息，从而生成单表CRUD。约定就是类的名称驼峰转下划线作为表名，成员变量的驼峰转下划线作为字段名，名为id的作为主键。如果不遵循约定，就需要通过注解来声明。

MP的常见注解有哪些？

@TableName：指定表名。

@TableId：指定id字段

@TableField：指定不同字段

IdType常见的类型有哪些？

AUTO、ASSIGN_ID、INPUT

使用@TableField的常见场景?

成员变量名与数据库字段名不一致

成员变量名以is开头，且是布尔类型

成员变量与数据库关键字冲突

成员变量不是数据库字段

常见配置

MybatisPlus也支持基于yaml文件的自定义配置，详见官方文档：

官方网址

在这里插入图片描述

MP的配置项继承了MyBatis原生配置和一些自己特有的配置。除了别名扫描包配置，大多数的配置都有默认值，因此我们都无需配置。

实体类的别名扫描包，将来会扫描所有的po实体，在定义Mapper、XML中的sql语句时，如果需要定义实体类的类型就不需要写全路径名，直接写类的简化名。
全局id类型，优先级没有注解高，如果注解IdType配置了自增长，优先自增长。
更新策略，之前MP在updateById时，实体类中有哪些字段才会更新哪些字段，就是因为这个策略是not_null只更新非空。

mybatis-plus:type-aliases-package: com.itheima.mp.domain.poglobal-config:db-config:id-type: auto # 全局id类型为自增长

需要注意的是，MyBatisPlus也支持手写SQL的，而mapper文件的读取地址可以自己配置：

mybatis-plus:mapper-locations: "classpath*:/mapper/**/*.xml" # Mapper.xml文件地址，当前这个是默认值。

可以看到默认值是classpath*:/mapper/**/*.xml，也就是说我们只要把mapper.xml文件放置这个目录下就一定会被加载。

例如，我们新建一个UserMapper.xml文件：

在这里插入图片描述

然后在其中自定义一个sql方法：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.itheima.mp.mapper.UserMapper"><select id="queryById" resultType="User">SELECT * FROM user WHERE id = #{id}</select>
</mapper>

然后在测试类UserMapperTest中测试该方法：

@Test
void testQuery() {User user = userMapper.queryById(1L);System.out.println("user = " + user);
}

在这里插入图片描述

测试成功证明自定义的查询没有问题，可以扫描到mapper.xml文件。

快速入门

环境准备

快速开始

引入依赖

定义Mapper

测试

常见注解

@TableName

@TableId

@TableField

总结

常见配置

相关文章：