MyBatis-Plus

已于 2022-10-06 19:59:23 修改
阅读量940 收藏
点赞数
文章标签： mybatis spring
于 2022-10-05 19:13:05 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Li_Ran2394/article/details/127160960
版权

目录

一、简介

二、配置

1、依赖

2、配置文件

3、创建Mapper接口

4、启动类上添加@MapperScan

三、简单的CURD操作

1、插入操作

2、更新操作

3、查询操作

4、删除操作

四、拓展

1、主键生成策略

2、自动填充创建、修改时间

2.1、数据库级别

2.2、代码级别

3、乐观锁的处理

4、MyBatis-Plus自带的分页插件

5、逻辑删除插件

6、性能分析插件

7、条件构造器

8、代码自动生成器

五、参考资料

一、简介

MyBatis-Plus是一个MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。引入它不会对现有工程产生影响；引入后只需简单配置，即可快速进行单表CRUD操作，节省大量时间；适用于任何能使用MyBatis进行CRUD并且支持标准SQL的数据库。 

​

二、配置

1、依赖

		<!-- 数据库驱动 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
		</dependency>

		<!-- mybatis-plus（Spring Boot） -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus-boot-starter</artifactId>
			<version>最新版本</version>
		</dependency>

		<!-- mybatis-plus（Spring） -->
		<dependency>
			<groupId>com.baomidou</groupId>
			<artifactId>mybatis-plus</artifactId>
			<version>最新版本</version>
		</dependency>

2、配置文件

# 数据库连接配置
spring:
  datasource:
    username: root
    password: liboran
    # useSSL是否使用安全连接；useUnicode指定字符的编码解码格式；characterEncoding设置字符编码集；serverTimezone设置时区
    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

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

3、创建Mapper接口

Mapper接口继承BaseMapper<T>，T是对应的实体类

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

4、启动类上添加@MapperScan

使用@MapperScan("mapper包的路径")注解，扫描Mapper包

三、简单的CURD操作

1、插入操作

插入一条数据，参数放入一个对象

2、更新操作

根据Id进行更新，参数放入一个对象

3、查询操作

 4、删除操作

同查询操作

四、拓展

1、主键生成策略

上面在测试插入操作的过程中，并没有设置id属性，但自动生成了一串id，这个id就是根据主键生成策略生成的。可以对id添加注解@TableId，通过type属性设置主键生成策略。

​

IdType源码如下：

public enum IdType {
    AUTO(0),          //自增，数据库中的字段必须设置自增
    NONE(1),          //数据库中未设置主键，当id为空时，采用的是ID_WORKER生成id
    INPUT(2),         //手动输入，未输入id的话报错
    ID_WORKER(3),     //默认的，全局唯一id，雪花算法
    UUID(4),          //全局唯一id，UUID
    ID_WORKER_STR(5); //ID_WORKER的字符串表示

    private int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

2、自动填充创建、修改时间

添加两个字段（实体类中同步添加属性）：创建时间create_time、修改时间update_time，类型为timestamp，数据库版本低的话设置不了两个timestamp，可以考虑更新数据库至8的版本。

2.1、数据库级别

将create_time、update_time的默认值设置为CURRENT_TIMESTAMP，update_time需要勾选根据当前时间戳更新。

2.2、代码级别

① 对createTime和updateTime属性添加@TableField注解，设置fill的属性填充策略

 FieldFill的源码如下：

public enum FieldFill {
    DEFAULT,       //默认的，不填充
    INSERT,        //插入时填充
    UPDATE,        //更新时填充
    INSERT_UPDATE; //插入和更新时填充

    private FieldFill() {
    }
}

 ② 编写处理器MyMetaObjectHandler处理注解

@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill");
        //第一个参数：填充实体类中的哪个属性；第二个参数：填充内容
        this.setFieldValByName("createTime",new Date(),metaObject);
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill");
        this.setFieldValByName("updateTime",new Date(),metaObject);
    }
}

3、乐观锁的处理

使用MyBatis-Plus提供的乐观锁插件

① 添加version字段（实体类中同步添加属性），类型为int

② 对实体类中的version属性添加注解@Version

③ 自定义配置类注册插件

