Mybatis-plus学习

最新推荐文章于 2024-06-27 18:55:40 发布

乐幼

最新推荐文章于 2024-06-27 18:55:40 发布

阅读量276

点赞数 4

文章标签： mybatis 学习

本文链接：https://blog.csdn.net/leyou921/article/details/139659053

版权

Mybatis-plus

简介

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

**官网地址：**https://mybatis.plus/

依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.2</version>
</dependency>

特性

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本 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、导入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.5</version>
</dependency>

2、创表并插入数据

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 '邮箱',
`del_flag` tinyint(1) DEFAULT '0' COMMENT '删除标志（0：未删除，1：已删除）',
`create_time` datetime DEFAULT NULL COMMENT '创建时间',
`update_time` datetime DEFAULT NULL COMMENT '修改时间',
PRIMARY KEY (id)
);
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、实体类

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

4、Mapper接口

@Repository
public interface UserMapper extends BaseMapper<User> {
}

5、测试

@SpringBootTest
class MybatisPlusApplicationTests {
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

注意：SpringBootApplicaiton主启动类需要加入@MapperScan("com.mp.mapper")注解，使这些mapper被spring扫描到

配置日志

# 开启mybatis-plus的日志功能
mybatis-plus:
  configuration: # 配置日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

在yml核心配置文件中加入配置即可开启sql日志打印，一般用于测试和开发环境使用，方便调试

CURD扩展

新增

@Test
void testInsert(){
    User user = new User();
    user.setAge(18);
    user.setName("乐幼");
    user.setEmail("123@qq.com");

    int insert = userMapper.insert(user);
    System.out.println(insert);
    System.out.println(user);//输出发现id未赋值,但是新增成功后确有值
}

id值的默认生成策略，雪花算法，来保证这个值几乎是全球唯一的id。

雪花算法

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

主键自增如何做？

@TableId(type = IdType.AUTO)这个注解放到id字段上即可，但是保证数据库这个字段也是自增

其他的id类型解释

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

结论：

自增id：使用IdType.AUTO，以及数据库字段也必须设置自增策略
唯一id：id类型为ID_WORKER即可生成全局唯一id
手动输入：当id类型为INPUT的时候，需要手动给id赋值，不然会是null空值
默认生成id：使用了一个基于 Snowflake 算法的自增 ID 生成器。这个生成器可以生成全局唯一的 ID，并且具有递增性。

修改

@Test
void testUpdate(){
    User user = new User();
    user.setId(1L);
    user.setAge(20);
    user.setName("乐幼");
    user.setEmail("123");
    userMapper.updateById(user);//虽然是byId,但是里面需要传一个对象
}

删除

@Test
void testDelete(){
    userMapper.deleteById(1L);
}

自动填充

对于表单中创建时间以及更新时间字段，如何赋值呢？

1、数据库级别（不建议使用）

将时间字段设置默认值为当前时间戳即可完成自动更新值，但是一般不建议这么使用，生产环境数据不建议数据库可以直接更改。

2、代码级别（墙裂推荐）

实现mybatis-plus中的MetaObjectHandler类，通过重写其中方法，设定新增数据时什么字段会自动填充值，更新数据时什么字段会自动填充值。

// 自动填充
@Component
public class DateAutoInsertHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        // 新增的时候创建时间自动插入当前时间
        this.setFieldValByName("createTime",new Date(),metaObject);
        // 新增的时候更新时间自动插入当前时间
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        // 更新的时候更新时间自动插入当前时间
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

测试新增数据，不赋值的情况下，创建时间以及更新时间会被自动填充

测试修改数据，不赋值的情况下，更新时间会被自动填充

乐观锁

乐观锁：顾名思义十分乐观，它总是认为不会出现问题，无论干什么都不上锁！如果出现了问题，再去处理。

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

乐观锁实现方式：

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

使用乐观锁

1、数据库新增version字段，并默认赋值为1

2、pojo对应的实体类新增version字段，并添加@Version注解

@Version
private Integer version;

3、添加插件配置

@Configuration
@EnableTransactionManagement
public class HappyLockConfig {
    //实现乐观锁
    @Bean
    public OptimisticLockerInnerInterceptor optimisticLockerInnerInterceptor() {
        return new OptimisticLockerInnerInterceptor();
    }
}

4、测试

模拟单线程（单线程操作，数据保存正常）

@Test
void testLock(){
    User user = userMapper.selectById(1L);
    user.setAge(100);
    userMapper.updateById(user);
}

模拟多线程

@Test
//模拟并发场景下,线程A来修改数据,但是还未保存,线程B也来修改数据了,而且线程B先保存,线程A在保存
void testLock2(){
    //线程A获取到数据,然后修改
    User user = userMapper.selectById(1L);
    user.setAge(1000);
    user.setName("1000");

    //此时线程B插队来获取数据,并且修改同一条数据
    User user2 = userMapper.selectById(1L);
    user2.setName("100000");
    user2.setAge(999);
    //线程B先保存了这条数据
    userMapper.updateById(user2);
    //因为配置了乐观锁,所以数据库最终留存的是B保存的数据,A提交的数据不会被保存并覆盖B的数据,因为version不一致

    //随后线程A在保存，由于version版本不一致，数据不会保存。
    userMapper.updateById(user);

}

分页查询

1、加入配置

@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
    MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
    interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
    return interceptor;
}

