简单易懂的MyBatisPlus

原创

The_Beacon 2021-04-21 22:00:23 ©著作权

文章标签 MyBatisPlus MyBatisPlus开发 文章分类 后端开发

©著作权归作者所有：来自51CTO博客作者The_Beacon的原创作品，请联系作者获取转载授权，否则将追究法律责任

MyBatisPlus 学习笔记

一、快速入门

官网：https://mp.baomidou.com/

简单易懂的MyBatisPlus_MyBatisPlus

使用第三方组件：

导入对应依赖
研究依赖如何配置
代码如何编写
提高扩展技术能力

步骤

1、创建数据库 mybatis_plus

2、创建user表，导入数据

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));-- 真实开发中，version(乐观锁)、deleted(逻辑删除)、gmt_create、gmt_modifiedDELETE 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');

3、创建SpringBoot项目，勾选web依赖

4、导入依赖

<!--数据库驱动--><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.21</version></dependency><!--mybatis-plus--><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-boot-starter</artifactId><version>3.4.0</version></dependency><!--lombok--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency>

说明：我们使用mybatis-plus可以节省我们大量的代码，尽量不要同时导入mybatis和mybatis-plus！

5、连接数据库，这一步和mybatis相同

# mysql
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?userSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

6、传统方式：pojo-mapper（连接mybatis，配置mapper.xml文件）- service - controller

7、使用了mybatis-plus 之后

pojo

@Data@AllArgsConstructor@NoArgsConstructorpublic class User {private Long id;private String name;private Integer age;private String email;}

mapper接口

// 在对应的Mapper上面继承基本的接口 BaseMapper@Repository // 代表持久层public interface UserMapper extends BaseMapper<User> {// 所有的CRUD操作都已经基本完成了// 你不需要像以前的配置一大堆文件了}

注意点：我们需要在主启动类上去扫描我们的mapper包下的所有接口

测试类中测试