@Configuration //声明这是一个配置类
@EnableTransactionManagement //自动管理事务
@MapperScan("mapper包路径")
public class MyBatisConfig {
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

4、MyBatis-Plus自带的分页插件

① 在MyBatis配置类注册分页插件

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }

② 使用

③ 自定义方法使用分页插件

public interface TClassAttendanceMapper extends BaseMapper<TClassAttendance> {
    //方法传入一个page对象，并返回一个page对象
    Page<TClassAttendance> getAll(Page<TClassAttendance> page);
}


public class TClassAttendanceServiceImpl extends ServiceImpl<TClassAttendanceMapper, TClassAttendance> implements TClassAttendanceService {
    @Autowired
    TClassAttendanceMapper mapper;

    @Override
    public Page<TClassAttendance> getAll(Integer current, Integer size) {
        Page<TClassAttendance> page = new Page<>(current,size);
        page = mapper.getAll(page);
        return page;
    }
}

5、逻辑删除插件

添加字段deleted，类型为int，0表示未删除，1表示逻辑删除。删除时并不直接删除数据库中的数据，而是将deleted由0修改为1，在查询时查询条件会带上deleted = 0，不返回逻辑删除的数据。

① 对实体类中的deleted属性添加@TableLogic注解

② 在MyBatis配置类中注册逻辑删除插件

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

③ 在application配置文件中配置

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

6、性能分析插件

用于分析每条sql的执行时间

① 配置类中注册性能分析插件

    //性能分析插件
    @Bean
    @Profile({"dev","test"}) //设置开发环境和测试环境开启
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100); //设置sql的最大执行时间，单位ms，超时则报错
        performanceInterceptor.setFormat(true); //设置sql语句格式化，便于查看
        return performanceInterceptor;
    }

 ② application中设置环境为测试环境或开发环境

spring:
  # 设置开发环境
  profiles:
    active: dev

sql超时的报错

7、条件构造器

复杂的查询、删除、更新比如说条件查询、范围查询、模糊查询等，可以通过条件构造器Wrapper来实现。比如说：

 ① 查询部分字段

② 查询名字为Jack的用户

③ 查询年龄为15岁的用户姓名

④ 查询名字以j为开头的用户

更多用法参考官方文档

8、代码自动生成器

创建一个类用于自动生成代码

package com.li;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
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.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;

public class CodeGenerator {
    public static void main(String[] args) {
        // 1.实例化一个自动代码生成器对象
        AutoGenerator generator = new AutoGenerator();

        // 2 全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        //获取当前项目路径
        String path = System.getProperty("user.dir");
        //设置代码生成目标目录，当前路径
        globalConfig.setOutputDir(path+"/mybatis-plus/src/main/java");
        // 设置作者
        globalConfig.setAuthor("张三");
        // 设置生成后是否弹出文件夹
        globalConfig.setOpen(false);
        // 设置是否覆盖已有文件
        globalConfig.setFileOverride(false);
        // 设置服务名字，去生成的service的I前缀
        globalConfig.setServiceName("%sService");
        // 设置ID生成策略，自增
        globalConfig.setIdType(IdType.AUTO);
        // 设置日期类型，仅时间
        globalConfig.setDateType(DateType.ONLY_DATE);
        // 是否生成swagger接口文档
        globalConfig.setSwagger2(true);
        // 将全局配置加入代码生成器中
        generator.setGlobalConfig(globalConfig);

        // 3 数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("root");
        dataSourceConfig.setDriverName("com.mysql.cj.jdbc.Driver");
        dataSourceConfig.setDbType(DbType.MYSQL);
        // 将数据源配置加入代码生成器中
        generator.setDataSource(dataSourceConfig);

        // 4 包配置
        PackageConfig packageConfig = new PackageConfig();
        // 设置模块名
        packageConfig.setModuleName("hello");
        // 设置包路径
        packageConfig.setParent("com.test");
        // 设置实体类包名
        packageConfig.setEntity("entity");
        // 设置mapper层包名
        packageConfig.setMapper("mapper");
        // 设置service层包名
        packageConfig.setService("service");
        // 设置controller层包名
        packageConfig.setController("controller");
        // 将包配置加入代码生成器中
        generator.setPackageInfo(packageConfig);

        // 5 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 设置读取哪些表生成代码，可以写多个，逗号隔开
        strategy.setInclude("user");
        // 表名 → 类名的过程将命名规则由_转为驼峰
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 字段名 → 属性名的过程将命名规则由_转为驼峰
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 是否生成Lombok注解
        strategy.setEntityLombokModel(true);
        // 设置逻辑删除的字段名
        strategy.setLogicDeleteFieldName("deletetd");
        // 自动填充策略配置
        TableFill tableFill = new TableFill("create_time", FieldFill.INSERT);
        TableFill tableFill2 = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(tableFill);
        tableFills.add(tableFill2);
        strategy.setTableFillList(tableFills);
        // 乐观锁配置
        strategy.setVersionFieldName("version");
        // 设置controller层为@RestController
        strategy.setRestControllerStyle(true);
        // 将策略配置加入代码生成器中
        generator.setStrategy(strategy);

        //执行代码生成器
        generator.execute();
    }
}

