MyBatisPlus

MyBatisPlus

参考：B站：狂神说Java

1、简介

MyBatis-Plus （简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

官网：https://baomidou.com/

image-20220715194532196 image-20220715194814812

2、特性

  • 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
  • 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

3、快速入门

3.1、创建数据库和表

现有一张 User 表，其表结构如下：

id name age email
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

其对应的数据库 Schema 脚本如下：

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_ modified

其对应的数据库 Data 脚本如下：

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

3.2、初始化工程

添加依赖

引入 Spring Boot Starter 父工程：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0+ 版本</version>
    <relativePath/>
</parent>

引入 spring-boot-starter、spring-boot-starter-test、mybatis-plus-boot-starter、h2 依赖：

<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>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.0.5</version>
    </dependency>
    <dependency>
        <groupId>com.h2database</groupId>
        <artifactId>h2</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>

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

配置

在 application.yml 配置文件中添加 H2 数据库的相关配置：

# DataSource Config
spring:
  datasource:
    driver-class-name: org.h2.Driver
    schema: classpath:db/schema-h2.sql
    data: classpath:db/data-h2.sql
    url: jdbc:h2:mem:test
    username: root
    password: 123456

# Logger Config
logging:
  level:
    com.baomidou.mybatisplus.samples.quickstart: debug

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

编码

编写实体类 User.java（此处使用了 Lombok简化代码）

package com.baomidou.mybatisplus.samples.quickstart.entity;

import lombok.Data;

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

编写 Mapper 包下的 UserMapper接口

package com.baomidou.mybatisplus.samples.quickstart.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.samples.quickstart.entity.User;

@Repository		//代表持久层
public interface UserMapper extends BaseMapper<User> {
                // 所有的CRUD操作都已经编写完成了
                // 你不需要像以前的配置一大堆文件了
}

开始使用

添加测试类，进行功能测试：

@SpringBootTest
public class SampleTest {

    // 继承了BaseMapper,所有的方法都来自己父类
	// 我们也可以编写自己的扩展方法
    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        // 参数是一个Wrapper，条件构造器，这里我们先不用，写null就可以了
		// 查询全部用户
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.forEach(System.out::println);
    }
}

提示：UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件

控制台输出：

User(id=1, name=Jone, age=18, email=test1@baomidou.com)
User(id=2, name=Jack, age=20, email=test2@baomidou.com)
User(id=3, name=Tom, age=28, email=test3@baomidou.com)
User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
User(id=5, name=Billie, age=24, email=test5@baomidou.com)

4、配置日志

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

在 application.yml 配置文件中添加MyBatisPlus日志的相关配置：

# 配置日志
# org.apache.ibatis.logging.stdout.StdOutImpl  控制台输出
mybatis-plus
	configuration
		log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

5、CRUD扩展

插入操作

代码

image-20220715203802259

运行结果

image-20220715203834164

主键生成策略

image-20220715205304529

雪花算法

参考知乎：https://zhuanlan.zhihu.com/p/433118672

默认ID_ WORKER全局唯一id

雪花算法的由来：

  • 一：Twitter使用scala语言开源了一种分布式 id 生成算法——SnowFlake算法，被翻译成了雪花算法。
  • 二：因为自然界中并不存在两片完全一样的雪花的，每一片雪花都拥有自己漂亮独特的形状、独一无二。雪花算法也表示生成的ID如雪花般独一无二。（有同学问为什么不是树叶，美团的叫树叶——Leaf）

主键自增

我们需要配置主键自增:
1、实体类字段上@TableId(type = IdType.AUTO)
2、数据库字段一定要是自增！

image-20220715204742015

其余的源码解释

pub1ic enum IdType {
    AUTO(0),	//数据库id自增
    NONE(1),	//未设置主键
    INPUT(2),	//手动输入
    IQ_WORKER(3),//默认的全局唯一 id
    UUID(4),	//全局唯一id uuid
    ID_WORKER_STR(5); //ID_WORKER 字符串表示法
}

更新操作

image-20220715205753391

image-20220715205902875 image-20220715205619479

自动填充

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

阿里巴巴开发手册:所有的数据库表: gmt_create、 gmt_modified几乎所有的表都要配置上!

方式一：数据库级别

注意：工作中不允许你修改数据库的，所以这种方法不建议使用，并不是不可以使用

1、在表中新增字段create_time, update_time

image-20220715210349464

2、再次测试插入方法，我们需要先把实体类同步！

image-20220715210505479

image-20220715210712828

方式二：代码级别

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

image-20220715210832337

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

