springboot简单使用mybatisplus
Posted 冷血～多好
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了springboot简单使用mybatisplus相关的知识，希望对你有一定的参考价值。
目录
什么是mybatisplus
mybatisplus是一个 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 操作智能分析阻断，也可自定义拦截规则，预防误操作
目录结构
首先导入依赖：
<!-- 数据库驱动 --> <dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<!-- lombok --> <dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!-- mybatis-plus --> <!-- mybatis-plus 是自己开发，并非官方的！ -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.3</version>
</dependency>
创建数据库：
create database mybatisplus;
use mybatisplus;
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` bigint(20) NOT NULL COMMENT '主键ID',
`name` varchar(30) CHARACTER SET gbk COLLATE gbk_chinese_ci NULL DEFAULT NULL COMMENT '姓名',
`age` int(11) NULL DEFAULT NULL COMMENT '年龄',
`email` varchar(50) CHARACTER SET gbk COLLATE gbk_chinese_ci NULL DEFAULT NULL COMMENT '邮箱',
`version` int(25) NULL DEFAULT 1,
`deleted` int(10) NULL DEFAULT 1,
`create_time` datetime NULL DEFAULT NULL,
`update_time` datetime NULL DEFAULT NULL,
PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = gbk COLLATE = gbk_chinese_ci ROW_FORMAT = Compact;
-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES (1, 'test232', 18, '24736743@qq.com', 4, 0, NULL, '2021-07-26 23:06:43');
INSERT INTO `user` VALUES (2, 'Jack', 20, 'test2@baomidou.com', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (3, 'Tom', 28, 'test3@baomidou.com', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (4, 'Sandy', 21, 'test4@baomidou.com', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (5, 'Billie', 24, 'test5@baomidou.com', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (55, '小h黑3', 29, '@12910000', 1, 0, NULL, '2021-07-26 17:18:21');
INSERT INTO `user` VALUES (1419574597568741377, '小明2', 10, '@1291759046', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (1419574597568741378, '小明3', 10, '@1291759046', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (1419578836433018881, '小明3', 10, '@1291759046', 1, 0, NULL, NULL);
INSERT INTO `user` VALUES (1419582624418045954, '小明5', 10, '@1291759046', 1, 1, NULL, NULL);
-- 真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modified连接数据库
# mysql 5 驱动不同 com.mysql.jdbc.Driver
# mysql 8 驱动不同com.mysql.cj.jdbc.Driver、需要增加时区的配置 serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql://localhost:3306/mybatisplus? useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl创建实体类：(使用了lombok插件)
package com.chen.pojo;
import com.baomidou.mybatisplus.annotation.*;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
//主键注解
//对应数据库中的主键（uuid,自增id，雪花算法，redis,zookeeper)
// AUTO 数据库ID自增
// NONE 无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
// INPUT insert前自行set主键值
// ASSIGN_ID 分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
// ASSIGN_UUID 分配UUID,主键类型为String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认default方法)
@TableId(type = IdType.ASSIGN_ID)
private Long id;
private String name;
private Integer age;
private String email;
//字段注解(非主键)
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;
@Version
//乐观锁Version注解
private Integer version;
@TableLogic
//逻辑删除
private Integer deleted;
}mapper接口
package com.chen.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.chen.pojo.User;
import org.springframework.stereotype.Repository;
// 在对应的Mapper上面继承基本的类 BaseMapper
@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {
// 所有的CRUD操作都已经编写完成了
// 不需要像以前的配置一大堆文件了！
}然后需要在主启动类上去扫描我们的mapper包下的所有接口
@MapperScan("com.chen.mapper")然后在测试类中测试
查询操作
@Autowired
private UserMapper userMapper;
@Test
public void testSelect() {
System.out.println(("----- selectAll method test ------"));
// 参数是一个 Wrapper ，条件构造器，这里我们先不用 null
// 查询全部用户
List<User> userList = userMapper.selectList(null);
userList.forEach(System.out::println);
}输出结果
//测试查询
@Test
public void testQuery(){
User user=userMapper.selectById(1L);
System.out.println(user);
}
// 测试批量查询！
@Test
public void testSelectByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
// 按条件查询之一使用map操作
@Test
public void testSelectByBatchIds(){
HashMap<String, Object> map = new HashMap<>();
// 自定义要查询
map.put("name","test222");
map.put("age",18);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}插入操作
//测试插入
@Test
public void insertTest(){
User user=new User();
user.setAge(10);
user.setEmail("@1291759046");
user.setName("小明8");
//user.setId(55l);
userMapper.insert(user);
}更新操作
//测试更新
@Test
public void testUpdate(){
User user=new User();
user.setId(55L);
user.setAge(29);
user.setEmail("@12910000");
user.setName("小h黑555");
userMapper.updateById(user);
}这里是根据id更新
小结：
通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！
从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。
但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续往下看吧
主键生成策略
观察上边的插入测试，可以发现并没有插入主键id,但是却生成了唯一id，这是因为设置了分配id
@TableId(type = IdType.ASSIGN_ID)
private Long id;如果设置了id为@TableId(type = IdType.AUTO)
private Long id;则数据库中要设置数据库id字段为自增类型
自动填充
创建时间、修改时间！这些个操作一遍都是自动化完成的，我们不希望手动更新！
代码级别
实体类字段属性上需要增加注解
//字段注解(非主键)
// 字段添加填充内容
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.UPDATE)
private Date updateTime;
编写处理器来处理这个注解！
创建 MyMetaObjectHandler类
package com.chen.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.time.LocalDateTime;
import java.util.Date;
@Slf4j
@Component
// 一定不要忘记把处理器加到IOC容器中！
public class MyMetaObjectHandler implements MetaObjectHandler {
// 插入时的填充策略
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill.....");
// setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject
this.setFieldValByName("createTime",new Date(),metaObject);
// this.setFieldValByName("updateTime", new Date(), metaObject);
// this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
// // 或者
// this.strictInsertFill(metaObject, "createTime", () -> LocalDateTime.now(), LocalDateTime.class); // 起始版本 3.3.3(推荐)
// // 或者
// this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug)
}
// 更新时的填充策略
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill.....");
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}测试添加数据和更改数据，时间会自动生成
乐观锁
当要更新一条记录的时候，希望这条记录没有被别人更新
乐观锁实现方式：
- 取出记录时，获取当前version
- 更新时，带上这个version
- 执行更新时， set version = newVersion where version = oldVersion
- 如果version不对，就更新失败
这类version自段在数据库中已创建
实体类加对应的字段
@Version
//乐观锁Version注解
private Integer version;
注册组件
创建配置类MyBatisPlusConfig类
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.pagination.optimize.JsqlParserCountOptimize;
import com.chen.pojo.User;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
// 扫描我们的 mapper 文件夹
@MapperScan("com.chen.pojo")
@EnableTransactionManagement
@Configuration
// 配置类
public class MyBatisPlusConfig
{
// 注册乐观锁插件
/**
* 旧版
*/
// @Bean
// public OptimisticLockerInterceptor optimisticLockerInterceptor() {
// return new OptimisticLockerInterceptor();
// }
/**
* 新版
*/
// 注册乐观锁插件
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return mybatisPlusInterceptor;
}
}进行测试
//测试乐观锁成功·
@Test
public void testOptimisticloker(){
//1.查询用户信息
User user=userMapper.selectById(1);
//2.修改用户信息
user.setName("哈哈哈哈");
user.setEmail("12444@qqq.com");
//执行更新操作
userMapper.updateById(user);
}
// 测试乐观锁失败！多线程下
@Test
public void testOptimisticLocker2(){
// 线程 1
User user = userMapper.selectById(1L);
user.setName("test1111111");
user.setEmail("24736743@qq.com");
// 模拟另外一个线程执行了插队操作
User user2 = userMapper.selectById(1L);
user2.setName("test000000");
user2.setEmail("24736743@qq.com");
userMapper.updateById(user2);
// 自旋锁来多次尝试提交！
userMapper.updateById(user);
// 如果没有乐观锁就会覆盖插队线程的值！
}这里会发现user1的用户更新失败，user2的用户更新成功，并且数据库中的version值加一，因为加一所以user1的用户更新失败，这就是乐观锁
分页查询
1
、原始的
limit
进行分页
2
、
pageHelper
第三方插件
3
、
MP
其实也内置了分页插件！
配置拦截器组件
在MyBatisPlusConfig中添加
package com.chen.config;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.pagination.optimize.JsqlParserCountOptimize;
import com.chen.pojo.User;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;
// 扫描我们的 mapper 文件夹
@MapperScan("com.chen.pojo")
@EnableTransactionManagement
@Configuration
// 配置类
public class MyBatisPlusConfig
{
//分页插件
// 最新版
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor2() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}测试
// 测试分页查询
@Test
public void testPage(){
// 参数一：当前页
// 参数二：页面大小
// 使用了分页插件之后，所有的分页操作也变得简单的！
Page<User> page = new Page<>(2,5);
userMapper.selectPage(page,null);
page.getRecords().forEach(System.out::println);
System.out.println(page.getTotal());
}
逻辑删除
- 逻辑删除是为了方便数据恢复和保护数据本身价值等等的一种方案，但实际就是删除。
- 如果你需要频繁查出来看就不应使用逻辑删除，而是以一个状态去表示。
物理删除：从数据库中直接移除逻辑删除：再数据库中没有被移除，而是通过一个变量来让他失效！ deleted = 0 => deleted = 1
管理员可以查看被删除的记录！防止数据的丢失，类似于回收站！
在数据表中增加一个 deleted 字段，这里数据库已经添加
@TableLogic
//逻辑删除
private Integer deleted;
配置application.yml
# 配置逻辑删除
mybatis-plus:
global-config:
db-config:
logic-delete-field: flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
测试：
// 测试删除
@Test
public void testDeleteById(){
userMapper.deleteById(1420632853468803073L);
}
// 通过id批量删除
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1240620674645544961L,1240620674645544962L));
}
// 通过map删除
@Test
public void testDeleteMap() {
HashMap<String, Object> map = new HashMap<>();
map.put("name", "小明6");
userMapper.deleteByMap(map);
}发现逻辑删除成功，数据并没有实际上删除，只是deleted状态改变了
条件构造器
- wrapper 很重
- 传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
- 正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
- 我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr
我们写一些复杂的
sql
就可以使用它来替代！
测试：
创建WrapperTest类
package com.chen;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.chen.mapper.UserMapper;
import com.chen.pojo.User;
import org.apache.ibatis.annotations.Param;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
import java.util.Map;
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
@Test
public void contextLoads() {
// 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于12
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.isNotNull("name")
.isNotNull("email")
.ge("age",12);
userMapper.selectList(wrapper).forEach(System.out::println);
// 和我们刚才学习 的map对比一下
}
@Test
public void test2(){
// 查询名字
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name","小h黑3");
User user = userMapper.selectOne(wrapper);
// 查询一个数据，出现多个结果使用List 或者 Map
System.out.println(user);
//
}
@Test void test3(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,30);
// 区间
Integer count = userMapper.selectCount(wrapper);
userMapper.selectList(wrapper).forEach(System.out::println);
// List<User> list= userMapper.selectList(wrapper);
// list.forEach(System.out::println);
// 查询结果数
System.out.println(count);
}
// 模糊查询
@Test void test4(){
// 查询年龄在 20 ~ 30 岁之间的用户
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 左和右 t%
wrapper .notLike("name","j") .likeRight("email","t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
// 模糊查询
@Test void test5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查询中查出来
wrapper.inSql("id","select id from user where id<3");
List<Object> objects = userMapper.selectObjs(wrapper);
objects.forEach(System.out::println);
}
//测试六
@Test void test6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// 通过id进行排序
// wrapper.orderByAsc("id");//升序
wrapper.orderByDesc("id");//降序
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
//测试7
@Test void test7(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",24,29);
User user = new User();
user.setAge(30);
int n=userMapper.update(user,wrapper);
}
}
以上是关于springboot简单使用mybatisplus的主要内容，如果未能解决你的问题，请参考以下文章
关于写SpringBoot+Mybatisplus+Shiro项目的经验分享四：部署到阿里云