五、参考资料

【狂神说Java】MyBatisPlus最新完整教程通俗易懂_哔哩哔哩_bilibilihttps://www.bilibili.com/video/BV17E411N7KN/?spm_id_from=333.999.0.0&vd_source=18add245858bb01410866b08c994e66bMyBatis-Plus 官方文档https://baomidou.com/

mybatis-plus代码生成器模版代码
08-17
<artifactId>mybatis-plus-boot-starter <version>3.4.3</version> <!-- 请根据最新版本号替换 --> ``` 接着，配置代码生成器的相关参数，包括数据源信息、生成的包路径、作者信息等。这些参数可以通过Java代码...
mybatis-plus自动生成代码
热门推荐
踏 浪的博客
01-12 3万+
一、介绍 本教程将介绍如何使用 mybatis-plus 工具自动给我们生成 Controller、Service、Entity、Mapper、Mapper.xml 层代码 要求: ① 生成的Controller类，需要继承 BaseController ② 生成的Entity 类，需要继承 BaseEntity ③ 生成的 Service，默认名称下是以 I 开头的接口, 在生成Se...
MybatisPlus配置双数据库驱动
马明的博客
01-21 2598
个人博客纯净版 MybatisPlus配置双数据库驱动 | 代码搬运工 最近项目中需要用到2种数据库驱动连接数据库，下面我们基于MybatisPlus实现一下 具体实现 1、在pom.xml中添加如下依赖: <properties> <java.version>1.8</java.version> <lombok.version>1.18.2</lombok.version> <mybatis-plus
Mybatis插件开发
qq_44621930的博客
01-21 268
Mybatis插件开发 这里主要了解一下Mybatis的插件开发。 Mybatis插件介绍 Mybatis插件准确的说应该是拦截器，接口名为Interceptor，在配置中叫插件，功能非常强大，可以让我们无侵入式的对SQL的执行进行干涉，从SQL语句重写、参数注入、结果集返回等每个主要环节。 MyBatis默认支持对4大对象 ​ Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClos
Mybatis Builder如何配置使用详细教程
知世故而不世故
02-12 3841
关于Mybatis Builder安装步骤还请移步：IDEA安装Mybatis Builder插件操作步骤 1、安装成功后，一般情况下会出现在IDEA左侧导航栏上 2、点击后进行数据库连接配置 3、填写完成后，可以点击Test connection 连接测试，success 即为成功，然后点击OK 4、这个时候，我们找到这个库，选择一张表，右击选择Build，下面进行生成代码的配置工作。 5、填写配置信息 6、选择生成的路径，此处注意包名别写错 然后点击OK，就生成了三个文件，到相应路径下去查看
mybatisplus代码生成覆盖
qq_26949717的博客
09-15 2024
com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine - 文件[*]已存在，且未开启文件覆盖配置，需要开启配置可到策略配置中设置！然后去StrategyConfig使用fileOverride()方法，但是不存在，3.5.3把fileOverride()移到了每个类里。，要配就要如下图所示，分别设置，但是.3.5.3提示该方法后续会删除，建议使用enableFileOverride()，然后OK。
Mybatis-plus自动生成代码
10-12
Mybatis-plus是一款基于Mybatis和Spring的轻量级框架，它扩展了Mybatis的功能，提供了更便捷的操作数据库的方式。在项目开发中，Mybatis-plus的一个重要特性就是其代码生成器，能够极大地提高开发效率，减少手动编写...
mybatis-plus代码自动生成工具
07-22
Mybatis-Plus是一款基于MyBatis框架的扩展库，它为开发者提供了强大的代码生成器，大大简化了在Java开发中的数据访问层（DAO）代码编写工作。MyBatis-Plus的核心功能包括：CRUD操作、条件构造器、关联查询、分页插件...
mybatis-plus 达梦 代码生成
06-10
标题"mybatis-plus 达梦 代码生成"表明了本文将要讨论的是如何使用Mybatis-Plus框架结合达梦数据库来自动生成代码。Mybatis-Plus是Mybatis的一个增强工具，它在Mybatis的基础上做了很多简化操作，如自动CRUD（创建、...
mybatis-plus源码（mybatis-plus-3.5.1.zip）
03-03
此源码包`mybatis-plus-3.5.1.zip`包含了MyBatis-Plus 3.5.1版本的全部源代码，有助于我们深入理解其内部实现机制和工作原理。 MyBatis-Plus的主要功能包括： 1. **CRUD操作**：MyBatis-Plus提供了简化版的CRUD...
mybatis-plus-boot-starter-3.1.0.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
mybatis-plus-boot-starter-3.3.0.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
mybatis-plus-boot-starter-3.5.3.2.jar
最新发布
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
mybatis-plus-boot-starter-3.4.3.3.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
mybatis-plus-boot-starter-3.5.0.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
【精】简单 就一个类 ---使用MyBatis Generator自动生成代码(com.baomidou.mybatisplus)
cx19910829的专栏
09-16 3342
所以我这边写了个简单的，就一个基础类搞定，其中有很多注释，你可以自定义选择需要一些特殊的配置（本来写好的项目 ，而且里面有很多集成的mybatis使用方式来着，结果一下让我给删了，而且找不回来了也。我就懒得重新写个项目了 ，心累啊！我们使用MyBatis Generator自动生成代码，网上搜了一堆 都不靠谱，一点不简洁。baseMapper 是mybatisplus 自带的写法。
MyBatis核心配置
jjjyyyyyyy的博客
04-29 360
MyBatis核心配置 mybatis-config.xml 系统核心配置文件 MyBatis 的配置文件包含了会深深影响 MyBatis 行为的设置和属性信息。 需要按照一定的顺序，不然会报错 configuration（配置） properties（属性） settings（设置） typeAliases（类型别名） typeHandlers（类型处理器） objectFactory（对象工厂） plugins（插件） environments（环境配置） enviro
SpringBoot集成Mybatis时的数据库驱动：com.mysql.cj.jdbc.Driver与com.mysql.jdbc.Driver的选择使用
weixin_48240226的博客
07-31 3567
在springboot集成mybatis后，配置数据源信息时：需要额外配置时区、数据库驱动为：com.mysql.cj.jdbc.Driver 如果想使用我们经常用的方式，可以在pom.xml文件中手动指定版本 更改版本之后的配置信息： 附加：配置文件中驱动报红 只需要将上面添加版本后面pom.xml中的runtime注释即可。报红是因为范围设定是运行时期，所以报红对运行时期没有影响，注释之后默认包含编译时期。 使用mysql6.0以上的版本需要指定时区，配置的驱动与我们常用的也不一样，手动设定版本之
MybatisPlus-Generator
无简介
08-31 1万+
本文将详细介绍mybatisplus-generator的相关使用，mybatisplus-generator是 MyBatis Plus 框架中的一个代码生成工具，它能够自动生成与数据库表对应的 Java 实体类、Mapper 接口以及 XML 配置文件。它的出现极大地提高了开发效率，让开发者能够将更多的精力集中在业务逻辑上，而不是繁琐的 CRUD 操作上。
MyBatis-Plus 官方示例深度剖析
1. mybatis-plus-sample-quickstart（快速开始示例）： 此模块提供了最基本的MyBatis-Plus使用场景，演示了如何快速搭建一个使用MyBatis-Plus的项目，包括依赖配置、实体类编写、Mapper接口定义以及服务层和控制层...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值