@SpringBootTestclass MybatisPlusApplicationTests {// 继承了BaseMapper,所有的方法都来自父类// 我们也可以编写自己的扩展方法@AutowiredUserMapper userMapper;@Testvoid contextLoads() {// 参数是一个 Wrapper , 条件构造器，这里我们先不用 null// 查询全部用户List<User> users = userMapper.selectList(null);users.forEach(System.out::println);}}

测试结果

思考问题：

1、SQL是谁帮我们写的？MyBatis-Plus都写好了

2、方法哪里来的？MyBatis-Plus 都写好了

二、配置日志

我们所有的sql现在都是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！

# 配置日志 (系统自带的，控制台输出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

简单易懂的MyBatisPlus_MyBatisPlus开发_04

配置完毕日志之后，后面的学习就需要注意这个自动生成的SQL，我们就会喜欢上MyBatis-Plus !

三、CRUD

1. 插入操作

Insert 插入

@Testpublic void testInsert() {User user = new User();user.setName("Zhy");user.setAge(3);user.setEmail("zhy@163.com");int result = userMapper.insert(user);// 帮我们自动生成idSystem.out.println(result);// 受影响的行数System.out.println(user);// 发现: id自动回填}

简单易懂的MyBatisPlus_MyBatisPlus_05

数据库插入的id默认值为：全局的唯一id

2. 主键生成策略

默认 ID_WORKER 全局唯一id

分布式系统唯一id生成：https://blog.51cto.com/dechen/2717073

雪花算法：

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！

主键自增

我们需要配置主键自增：

实体类字段上 @TableId(type = IdType.AUTO)
数据库字段上一定是自增的
再次测试即可

其余的源码解释

public enum IdType {AUTO(0), // 数据库id自增NONE(1), // 未设置主键INPUT(2), // 手动输入，自己写id//以下三种官方不推荐ID_WORKER(3), // 默认的全局唯一idUUID(4), // 全局唯一id uuidID_WORKER_STR(5); // ID_WORKER 字符串表示法}

3. 更新操作

//测试更新@Testpublic void testUpdate(){User user = new User();// 通过条件自动拼接动态sqluser.setId(1318349262742675458L);user.setName("关注我的微信公众号");user.setAge(18);// 注意： updateById 但是参数是一个 对象int i = userMapper.updateById(user);System.out.println(i);}

简单易懂的MyBatisPlus_MyBatisPlus_07

所有的sql都是自动帮你动态配置的！

4. 自动填充

创建时间、修改时间！这些个操作一般都是自动化完成的，我们不希望手动更新！

阿里巴巴开发手册： 所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化！

方式一：数据库级别（工作中不允许修改数据库）

在表中新增字段 create_time,update_time
再次测试插入方法，我们需要先把实体类同步
```
private Date createTime;private Date updateTime;
```
再次查看更新结果即可

方式二：代码级别

删除数据库中的默认值、更新操作

实体类的字段属性上需要增加注解

//字段添加填充内容@TableField(fill = FieldFill.INSERT)private Date createTime;@TableField(fill = FieldFill.INSERT_UPDATE)private Date updateTime;

编写处理器来处理这个注解即可

package com.zhy.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;@Slf4j@Component // 一定不要忘记把处理器加到IOC容器中public class MyMetaObjectHandler implements MetaObjectHandler {// 插入时候的填充策略@Overridepublic 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);}// 更新时的填充策略@Overridepublic void updateFill(MetaObject metaObject) {log.info("start update fill ...");this.setFieldValByName("updateTime", new Date(), metaObject);}}

测试插入
测试更新，观察时间

5. 乐观锁

在面试过程中，我们经常会被问到乐观锁，悲观锁。

乐观锁：顾名思义，它总是认为不会出现问题，无论干什么都不去上锁！如果出现了问题，再次更新值测试！

悲观锁：顾名思义，它总是认为会出现问题，无论干什么都上锁！再去操作！

乐观锁实现方式：

取出记录时，获取当前version
更新时，带上这个version
执行更新时， set version = newVersion where version = oldVersion
如果version不对，就更新失败

乐观锁：1、先查询，获得版本号 version = 1-- Aupdate user set name = "zhy", version = version + 1where id = 2 and version = 1-- B 线程强先完成，这个时候 version = 2，会导致A修改失败update user set name = "zhy", version = version + 1where id = 2 and version = 1

测试一下MyBatisPlus的插件：

数据库中增加一个version字段

需要实体类加上对应的字段

@Version // 乐观锁的version注解private Integer version;

注册组件

// 扫描我们的 mapper文件夹@MapperScan("com.zhy.mapper")@EnableTransactionManagement@Configurationpublic class MyBatisPlusConfig {MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();//乐观锁mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());return mybatisPlusInterceptor;}

测试一下

    // 测试乐观锁成功@Testpublic void testVersionSuccess(){// 1. 查询用户信息User user = userMapper.selectById(1L);// 2. 修改用户信息user.setName("zhy");user.setAge(24);// 3. 执行更新操作userMapper.updateById(user);}// 测试乐观锁失败!多线程下@Testpublic void testVersionFall(){// 线程1User user1 = userMapper.selectById(1L);user1.setName("zhy111");user1.setAge(14);// 线程2User user2 = userMapper.selectById(1L);user2.setName("zhy222");user2.setAge(24);userMapper.updateById(user2);//自旋锁来多次尝试提交！userMapper.updateById(user1); //如果没有乐观锁就会覆盖插队线程的值}}

测试结果

6. 查询操作

// 测试查询@Testpublic void testSelectById(){User user = userMapper.selectById(1);System.out.println(user);}// 批量查询@Testpublic void testSelectByBatchIds(){List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));users.forEach(System.out::println);}// 按照条件查询之一使用 map@Testpublic void testSelectByMap(){HashMap<String, Object> map = new HashMap<>();// 自定义要查询map.put("name","Zhy");map.put("age","3");List<User> users = userMapper.selectByMap(map);users.forEach(System.out::println);}

7. 分页查询

分页网站频繁使用

原始使用limit进行分页
pageHelper第三方插件
MybatisPlus内置了分页插件

如何使用？

配置拦截器

@Beanpublic MybatisPlusInterceptor MybatisPlusInterceptor() {MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();//分页配置mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());return mybatisPlusInterceptor;}

直接使用Page对象即可

// 测试分页查询@Testpublic void testPage(){// 参数一: 当前页// 参数二： 页面大小// 使用了分页插件之后，所有的分页操作变得简单了Page<User> page = new Page<>(1,5);userMapper.selectPage(page, null);page.getRecords().forEach(System.out::println);System.out.println(page.getTotal());}

8. 删除操作

// 测试删除@Testpublic void testDeleteById(){userMapper.deleteById(1318349262742675458L);}// 测试批量删除@Testpublic void testDeleteBatchId(){userMapper.deleteBatchIds(Arrays.asList(1318349262742675460L,1318349262742675461L));}//通过map删除@Testpublic void testDeleteByMap(){HashMap<String, Object> map = new HashMap<>();map.put("name","Zhy");userMapper.deleteByMap(map);}

我们在工作中会遇到一些问题：逻辑删除！

9. 逻辑删除

物理删除：从数据库中直接移除

逻辑删除：在数据库中没有被移除，而是通过一个变量让他生效！deleted=0 --> deleted=1

管理员可以查看被删除的记录！防止数据的丢失！类似于回收站！

测试：

在数据库表中增加一个deleted字段

实体类中增加属性

//since 3.3.0,配置后可以忽略不配置属性上的注解private Integer deleted;

配置

# 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置属性上的注解)
mybatis-plus.global-config.db-config.logic-delete-field=deleted
# 逻辑已删除值(默认为 1)
mybatis-plus.global-config.db-config.logic-delete-value=1
# 逻辑未删除值(默认为 0)
mybatis-plus.global-config.db-config.logic-not-delete-value=0

测试删除
测试查询

以上所有的CRUD操作及其扩展操作，我们必须精通掌握！会大大提高工作效率！

四、性能分析插件

我们在平时的开发中，会遇到一些慢sql。解决方案：测试，druid监控…

作用：性能分析拦截器，用于输出每条SQL语句及其执行时间（3.2以后的版本建议使用外部插件）

MyBatisPlus也提供性能分析插件，如果超过这个时间就停止运行！

导入插件

// SQL执行效率插件@Bean@Profile({"dev","test"})public PerformanceInterceptor performanceInterceptor(){PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();performanceInterceptor.setMaxTime(100); //ms 设置sql执行的最大时间，如果超过了则不执行performanceInterceptor.setFormat(true); // 是否格式化return performanceInterceptor;}

记住，要在SpringBoot中配置环境为dev或者test环境！

测试使用

// 测试查询@Testpublic void testSelectById(){User user = userMapper.selectById(3);System.out.println(user);}

只要超出时间就会抛出异常

使用性能分析插件可以提高效率，新版本MP已经移除该插件了，可以使用druid

五、条件构造器

十分重要：wrapper

我们写一些复杂的sql就可以使用它来代替！

@Testvoid contextLoads() {//查询name不为空并且邮箱不为空的用户，年龄大于等于12QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.isNotNull("name").isNotNull("email").ge("age",12);userMapper.selectList(wrapper).forEach(System.out::println);}@Testvoid test1(){//查询名字等于zhy的QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.eq("name","zhy");User user = userMapper.selectOne(wrapper);System.out.println(user);}@Testvoid test2(){//查询年龄在20-30岁之间的用户数量QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.between("age",20,30);Integer count = userMapper.selectCount(wrapper);System.out.println(count);}@Testvoid test3(){//查询名字里不包含eQueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.notLike("name","e")//name NOT LIKE %e%.likeRight("email","t");//email LIKE t%List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);maps.forEach(System.out::println);}@Testvoid test4(){//id在子查询中查出QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.inSql("id","select id from user where id < 3");List<Object> objects = userMapper.selectObjs(wrapper);objects.forEach(System.out::println);}@Testvoid test5(){//通过id排序QueryWrapper<User> wrapper = new QueryWrapper<>();wrapper.orderByDesc("id");List<User> userList = userMapper.selectList(wrapper);userList.forEach(System.out::println);}