MyBatis-Plus的使用

最新推荐文章于 2025-04-23 15:20:43 发布

一碗小米粥i

最新推荐文章于 2025-04-23 15:20:43 发布

阅读量175

点赞数

文章标签： java

本文链接：https://blog.csdn.net/xiaomizhouOvO/article/details/108393278

版权

MyBatis-Plus的使用

Ⅰ、MyBatis-Plus概述

为什么要学习MyBatis-Plus？俗话说的好，工具用的好，头发掉的少。MyBatisPlus可以节省我们大量工作时间，所有的CRUD代码它都可以自动化完成，其他的工具有 JPA，tk-mapper

简介

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

Ⅱ、快速入门

地址：https://baomidou.com/guide/quick-start.html#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B

步骤

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)
);

-- 插入数据
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');

-- 真实开发中，version（乐观锁）、delete(逻辑删除)、gmt_create(创建)、gmt_modified(更新)

3、初始化工程，使用spring boot 导入工程

4、导入依赖

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

5、配置数据库

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: root

6.编写CRUD代码

实体类
mapper接口
注意，在启动类上需要进行mapper接口扫描

Ⅲ、配置SQL打印日志

#配置日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

Ⅳ、CRUD扩展

insert 插入引出的主键生成策略

1、主键生成策略

uuid
自增id
雪花算法(mybatis-plus默认策略)
redis
zookeeper

2、使用注解修改主键生成策略

@TableId(type = IdType.AUTO)
private Long id;

update 更新

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

自动填充功能

在表中新增字段create_time、update_time

在实体类上加上注解

@TableField(fill = FieldFill.INSERT)
private Date createTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

编写处理器来处理注解

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
    // 插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("<<插入时的填充策略启动<<<<<<<<<<<");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    // 更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("<<更新时的填充策略启动<<<<<<<<<<<");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

select 查询

根据id查询 selectById()
批量查询 selectBatchIds()
条件查询->map selectByMap()

分页查询

配置分页拦截器

@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
    // paginationInterceptor.setOverflow(false);
    // 设置最大单页限制数量，默认 500 条，-1 不受限制
    // paginationInterceptor.setLimit(500);
    // 开启 count 的 join 优化,只针对部分 left join
    paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
    return paginationInterceptor;
}

使用selectPage()

delete 删除

根据id删除 deleteById()
根据ids批量删除 deleteBatchIds()
根据map删除 deleteByMap()

逻辑删除插件

数据库增加字段deleted，默认值为0

配置yml

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag #测试结果这个参数不能修改
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

实体类加注解

// 注意：经测试，数据库字段必须为deleted，其他字段报错
@TableLogic
private Integer deleted;

测试结果，删除为逻辑删除，查询结果会自动过滤掉逻辑删除的数据

Ⅴ、锁

乐观锁

顾名思义，十分乐观。它总是认为不会出现问题，无论干什么不去上锁

悲观锁

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

乐观锁实现方式：

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

乐观锁插件使用步骤

数据库增加version字段，并设置默认值为1
实体类使用注解
```
@Version
private Integer version;
```

使用配置类注册乐观锁插件

@MapperScan("org.xiaomizhou.mybatisplus.mapper")//扫描包
@EnableTransactionManagement//开启事务
@Configuration
public class MyBatisPlusConfig {

    //注册乐观锁
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}