mybatis-plus学习笔记

已于 2022-07-20 15:35:29 修改
阅读量816 收藏
点赞数 1
分类专栏： Mybatis-plus 文章标签： java
于 2022-03-29 11:29:10 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_45657870/article/details/123816429
版权

注：笔记根据观看B站狂神说MyBatis-plus所写，有不懂的地方可以看看阿婆主的视频。

Mybatis-plus概述

MyBatisPlus可以节省大量工作时间，所有的CRUD代码都可以自动化完成

JPA、MyBatisPlus

简介

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

快速入门

官方文档

使用第三方插件：

  1. 导入对应的依赖
  2. 研究依赖如何配置
  3. 代码如何编写
  4. 提高扩展技术能力
步骤

1.创建数据库

2.创建表

3.编写项目，初始化项目，使用springBoot初始化

4.导入依赖

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

说明：尽量不要同时导入mybatis和mybatis-plus，可能存在版本的差异

5.连接数据库

# mysql8驱动、需要增加时区的配置
spring.datasource.driverClassName=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/dorm?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root

// 6.传统的pojo-dao（连接mybatis，配置mapper.xml文件）

6.使用了mybatis-plus之后

  • pojo
  • mapper接口
  • 使用

可以直接使用generator逆向工程生成实体类和目录结构

  1. 导入依赖
<!--Mybatis-Plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.1</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

​ 2.创建生成类

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 java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

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

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

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

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

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

        // 如果模板引擎是 freemarker
//        String templatePath = "/templates/mapper.xml";
        // 如果模板引擎是 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();
    }

}

​ 3.运行，完成。

​ 4.在SpringBoot启动类上添加@MapperScan扫描mapper包下的所有接口

MapperScan("com.hjw.mapper")
@SpringBootApplication
public class DormApplication {
    public static void main(String[] args) {
        SpringApplication.run(DormApplication.class, args);
    }
}

​ 5.在mapper接口中添加@Repository注入bean

配置日志

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

CRUD扩展

Insert

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

// id对应数据库中的主键（uuid、自增id、雪花算法(分布式）、redis、zokkeeper)

主键生成策略

IdType包括以下几类：

  • AUTO : 数据库主键自增

  • INPUT: 用户自行输入

  • ID_WORKER: 分布式全局唯一ID， 长整型

  • UUID: 32位UUID字符串

  • NONE: 无状态

  • ID_WORKER_STR: 分布式全局唯一ID 字符串类型

  • 默认@Table(type = IdType.ID_WORKER)全局唯一id

    分布式系统唯id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

    ​ 雪花算法：

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

  • 主键自增

    我们需要配置主键自增：

    1. 实体类字段上@Table(type = IdType.Auto)
    2. 数据库字段一定要自增
Update
自动填充

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

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

​ 方式一：数据库级别（工作中不允许修改数据库，只供学习）

  1. 在表中新增字段，create_time，update_time
  2. 设置默认值CURRENT_TIMESTAMP，更新时间勾选更新

​ 方式二：代码级别

  1. 实体类字段属性上添加注解

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

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

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

    @Slf4j // 日志
@Component // 一定不要忘记把处理器加到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler{
    // 插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject){
        log.info("start insert fill......");
        // setFieldValByName(String fieldName,Object fieldVal,MetaObject metaObject)
        this.setFiedValByName("createTime",new Data(),metaObject);
    }
    
    // 更新时的填充策略
    public void insertFill(MetaObject metaObject){
        log.info("start update fill......");
        this.setFiedValByName("updateTime",new Data(),metaObject);
    }
    
}
乐观锁

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

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

乐观锁实现方式：

  • 取出记录时，获取当前 version
  • 更新时，带上这个 version
  • 执行更新时， set version = newVersion where version = oldVersion
  • 如果 version 不对，就更新失败
-- A
update user set name = "hjw",version = version + 1
where id = 2 and version = 1

-- B 线程抢先完成，这个时候version = 2，会导致A修改失败

  1. 给数据库中添加version字段

  2. 给实体类添加对应的字段

  3. 注册组件

    //扫描我们的mapper文件夹
@MapperScan("com.hjw.mapper")
@EnableTransactionManagement
@Configuration  // 配置类
public class MybatisPlusConfig{
    
    // 注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }
}
查询操作
  1. 可以使用map操作，但不推荐
分页查询
  1. 原始的limit进行分页
  2. pageHelper第三方插件
  3. Mybatis-plus内置了分页插件

如何使用

  1. 配置拦截器组件即可

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

  2. 直接使用Page对象即可

    // 测试分页查询
public void testPage(){
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(Page,null);
}
Delete

逻辑删除

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

​2.实体类中增加属性

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

​ 3.配置

// 逻辑删除组件
@Bean
public IsqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

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

​ 4.测试删除

逻辑删除实际上走的是更新操作，并不是删除操作

查询的时候会自动过滤deleted=1的数据

性能分析插件

我们在平时的开发中，会遇到一些慢sql。通过测试或者druid找出来

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

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

  1. 导入插件

    一定要在SpringBoot中配置环境为dev或者test环境

    # 设置开发环境
spring.profiles.active=dev

  2. 测试使用

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

使用性能分析插件，可以帮助我们提高效率

条件构造器

Wrapper

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

@Override
public Page<Student> getStudent(long current,long size,String className){
    Page<Student> page = new Page<>(current,size);
    if(StringUtils.isNotBlank(className)){
        QueryWrapper<Student> studentQueryWrapper = new QueryWrapper<>();
        studentQueryWrapper.like("class_name",className);
        return studentMapper.selectPage(page,studentQueryWrapper);
    }else{
        return studentMapper.selectPage(page,null);
    }
}

版本问题

有版本问题可以查看MyBatis-plus官方文档，思路一致只是写法有差异，或者仿照下图写
在这里插入图片描述