2、使用Page对象即可

@Test
void testPage(){
    Page<User> page = new Page<>(1, 2);
    Page<User> pages = userMapper.selectPage(page, null);
    pages.getRecords().forEach(System.out::println);
}

万能Map

使用map作为条件来查询或者删除

@Test
void useMap(){
    Map<String,Object> map = new HashMap<>();
    map.put("name","乐幼");
    userMapper.selectByMap(map);
    userMapper.deleteByMap(map);
}

逻辑删除

物理删除：直接删除这条数据

逻辑删除：实际上没有删除数据，只是修改了删除状态，类似回收站功能，防止数据真的丢失。

1、数据库表加入deleted字段，值设置默认为0

2、实体类对应添加deleted字段，并配置@TableLogic注解

@TableLogic
private Integer deleted;

3、yml配置文件配置

mybatis-plus:
  global-config:
    db-config:
      logic-delete-value: 1  # 逻辑删除字段的值（已删除/无效为1，有效为0）
      logic-not-delete-value: 0 # 逻辑未删除字段的值（已删除/无效为0，有效为1）

配置完成后，MyBatis-Plus会自动处理逻辑删除相关的操作。

当执行删除操作时，它会把对应的记录标记为逻辑删除值，而不是物理删除。
当查询时，它会自动过滤掉逻辑删除的记录，即只返回未删除的记录。

性能分析插件

加入配置，以及yml文件中需要配置spring.profiles.active为dev或者test。

但是3.2.0之后的版本就将其功能移除

@Bean
@Profile({"dev", "test"}) // 设置 dev test 环境开启，保证不会在生产环境影响性能
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    // 设置SQL执行的最大时间，如果超过这个时间，则SQL不能执行
    performanceInterceptor.setMaxTime(100);
    // 设置SQL是否执行，默认false不执行
    performanceInterceptor.setFormat(true);
    return performanceInterceptor;
}

高级条件查询

@Test
void selectList() {
    int i = 0;
    List<User> users = userMapper.selectList(new LambdaQueryWrapper<User>()
                                             .eq(User::getAge, 99)
                                             .like(User::getName, "乐")
                                             .between(User::getAge, 10, 100)
                                             .like(i==0, User::getName, "乐") //i==0才会触发这个条件
                                            );
    for (User user : users) {
        System.out.println(user);
    }
}

代码生成器

需要使用的依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</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.5.2</version>
</dependency>
<!-- 代码生成器依赖 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>
<!-- 代码生成器引用模板引擎 -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

代码编写

package com.mp;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
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.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

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

// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
public class Code {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    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("lx");
        gc.setOpen(false);
        gc.setSwagger2(true); //实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

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

        // 包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(scanner("模块名"));
        pc.setParent("com.mp");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";

        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setSuperEntityClass("");
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        // 公共父类
        strategy.setSuperControllerClass("");
        // 写于父类中的公共字段
        strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}