image-20220715211019998

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

image-20220715211515082

4、测试插入
5、测试更新、观察时间即可！

image-20220715211714839

乐观锁

在面试过程中,我们经常会被问道乐观锁,悲观锁!这个其实非常简单!

乐观锁：故名思意十分乐观，它总是认为不会出现问题,无论干什么不去上锁！如果出现了问题，再次更新值测试
悲观锁：故名思意十分悲观，它总是认为总是出现问题，无论干什么都会上锁！再去操作！

version、new version

我们这里主要讲解乐观锁机制！

乐观锁实现方式：

  • 取出记录时，获取当前 version
  • 更新时，带上这个 version
  • 执行更新时， set version = newVersion where version = oldVersion
  • 如果 version 不对，就更新失败
乐观锁: 1、先查询，获得版本号version = 1
-- A
update user set name = " kuangshen", version = version + 1
where id = 2 and version = 1

-- B  线程抢先完成，这个时候version = 2，会导致A修改失败！
update user set name = " kuangshen", version = version + 1
where id = 2 and version = 1

测试一下MP的乐观锁插件

1、给数据库中增加version字段！

image-20220715214841163

2、我们实体类加对应的字段

image-20220715214930716

3、注册组件

image-20220715215155214

测试乐观锁成功

image-20220715215453581

image-20220715215428767

测试乐观锁失败

image-20220715215742033

查询操作

image-20220715220058498

image-20220715220343543

image-20220715220406235

分页查询

分页在网站使用的十分之多！

1、原始的limit进行分页
2、pageHelper 第三方插件
3、MP其实也内置了分页插件

如何使用

1、配置拦截器组件即可

image-20220715220750163

2、直接使用Page对象即可

image-20220715221313112

本质还是使用了Limit

image-20220715221114920

删除操作

1、根据id删除记录

image-20220715221656364

2、批量删除

image-20220715221827964

3、通过Map删除

image-20220715221936960

逻辑删除

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

逻辑删除：再数据库中没有被移除,而是通过一个变量来让他失效！deleted = 0 ===> deleted = 1

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

测试一下：

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

image-20220715224009874

2、实体类中增加属性

image-20220715224131726

3、配置

image-20220715224232786

image-20220715224401089

4、测试删除

image-20220715224504733

查看数据库字段的值

image-20220715224524603

尝试查询这个用户

image-20220715224617564

性能分析插件

我们在平时的开发中,会遇到一些慢sql。 测试！druid

作用：性能分析拦截器，用于输出每条SQL语句及其执行时间

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

1、导入插件

image-20220715225145399

image-20220715225438948

2、测试使用

image-20220715225505304

条件构造器

十分重要: Wrapper
我们写一些复杂的sql就可以使用它来替代！

多个数据查询

image-20220715230149481

单个数据查询

image-20220715230735957

between and 查询

image-20220715231107938

Like 模糊查询

image-20220715231415368

image-20220715231432445

内连接查询

image-20220715231807964

image-20220715231834420

Order By

image-20220715232326366

代码自动生成器

https://baomidou.com/pages/d357af/

dao、pojo、 service、 controller都让脚本去编写

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

准备工作

image-20220715233407178

一键代码生成器

package com.dahai;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.List;


public class DaHaiCode {
    public static void main(String[] args) {
        // 需要构建一个代码自动生成器对象
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("BigSea");
        gc.setOpen(false);
        gc.setFileOverride(false);           //是否覆盖
        gc.setServiceName("%sService");       //去掉Service的I前缀
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);
        // gc.setSwagger2(true); 实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.dahai");
        pc.setEntity("entity"); //存放实体类的包
        pc.setMapper("mapper");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 生成数据库user和blog这两张表
        strategy.setInclude("user","blog");            // 设置要映射的表名,多张表就用逗号隔开
        // underline_to_camel  下划线转驼峰命名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);        //是否生成lombok注解

        // 逻辑删除字段
        strategy.setLogicDeleteFieldName("deleted");
        // 自动填充配置
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);

        // 乐观锁配置
        strategy.setVersionFieldName("version");
        // 开启restFull驼峰命名
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);  // localhost:8080/hello_id_2
        mpg.setStrategy(strategy);
        mpg.execute();
    }
}

运行结果

image-20220716003623476

​ 这样我们就不用写繁琐的代码了

学习MyBatisPlus到此结束，后续可以通过官方文档继续深入学习探究

官网：https://baomidou.co

posted @ 2022-07-16 00:55  海边蓝贝壳  阅读(514)  评论(0)  编辑  收藏  举报