mybatis-plus

最新推荐文章于 2025-12-18 13:49:09 发布

原创最新推荐文章于 2025-12-18 13:49:09 发布 · 145 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#maven #java #mybatis

简介

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 操作智能分析阻断，也可自定义拦截规则，预防误操作

快速开始

使用第三方组件

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

步骤

1、创建数据库表

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(乐观锁)，deleted(逻辑删除)，gmt_create、 gmt_modified

3、创建springboot项目

4、添加依赖

<!--mysql驱动-->
<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.3.2</version>
</dependency>

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

5、连接数据库

#配置数据库的连接信息
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/spring_boot?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

6、传统的方式 pojo–dao(连接数据库，配置mapper.xml文件)–service–controller

6、使用mybatis-plus 以后

pojo

package com.ning.springboot.pojo;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private Long id;
    private String name;
    private String email;
    private Integer age;
}

mapper接口

package com.ning.springboot.mapper;


import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.ning.springboot.pojo.User;
import org.springframework.stereotype.Repository;

/** 在对应的 Mapper 上面继承 基本的类 BaseMapper
 *
 * @author XUN~MLF*/

@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {

    // 所有的CRUD已经编写完成
    // 不需要像以前那样配置一大堆文件
}

注意：我们需要在主启动类上去扫描我们的mapper包下所有的接口@MapperScan("com.ning.springboot.mapper")

测试类中使用

package com.ning.springboot;

import com.ning.springboot.mapper.UserMapper;
import com.ning.springboot.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 BootMybatisPlus01HelloApplicationTests {

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


    @Test
    void contextLoads() {

        /**参数是一个 Wrapper,条件构造器
         * 查询全部用户
         */
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

思考问题？

1、SQL 是谁写的？mybatis-plus

2、方法哪里来？ mybatis-plus

配置日志

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

CRUD扩展

插入操作

Insert 插入

 /**
     * 测试插入
     */
    @Test
    public void testInsert(){
        User user = new User();
        user.setName("穆宁");
        user.setAge(18);
        user.setEmail("2407942305@qq.com");

        int result = userMapper.insert(user); // 帮助我们自动声称id
        System.out.println(result); // 受影响的行数
        System.out.println(user); // 发现id会自动回填
    }

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

主键的生成策略

默认ID_WORKER 全局唯一id

雪花算法：

SnowFlake 算法，是 Twitter 开源的分布式 id 生成算法。其核心思想就是：使用一个 64 bit 的 long 型的数字作为全局唯一 id。在分布式系统中的应用十分广泛，且ID 引入了时间戳，基本上保持自增的，后面的代码中有详细的注解。

主键自增

我们需要配置主键自增：

1、数据库字段一定要自增

2、实体类字段上@TableId(type = IdType.AUTO)

其余的源码解释

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

更新操作

@Test
public void testUpdate(){
    User user = new User();

    /**
     * 通过条件自动拼接sqL
     */
    user.setId(6L);
    user.setName("你好    穆宁");
    int i = userMapper.updateById(user);
    System.out.println(i);
}

自动填充

创建时间，修改时间，这些操作一遍都是·自动化完成，我们不需要手动更新！

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

方式一:数据库级别

在数据库中操作

代码实现

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

2在实体类字段属性上需要添加注解

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

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

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

package com.ning.springboot.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.log4j.Log4j;
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   // 一定不要忘记
public class MyHandler implements MetaObjectHandler {

    // 插入时候的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill......");
        this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)

    }

    // 更新 时候的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start insert fill.....");
        this.strictInsertFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now());
    }
}

乐观锁

在面试过程中，经常被问，乐观锁，悲观锁

乐观锁：十分乐观，他总是认为不会出现问题，无论干什么都不去上锁，如果出现问题，就在测试加锁处理。

悲观锁：十分悲观，他总是认为总是会出现问题，无论干什么都会去上锁，再去操作

乐观锁实现方式：

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

乐观锁：1、先查询，获取版本号 version = 1

----A线程
update user set name = "nini" ,version = version + 1
where id = 2 and version = 1

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

测试mybatis乐观锁插件

1、数据库加字段 version

2、实体类加对应字段

@Version  // 乐观锁注解  
private int version;

