一、MyBatis-Plus简介
首先我们在学习每一个技术之前,我们应该先要找到关于这个技术方面的官方说明文档。MyBatis-Plus也不例外,这里我们首先找到MyBatis-Plus的官方说明文档。
MyBatis-plus官方说明文档
MyBatis-Plus (opens new window)(简称 MP)是一个 MyBatis (opens new window)的增强工具,在 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 操作智能分析阻断,也可自定义拦截规则,预防误操作
支持数据库:
任何能使用 MyBatis 进行 CRUD, 并且支持标准 SQL 的数据库,具体支持情况如下,如果不在下列表查看分页部分教程 PR 您的支持。
MySQL,Oracle,DB2,H2,HSQL,SQLite,PostgreSQL,SQLServer,Phoenix,Gauss ,ClickHouse,Sybase,OceanBase,Firebird,Cubrid,Goldilocks,csiidb,informix,TDengine,redshift
达梦数据库,虚谷数据库,人大金仓数据库,南大通用(华库)数据库,南大通用数据库,神通数据库,瀚高数据库,优炫数据库
框架结构:
二、构建第一个MyBatis-Plus程序
1、构建环境
首先我们导入一下官方文档中推荐进行测试的数据库
这里我们使用的是MySql数据库
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)
);
DELETE FROM user;
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');
引入 Spring Boot Starter 父工程:
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.5.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.imperfect</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>8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus版本-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>RELEASE</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
src/main/resources/application.properties
spring.datasource.username=账号
spring.datasource.password=密码
spring.datasource.url=jdbc:mysql://远程服务器地址以及端口/mybatis_plus?useUnicode=true&characterEncoding=utf8&useSSL=false
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
com/imperfect/MybatisPlusApplication.java
package com.imperfect;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
@MapperScan("com.imperfect.mapper")//包扫描位置
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
com/imperfect/pojo
编写对应的实体类
package com.imperfect.pojo;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.ibatis.annotations.ConstructorArgs;
/**
* @author : Imperfect(lxm)
* @Des:
* @date : 2023/1/4 16:15
*/
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private int age;
private String email;
}
com/imperfect/mapper/UserMapper.java
编写对应的mapper
package com.imperfect.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.imperfect.pojo.User;
import org.apache.ibatis.annotations.Mapper;
/**
* @author : Imperfect(lxm)
* @Des:
* @date : 2023/1/4 16:14
*/
@Mapper
public interface UserMapper extends BaseMapper<User> {
}
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
编写对应的测试类
package com.imperfect.mybatis_plus;
import com.imperfect.mapper.UserMapper;
import com.imperfect.pojo.User;
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(required = false)
private UserMapper userMapper;
@Test
void contextLoads() {
List<User> users = userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
}
}
2、测试用例
执行测试类执行结果如下:
其中这里我们可以注意到,因为我们配置了日志输出
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
这里我们可以从日志中找到我们这里使用的数据源为Hikari
JDBC Connection [HikariProxyConnection@783141366 wrapping com.mysql.cj.jdbc.ConnectionImpl@2903c6ff] will not be managed by Spring
预编译执行的SQL:
==> Preparing: SELECT id,name,age,email FROM user
3、总结:
public interface UserMapper extends BaseMapper<User>
这里我们可以看到在继承了BaseMapper之后,我们这里编写的mapper自动自动能够生成很多方便我们日常使用的方法,能够对数据库进行简单的操作,而不需要再额外去编写相对应的xml
三、插入测试及雪花算法
1、插入测试
编写测试类
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
@Test
public void insertTest(){
User user = new User();
user.setName("imperfect");
user.setAge(3);
user.setEmail("123456789@qq.com");
int insert = userMapper.insert(user);
System.out.println(insert);
}
执行结果如下:
这里我们可以看到虽然我们代码没有写id,但是这里我们插入数据库的时候,插入数据库的时候使用了全局的唯一id。
即雪花算法
2、雪花算法
数据库主键生成策略:自增算法、UUID、雪花算法…
最常见的方式。利用数据库,全数据库唯一。
1、数据库自增长序列或字段
优点:
1)简单,代码方便,性能可以接受。
2)数字ID天然排序,对分页或者需要排序的结果很有帮助。
缺点:
1)不同数据库语法和实现不同,数据库迁移的时候或多数据库版本支持的时候需要处理。
2)在单个数据库或读写分离或一主多从的情况下,只有一个主库可以生成。有单点故障的风险。
3)在性能达不到要求的情况下,比较难于扩展。(不适用于海量高并发)
4)如果遇见多个系统需要合并或者涉及到数据迁移会相当痛苦。
5)分表分库的时候会有麻烦。
6)并非一定连续,类似MySQL,当生成新ID的事务回滚,那么后续的事务也不会再用这个ID了。这个在性能和连续性的折中。如果为了保证连续,必须要在事务结束后才能生成ID,那性能就会出现问题。
7)在分布式数据库中,如果采用了自增主键的话,有可能会带来尾部热点。分布式数据库常常使用range的分区方式,在大量新增记录的时候,IO会集中在一个分区上,造成热点数据。
2、UUID
常见的方式。可以利用数据库也可以利用程序生成,一般来说全球唯一。UUID是由32个的16进制数字组成,所以每个UUID的长度是128位(16^32 = 2^128)。UUID作为一种广泛使用标准,有多个实现版本,影响它的因素包括时间、网卡MAC地址、自定义Namesapce等等。
优点:
1)简单,代码方便。
2)生成ID性能非常好,基本不会有性能问题。
3)全球唯一,在遇见数据迁移,系统数据合并,或者数据库变更等情况下,可以从容应对。
缺点:
1)没有排序,无法保证趋势递增。
2)UUID往往是使用字符串存储,查询的效率比较低。
3)存储空间比较大,如果是海量数据库,就需要考虑存储量的问题。
4)传输数据量大
5)不可读。
3、Twitter的snowflake算法(雪花算法)
snowflake是Twitter开源的分布式ID生成算法,结果是一个long型的ID。其核心思想是:使用41bit作为毫秒数,10bit作为机器的ID(5个bit是数据中心,5个bit的机器ID),12bit作为毫秒内的流水号(意味着每个节点在每毫秒可以产生 4096 个 ID),最后还有一个符号位,永远是0。具体实现的代码可以参看https://github.com/twitter/snowflake。雪花算法支持的TPS可以达到419万左右(2^22*1000)。
3、主键id生成策略
根据MyBatis_Plus官方文档,我们可以找到这里我们可以根据实际的业务需求,配置对应的主键生成策略。
这里我们通过代码可以看到,这里能够选择多种id生成策略:
我们现在来改一下对应的自增策略为AUTO即自增
对应的数据库表也需要修改为自增策略,不然会报错!
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
这里我们重新编写一下测试代码
@Test
public void insertTest(){
User user = new User();
user.setName("SAM");
user.setAge(3);
user.setEmail("123456789@qq.com");
int insert = userMapper.insert(user);
System.out.println(insert);
}
可以看到这里我们的id是根据最大的那个id进行自增的
四、更新操作
1、测试用例
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
@Test
public void testUpdate() {
User user = new User();
user.setId(5l);
user.setName("samImperfect");
user.setAge(26);
userMapper.updateById(user);
}
执行结果如下:
这里我们可以看到只要在对应的对象上附上相对应的值,这里的更新操作就会根据id进行动态SQL的更新。
2、自动填充处理
根据MyBatis-Plus的官方中文文档我们可以看到,这里我们可以根据实际的情况去做一些字段自动填充的策略:
这里我们在数据库中新增两个字段
com/imperfect/pojo/User.java
增加对应实体类的映射以及增加TableField注解
@TableField(fill= FieldFill.INSERT)
private Date createTime;
@TableField(fill= FieldFill.INSERT_UPDATE)
private Date updateTime;
根据MyBatis_Plus官方文档的介绍,这里我们可以自定义实现类
com/imperfect/handler/MyMetaObjectHandler.java
package com.imperfect.handler;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
/**
* @author : Imperfect(lxm)
* @Des:
* @date : 2023/1/9 14:52
*/
@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
然后我们再进行一次插入的测试
@Test
public void insertTest() {
User user = new User();
user.setName("bily");
user.setAge(3);
user.setEmail("123456789@qq.com");
int insert = userMapper.insert(user);
System.out.println(insert);
}
可以看到这里新增的数据就能够自动填充上时间
五、查询操作
1、测试批量查询
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
//测试批量查询
@Test
public void testSelctByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
2、按条件查询
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
@Test
public void testSelectByMap(){
HashMap<String,Object> map=new HashMap<>();
//自定义查询
map.put("email","123456789@qq.com");
List<User> list = userMapper.selectByMap(map);
list.forEach(System.out::println);
}
执行结果如下:
六、分页查询
根据MyBatis-Plus官方文档介绍,在配置分页查询的时候需要在MyBatis-plus配置文件中进行一下分页插件的配置
com/imperfect/config/MyBatisPlusConfig.java
//配置分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
编写测试代码
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
@Test
public void testPage(){
IPage<User> page=new Page<>(1,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
}
执行结果如下:
七、删除操作
1、物理删除
编写测试代码
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
@Test
public void testDelete(){
userMapper.deleteById(1611939269176008708l);
}
查询结果:
2、逻辑删除
根据官方文档的介绍
我们在数据库中新增一个逻辑删除字段
com/imperfect/pojo/User.java
@TableLogic
private Integer deleted;
根据官方文档的介绍进行配置
application.properties
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
由于本人使用的是3.1.1版本前,所以还需要注册bean
com/imperfect/config/MyBatisPlusConfig.java
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
编写测试代码
com/imperfect/mybatis_plus/MybatisPlusApplicationTests.java
@Test
public void testDelete(){
userMapper.deleteById(1611939269176008706l);
}
执行结果如下
这里我们可以看到虽然方法的名称是delete删除,但是实际上sql执行的是update语句,数据库中依然存储着我们物理数据。
注意:
这里我们再去执行查询的时候可以发现,查询的时候自动会带上deleted=0的参数
八、性能分析插件
首先我们先在com/imperfect/config/MyBatisPlusConfig.java中注册bean
@Bean
@Profile({"dev","test"})
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
performanceInterceptor.setMaxTime(1);//SQL 执行最大时长,超过自动停止运行,有助于发现问题
performanceInterceptor.setFormat(true);//SQL 是否格式化
return performanceInterceptor;
}
并且在application.properties中配置对应的环境
#设置开发环境
spring.profiles.active=dev
执行结果如下
这里我们可以看到由于我们设置了SQL最大执行的时间为1ms,所以这里执行测试代码的时候会报错,因为此处的SQL已经超过了1ms。
九、条件构造器
MyBatis-Plus官方文档中有关于条件构造器的使用方法说明:
我们编写一下测试类
com/imperfect/mybatis_plus/WrapperTest.java
package com.imperfect.mybatis_plus;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.imperfect.mapper.UserMapper;
import com.imperfect.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
/**
* @author : Imperfect(lxm)
* @Des:
* @date : 2023/1/9 16:52
*/
@SpringBootTest
public class WrapperTest {
@Autowired(required = false)
private UserMapper userMapper;
//查询名字不为空,并且邮箱不为空,年龄大于20岁的用户
@Test
void QueryWrapper() {
QueryWrapper<User> queryWrapper = new QueryWrapper();
queryWrapper.isNotNull("name")
.isNotNull("email")
.ge("age", 20);
userMapper.selectList(queryWrapper).forEach(System.out::println);
}
}
执行结果如下:
测试代码
//模糊查询
@Test
void test(){
QueryWrapper<User> queryWrapper = new QueryWrapper();
//查询邮箱以t开头的数据
queryWrapper.likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);
maps.forEach(System.out::println);
}
执行结果如下:
这里就不一一再列举具体wrapper的使用方法,更多的使用方法可以参考MyBatis-Plus官方文档。