MybatisPlus(下称MP)是Mybatis的增强版,比Mybatis更加易用,与Mybatis形成了很好的互补关系。
本文将对MP的基本使用进行介绍。
SpringBoot整合MP
本文基于Spring Boot框架使用MP,请读者确保自己是在SpringBoot项目中运行本文的代码。
将以下依赖加入到项目的 pom.xml 中:
<!-- springboot数据库连接 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!-- mybatis-plus依赖 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
<!-- mariadb数据库依赖 -->
<dependency>
<groupId>org.mariadb.jdbc</groupId>
<artifactId>mariadb-java-client</artifactId>
</dependency>
注意,本文还是用到了 lombok
依赖,请读者自行添加。
第一个MP示例
准备数据表
创建示例数据库:
create database mybatis_plus
创建示例数据表:
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
添加测试数据:
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');
结果:
+----+-----------+------+--------------------+
| id | name | age | email |
+----+-----------+------+--------------------+
| 1 | Jone | 18 | test1@baomidou.com |
| 2 | Jack | 20 | test2@baomidou.com |
| 3 | Mark | 28 | test6@qq.com |
| 4 | Sandy | 21 | test4@baomidou.com |
| 5 | Billie | 24 | test5@baomidou.com |
| 6 | John Wick | 32 | 123@qq.com |
+----+-----------+------+--------------------+
第一个示例
项目文件夹如下:
1)在entity包中创建User类,代码如下:
@Data
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
2)在mapper包下创建UserMapper接口,该接口继承了MP的BaseMapper接口,代码如下:
@Repository
public interface UserMapper extends BaseMapper<User> {
}
3)编写配置文件。在 application.yml 中写入如下配置:
# 数据库基本配置
spring:
datasource:
driver-class-name: org.mariadb.jdbc.Driver
url: jdbc:mariadb://localhost:3307/mybatis_test
username: root
password: 123
# 打开MP日志功能
logging:
level:
com.ai.mapper: debug
3)在Application类中,打上@MapperScan注解,让Spring扫描mapper包(这一步不能缺,否则MP无法正常运行):
@SpringBootApplication
@MapperScan("com.ai.mapper")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
4)在ApplicationTests中编写如下代码,查询user表中的所有数据:
@SpringBootTest
class ApplicationTests {
@Autowired
UserMapper userMapper;
// 查询User表所有数据
@Test
public void findAll() {
List<User> users = userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
}
}
结果:
MP数据添加操作
在上文的基础上,下面使用MP实现数据库中添加数据操作。
在ApplicationTests类中添加如下代码,测试MP的数据添加功能:
@Test
public void addUser(){
User user = new User();
user.setName("Hello");
user.setAge(43);
user.setEmail("1235@qq.com");
int res = userMapper.insert(user);
System.out.println("影响行数:" + res);
}
注意,上面的代码中,没有指定User对象的id值,MP会自动生成 id 值,并且MP为记录的 id 生成提供了多种策略(主键生成策略)。
结果:
+---------------------+-----------+------+--------------------+
| id | name | age | email |
+---------------------+-----------+------+--------------------+
| 1 | Jone | 18 | test1@baomidou.com |
| 2 | Jack | 20 | test2@baomidou.com |
| 3 | Mark | 28 | test6@qq.com |
| 4 | Sandy | 21 | test4@baomidou.com |
| 5 | Billie | 24 | test5@baomidou.com |
| 6 | John Wick | 32 | 123@qq.com |
| 1417150540097269761 | Hello | 43 | 1235@qq.com |
+---------------------+-----------+------+--------------------+
主键生成策略
ID_WORKER
MyBatis-Plus默认的主键策略是:ID_WORKER 全局唯一ID
自增策略
要想主键自增需要配置如下主键策略
需要在创建数据表的时候设置主键自增
实体字段中配置 @TableId(type = IdType.AUTO)
@TableId(type = IdType.AUTO)
private Long id;
要想影响所有实体的配置,可以设置全局主键配置
#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto
其它主键策略:分析 IdType 源码可知
@Getter
public enum IdType {
/**
* 数据库ID自增
*/
AUTO(0),
/**
* 该类型为未设置主键类型
*/
NONE(1),
/**
* 用户输入ID
* 该类型可以通过自己注册自动填充插件进行填充
*/
INPUT(2),
/* 以下3种类型、只有当插入对象ID 为空,才自动填充。 */
/**
* 全局唯一ID (idWorker)
*/
ID_WORKER(3),
/**
* 全局唯一ID (UUID)
*/
UUID(4),
/**
* 字符串全局唯一ID (idWorker 的字符串表示)
*/
ID_WORKER_STR(5);
private int key;
IdType(int key) {
this.key = key;
}
}
具体见:分布式系统唯一ID生成方案汇总