3、添加组件

package com.ning.springboot.config;


import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration  // 配置类
@MapperScan("com.ning.springboot.mapper")
public class MyConfig {

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


}

查询操作

/**
 * 测试查询
 */
@Test
public void selectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

// 测试批量查询
@Test
public void selectByBathId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

// 条件查询
@Test
public void selectByBathIds(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","穆宁");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

分页查询

分页在网站使用非常多

原始limit进行分页
pagehelper第三方插件
m-plus 内置分页插件

如何使用

1、配置拦截器组件

// 分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
   
    return new PaginationInterceptor();
}

2、直接使用page 对象

/**
 * 测试分页
 */

@Test
public void testPage(){
    //  参数： 第1页显示5条数据
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page,null);

    page.getRecords().forEach(System.out::println);

}

删除操作

基本的删除

/**
 * 测试删除
 */
@Test
public void testDelete(){
    userMapper.deleteById(1392785682350600194L);
}

@Test
public void testDeleteBatchIds(){
    userMapper.deleteBatchIds(Arrays.asList(1392785682350600194L,1392785682350600197L));
}

@Test
public void testDeleteMap(){
    HashMap<String , Object> map = new HashMap<>();
    map.put("name","穆宁");
    userMapper.deleteByMap(map);
}

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

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

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

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

测试使用

1、在数据库中添加字段 deleted

2、实体类中添加相应字段

@TableLogic // 逻辑删除
private Integer deleted;

3、配置

# 配置逻辑删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

条件构造器 Wrapper

十分重要：wrapper

测试

1、测试一

 @Autowired
  private UserMapper userMapper;

@Test
void contextLoads() {

    /**
     * 查询name 不为空，email 不为空，age>12
     */
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.isNotNull("name");
    wrapper.isNotNull("email");
    wrapper.ge("age",12);
    userMapper.selectList(wrapper).forEach(System.out::println);

}

2、测试二

@Test
void contextLoads2() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name","穆宁");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);

}

3、测试三

@Test
void contextLoads3() {
    // 查询年龄在20~30之间的
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age",20,30);
    Integer count = userMapper.selectCount(wrapper);
    System.out.println(count);
}

4、测试四

/**
 * 模糊查询
 */
@Test
void contextLoads4() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.notLike("name", "e");
    wrapper.like("email", "t");

    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}


@Test
    void contextLoads5() {
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.orderByDesc("id");
        List<User> users = userMapper.selectList(wrapper);
        users.forEach(System.out::println);
    }

……

自动代码生成器

1、加入依赖

<!--自动代码生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.3.2</version>
</dependency>

<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.0</version>
</dependency>

2、编写自动代码生成

package com.ning.springboot;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.springframework.boot.test.context.SpringBootTest;

/**
 * 自动代码生成器
 */
@SpringBootTest
public class MyCode {
    public static void main(String[] args) {

        /* 构建一个 代码自动生成器对象； */
        AutoGenerator mpg = new AutoGenerator();

        // 配置策略

        // 1、全局配置
        GlobalConfig gc = new GlobalConfig();
        gc.setOutputDir("D:\\tools\\idea\\Bj-Springboot\\MySpringboot\\boot-mybatis-plus-02-code\\src\\main\\java");  // 所创建的包所在位置
        gc.setAuthor("XUN~MLF");  // 作者名字
        gc.setOpen(false);  // 是否打开文件夹
        gc.setFileOverride(false); // 是否覆盖
        gc.setServiceName("%sService");  // 去除 Service 前缀 I
        gc.setIdType(IdType.AUTO);
        gc.setDateType(DateType.ONLY_DATE);
//        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/spring_boot?serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        // 3、包的配置
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.ning.springboot");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        // 4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("user");  // 设置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);  // 自动生成lombok
        strategy.setLogicDeleteFieldName("deleted"); // 逻辑删除
        strategy.setVersionFieldName("version"); // 乐观锁
        strategy.setRestControllerStyle(true); // restful 风格
        strategy.setControllerMappingHyphenStyle(true); // localhost:8080_id_2
        mpg.setStrategy(strategy);


        /**
         * 自动配置设置
         */
//        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);

        // 执行
        mpg.execute();

    }
}