小韩同学_
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
解决关于mybatis-plus修改字段时会自动忽略值为null的字段
angang12的博客
10-25 2310
使用mybatis-plus修改单表的时候非常方便，但是如果想给某个字段的值设置为null，mybatis-plus在执行修改的时候会自动忽略掉值为null的字段。所以需要使用注解： @TableField(updateStrategy = FieldStrategy.IGNORED) 在模型类中找到你要修改值为null的字段，加上这个注解： @TableField(updateStrategy = FieldStrategy.IGNORED) private BigDecimal latitude; 就
[转载]MyBatis-Plus——超详细讲解配置文件
lklalmq的博客
06-25 4840
在我们的【MyBatis-Plus】中有许多【配置】，也就是当我们需要用到的时候，会在配置文件中进行编写的属性，本篇博客将会讲解这些配置的【作用】，以及简单【使用】。
mybatis-plus基础知识
最新发布
2401_83817603的博客
03-26 987
光给面试题不给答案不是我的风格。这里面的面试题也只是凤毛麟角，还有答案的话会极大的增加文章的篇幅，减少文章的可读性光给面试题不给答案不是我的风格。这里面的面试题也只是凤毛麟角，还有答案的话会极大的增加文章的篇幅，减少文章的可读性。
mybatis-plus多数据源配置
yaoct的博客
12-02 6605
这里结合了springboot的多数据源配置，主要是手动创建数据源，再手动设置配置一些配置参数。
MyBatis-Plus配置之基础配置（SpringBoot）
心态的博客
12-02 3191
基本配置是开发前必备的知识。只有配置一个良好的环境，开发过程中才会更加的顺畅~
你应该懂点Mybatis-plus，真的好用
Recently祝祝的博客
04-03 3620
Mybatis-plus 是一个基于 Mybatis 的增强工具，提供了许多便捷的 CRUD 操作和其他实用功能，简化了数据库访问的开发工作。它是 Mybatis 的一个开源组件，遵循 Apache 2.0 协议。
MyBatis-Plus 学习笔记.pdf
08-30
自己总结的MyBatis-Plus 学习笔记
【Mybatis-Plus学习笔记二】——Mybatis-Plus进阶使用.zip
06-09
【Mybatis-Plus学习笔记二】——Mybatis-Plus进阶使用.zip 博客地址：https://blog.csdn.net/weixin_43817709/article/details/117751784
【Mybatis-Plus学习笔记一】——Mybatis-Plus快速使用.zip
06-08
【Mybatis-Plus学习笔记一】——Mybatis-Plus快速使用.zip 博客地址：https://blog.csdn.net/weixin_43817709/article/details/117717192
mybatis-plus学习项目笔记
07-07
mybatis-plus学习项目笔记
【Mybatis-Plus学习笔记三】——Mybatis-Plus实现乐观锁.zip
06-10
【Mybatis-Plus学习笔记三】——Mybatis-Plus实现乐观锁.zip 博客地址：https://blog.csdn.net/weixin_43817709/article/details/117780896
MyBatisPlus学习笔记
qq_52778383的博客
10-17 4244
MybatisPluns学习笔记，记录了常用的功能和方法，包括MybatisPlun的使用、条件构造器Wrapper、通过MybatisPlun使用CRUD、常用注解、MybatisPlus插件等。
mybatis-plus学习 四、查询/删除
qq_45211599的博客
09-02 2144
一、查询 1、通过多个id查询用户 selectBatchIds(Collection<? extends Serializable> idList); 创建一个数组，把id放进数组中 @Test void testSelect(){ List<User> userList = userMapper.selectBatchIds(Arrays.asList(1, 2, 3, 4)); for (User user : userList
Mybatis-plus学习笔记 (B站狂神说)(自己总结方便复习)
暴走的山交君的博客
09-30 6223
MyBatisPlusB站狂神说 学习MyBatis-Plus之前要先学MyBatis–>Spring—>SpringMVC 为什么要学它?MyBatisPlus可以节省我们大量的时间,所有CRUD代码都可以自动完成 JPA, tk-mapper ,MyBatisPlus 偷懒用的! 1.简介 是什么? 官网:https://baomidou.com/ 2.特性 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑 损耗小：启动即会自动注入基本 CURD，性能基本无损
mybatis plus 学习笔记
63516的博客
04-14 1105
mybatis plus 学习笔记，整理了学习动力节点-MP的学习笔记
Mybatis-plus 入门笔记（二）分页、更新、ActiveRecord
SmileTimLi的博客
12-03 1473
1、更新操作 @RunWith(SpringRunner.class) @SpringBootTest public class UpdateMapperTest { @Resource private UserMapper userMapper; @Test public void test01() { User user = userMa...
mybatis-plus学习笔记（三）配置
卑微的码农
07-19 1967
import com.baomidou.mybatisplus.core.injector.ISqlInjector; import com.baomidou.mybatisplus.core.parser.ISqlParser; import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector; import com.bao...
mybatis-pus大于小于
08-10
Mybatis-plus框架中，可以使用条件构造器来实现大于小于的查询条件。在配置文件中，可以通过设置logic-delete-value和logic-not-delete-value来定义逻辑删除的取值。在pom文件中导入mybatis-plus的依赖包来使用该框架。在项目根路径的resources文件夹下的spy.properties文件中，可以配置P6Spy来记录SQL日志。123 #### 引用[.reference_title] - *1* *2* [Mybatis-plus 学习笔记](https://blog.csdn.net/qq_42976486/article/details/120715195)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}} ] [.reference_item] - *3* [Mybatis-plus配置使用说明](https://blog.csdn.net/sinat_35663368/article/details/115523727)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}} ] [.reference_item] [ .reference_list ]

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值