MybatisPlus框架教程：入门、条件构造器、接口操作、代码生成器

已于 2023-09-06 17:11:29 修改
阅读量163 收藏 1
点赞数 1
分类专栏： Java SSM 文章标签： java spring boot mybatis 后端
于 2023-09-06 17:11:03 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_73976305/article/details/132719444
版权

MybatisPlus框架

文章目录

前面我们体验了JPA带来的快速开发体验，但是我们发现，面对一些复杂查询时，JPA似乎有点力不从心，反观稍微麻烦一点的Mybatis却能够手动编写SQL，使用起来更加灵活，那么有没有一种既能灵活掌控逻辑又能快速完成开发的持久层框架呢？

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

MybatisPlus的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

img

官方网站地址

MybatisPlus具有以下特性：

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

框架整体结构如下：

image-20230906170259726

不过，光说还是不能体会到它带来的便捷性，我们接着就来上手体验一下。

快速上手

跟之前一样，还是添加依赖：

<dependency>
     <groupId>com.baomidou</groupId>
     <artifactId>mybatis-plus-boot-starter</artifactId>
     <version>3.5.3.1</version>
</dependency>
<dependency>
     <groupId>com.mysql</groupId>
     <artifactId>mysql-connector-j</artifactId>
</dependency>

配置文件依然只需要配置数据源即可：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

然后依然是实体类，可以直接映射到数据库中的表：

@Data
@TableName("user")  //对应的表名
public class User {
    @TableId(type = IdType.AUTO)   //对应的主键
    int id;
    @TableField("name")   //对应的字段
    String name;
    @TableField("email")
    String email;
    @TableField("password")
    String password;
}

接着，就可以编写一个Mapper来操作了：

@Mapper
public interface UserMapper extends BaseMapper<User> {
  	//使用方式与JPA极其相似，同样是继承一个基础的模版Mapper
  	//这个模版里面提供了预设的大量方法直接使用，跟JPA如出一辙
}

这里我们就来写一个简单测试用例：

@SpringBootTest
class DemoApplicationTests {

    @Resource
    UserMapper mapper;

    @Test
    void contextLoads() {
        System.out.println(mapper.selectById(1));  //同样可以直接selectById，非常快速方便
    }
}

可以看到这个Mapper提供的方法还是很丰富的：

image-20230906150819650

最后查到的结果

image-20230906152506512

条件构造器

对于一些复杂查询的情况，MybatisPlus支持我们自己构造QueryWrapper用于复杂条件查询：

@Test
void contextLoads() {
    QueryWrapper<User> wrapper = new QueryWrapper<>();    //复杂查询可以使用QueryWrapper来完成
  	wrapper
            .select("id", "name", "email", "password")    //可以自定义选择哪些字段
            .ge("id", 2)     			//选择判断id大于等于1的所有数据
            .orderByDesc("id");   //根据id字段进行降序排序
    System.out.println(mapper.selectList(wrapper));   //Mapper同样支持使用QueryWrapper进行查询
}

通过使用上面的QueryWrapper对象进行查询，也就等价于下面的SQL语句：

select id,name,email,password from user where id >= 2 order by id desc

在配置中开启SQL日志打印：

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

最后得到的结果如下：

image-20230906152739690

有些时候我们遇到需要批处理的情况，也可以直接使用批处理操作：

@Test
void contextLoads() {
    //支持批处理操作，我们可以一次性删除多个指定ID的用户
    int count = mapper.deleteBatchIds(List.of(1, 3));
    System.out.println(count);
}

image-20230906153026936

也可以快速进行分页查询操作，不过在执行前我们需要先配置一下：

@Configuration
public class MybatisConfiguration {
    @Bean
    public MybatisPlusInterceptor paginationInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
      	//添加分页拦截器到MybatisPlusInterceptor中
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

这样我们就可以愉快地使用分页功能了：

@Test
void contextLoads() {
    //这里我们将用户表分2页，并获取第一页的数据
    Page<User> page = mapper.selectPage(Page.of(1, 2), Wrappers.emptyWrapper());
    System.out.println(page.getRecords());   //获取分页之后的数据
}

image-20230906170241744

对于数据更新操作，我们也可以使用UpdateWrapper非常方便的来完成：

@Test
void contextLoads() {
    UpdateWrapper<User> wrapper = new UpdateWrapper<>();
    wrapper
            .set("username", "hHHH")
            .eq("id",4);
    System.out.println(mapper.update(null, wrapper));
}

这样就可以快速完成更新操作了：

image-20230906155919339

QueryWrapper和UpdateWrapper还有专门支持Java 8新增的Lambda表达式的特殊实现，可以直接以函数式的形式进行编写，使用方法是一样的：

@Test
void contextLoads() {
        LambdaQueryWrapper<User> wrapper = Wrappers
                .<User>lambdaQuery()
                .eq(User::getId, 2)   //比如我们需要选择id为2的用户，前面传入方法引用，后面比的值
                .select(User::getName, User::getId);   //比如我们只需要选择name和id，那就传入对应的get方法引用
        System.out.println(mapper.selectOne(wrapper));
}

接口基本操作

虽然使用MybatisPlus提供的BaseMapper已经很方便了，但是我们的业务中，实际上很多时候也是一样的工作，都是去简单调用底层的Mapper做一个很简单的事情，MybatisPlus为我们提供了很方便的CRUD接口，直接实现了各种业务中会用到的增删改查操作。

我们只需要继承即可：

@Service
public interface UserService extends IService<User> {
  	//除了继承模版，我们也可以把它当成普通Service添加自己需要的方法
}

接着需要编写一个实现类，这个实现类就是UserService的实现：

@Service   //需要继承ServiceImpl才能实现那些默认的CRUD方法
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}

使用起来也很方便，整合了超多方法：

image-20230906162446494

比如想批量插入一组用户数据到数据库中：

@Test
void contextLoads() {
    List<User> users = List.of(new User("xxx"), new User("yyy"));
  	//预设方法中已经支持批量保存了，这相比我们直接用for效率高不少
    service.saveBatch(users);
}

还有更加方便快捷的保存或更新操作，当数据不存在时（通过主键ID判断）则插入新数据，否则就更新数据：

@Test
void contextLoads() {
    service.saveOrUpdate(new User("aaa"));
}

也可以直接使用Service来进行链式查询，写法非常舒服：

@Test
void contextLoads() {
    User one = service.query().eq("id", 1).one();
    System.out.println(one);
}

新版代码生成器

image-20230721200757985

首先需要先把整个项目的数据库给创建好，创建好之后，我们继续下一步，这里我们从头开始创建一个项目，感受一下它的强大，首先创建一个普通的SpringBoot项目：

image-20230721202019230

导入一会需要用到的依赖：

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3.1</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.3.1</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

配置一下数据源：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

开始编写自动生成脚本了，这里依然选择测试类，用到FastAutoGenerator作为生成器：

	@Resource
    DataSource dataSource;

	@Test
    void contextLoads() {
        FastAutoGenerator
          			//首先使用create来配置数据库链接信息
                .create(new DataSourceConfig.Builder(dataSource))
                .execute();
    }

接着配置一下全局设置，这些会影响一会生成的代码：

@Test
void contextLoads() {
    FastAutoGenerator
            .create(new DataSourceConfig.Builder(dataSource))
            .globalConfig(builder -> {
                builder.author("rx");              //作者信息，一会会变成注释
                builder.commentDate("2023-09-06");  //日期信息，一会会变成注释
                builder.outputDir("src/main/java"); //输出目录设置为当前项目的目录
            })
            .execute();
}

然后是打包设置，也就是项目的生成的包等等，这里简单配置一下：

@Test
void contextLoads() {
    FastAutoGenerator
            ...
      			//打包设置，这里设置一下包名就行，注意跟我们项目包名设置为一致的
      			.packageConfig(builder -> builder.parent("com.example"))
      			.strategyConfig(builder -> {
                    //设置为所有Mapper添加@Mapper注解
                    builder
                            .mapperBuilder()
                            .mapperAnnotation(Mapper.class)
                            .build();
            })
            .execute();
}

接着我们就可以直接执行了这个脚本了：

image-20230906170228170

现在，可以看到我们的项目中已经出现自动生成代码了：

image-20230906163729262

我们也可以直接运行这个项目：

image-20230906170218973

速度可以说是非常之快，一个项目模版就搭建完成了，我们只需要接着写业务就可以了，当然如果各位小伙伴需要更多定制化的话，可以在官网查看其他的配置：配置

对于一些有特殊要求的用户来说，我们希望能够以自己的模版来进行生产，怎么才能修改它自动生成的代码模版呢，我们可以直接找到mybatis-plus-generator的源码：

image-20230906164846842

生成模版都在在这个里面有写，我们要做的就是去修改这些模版，变成我们自己希望的样子，由于默认的模版解析引擎为Velocity，我们需要复制以.vm结尾的文件到resource随便一个目录中，然后随便改：

image-20230906170635711

接着我们配置一下模版：

@Test
void contextLoads() {
    FastAutoGenerator
            ...
      			.strategyConfig(builder -> {
                builder
                        .mapperBuilder()
                        .enableFileOverride()   //开启文件重写，自动覆盖新的
                        .mapperAnnotation(Mapper.class)
                        .build();
            })
            .templateConfig(builder -> {
                builder.mapper("/templates/mapper.java.vm");
            })
            .execute();
}

这样，新生成的代码中就是按照我们自己的模版来定义了:

image-20230721211002961

RenX000
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot入门(15)：【实战教程】Spring Boot + MyBatis-Plus 自动生成骨架代码，告别枯燥的重复劳动！
**My Coding Family**
05-08 2806
Spring Boot 整合 MyBatis-Plus AutoGenerator 自动生成项目骨架代码，一文教会你。
MyBatisPlus条件构造器 AR 代码生成器 插件 自定义全局 公共字段填充
chengqingshihuishui的博客
03-28 441
新建数据表 根据该数据表，在java中创建好对应的实体类 特别说明：定义javabean中的实体类最好使用包装类，虽然现在已经可以有自动包装，和自动拆箱。但是如果使用基本数据类型，基本数据类型都有默认值，int的默认值为0，boolean默认值为false，主要是由于mysql有非空判定，默认值会让mysql判断不准确。所以最好用包装类 javabean代码 依赖配置 maven的pom.xml配置 粘贴好各种配置文件 入门helloworld EmployeeMapper.java 为什么可以自动映射驼
Mybatis Plus 入门 简单的CRUD 使用详解 条件查询 分页查询 DML操作 MP代码生成器
weixin_46589095的博客
05-11 1144
Mybatis Plus 入门 简单的CRUD 使用详解 条件查询 分页查询 DML操作 MP代码生成器
MybatisPlus基础入门以及入门案例
靖妖傩舞
02-22 896
MyBatis-Plus学习整理
MyBatisPlus系列第二篇：MyBatisPlus入门Hello World
qq_29445811的博客
05-22 413
文章目录一、通用Mapper CRUD1、提出问题？二、通用Mapper 插入操作三、更新操作四、查询操作五、删除操作通用CRUD总结 一、通用Mapper CRUD 1、提出问题？ 假设我们有一张员工表，有对应的实体类Employee、实现CRUD需要怎么操作？ 实现方式： 1、基于mybatis:我们需要写一个EmployeeMapper接口、提供crud方法。再编写对应的EmployeeMapper.xml文件，编写每一个接口方法对应的SQL语句 2、基于MP:我们只需要写一个EmployeeMapp
Mybatis Plus————代码生成器
热门推荐
Morty的技术乐园
06-17 11万+
代码生成器MyBatis Plus是MyBatis的扩展框架，而代码生成器是MP的核心功能之一，另外还有 “条件构造器”和“通用CRUD”等功能。步骤演示mp的代码生成器有两种方式自动生成代码，一种是通过main方法来执行程序，另一种是通过maven插件build产生。第二种方法需要在pom.xml中添加大量的配置信息，因此本人偏向于使用第一种方式。步骤如下：一、添加mybatis plus依赖：...
MyBatisPlus：实现DAO的增删改查分页+属性设置，代码生成器（代码模板）
habe33的博客
07-26 2677
> 基于MyBatisPlus完成标准Dao的增删改查功能 > 掌握MyBatisPlus中的分页及条件查询，分组查询等构建 > 掌握主键ID的生成策略，多j记录、逻辑删除、乐观锁 > 了解MyBatisPlus的代码生成器
MybatisPlus框架入门级理解
qq_51580006的博客
01-16 1926
从条件构造器的学习中可以看出，虽然MybatisPlus提供了非常灵活的关于Where条件的SQL语句拼接方式，但是它是在业务逻辑层完成的，违背了企业开发的一些规范，如果不使用的话自己在xml文件中编写完整的SQL语句又会很麻烦。因此，我们可以利用MyBatisPlus的Wrapper来构建复杂的Where条件，然后自定义SQL语句中剩下的部分。我们需要想一种办法把mp构建好的条件往下传递给mapper层，在xml中最终实现SQL语句的组装。步骤1.基于Wrapper构建where条件@Test。
MybatisPlus入门（涉及大部分常用操作）
remakeprogramer的博客
11-27 1234
MybatisPlus 一、MybatisPlus概述 1、学习MybatisPlus前所需的知识 ​ Mybatis、Spring、SpringMVC 2、为什么要学习MybatisPlus Mybatis本身就是被用作简化我们CRUD过程的一个框架，而MybatisPlus是和Mybatis配合使用的，可以更加简化我们的CRUD过程，可以自动化完成CRUD。 官网原话：MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效
MyBatisPlus条件构造器 -Wrapper详解.ziw
05-07
MyBatisPlus条件构造器 -Wrapper详解（为知笔记版，可用网页打开），详解wrapper条件构造器的各种使用方法及其扩展类的使用方法。
Laravel框架查询构造器 CURD操作示例
12-20
本文实例讲述了Laravel框架查询构造器 CURD操作。分享给大家供大家参考，具体如下： 新增 //插入一条数据 public function insert(){ $rs = DB::table('student')->insert([ 'name' => 'Kit', 'age' => 12 ]); ...
MyBatisPlus条件构造器带条件更新update使用示例代码
04-23
MyBatisPlus条件构造器带条件更新update使用示例代码
动软代码生成器工具2023
02-20
动软代码生成器是一款完全自主知识产权研发的为软件项目开发设计的自动代码生成器，也是一个软件项目智能开发平台，它可以生成基于面向对象的思想和三层架构设计的代码，结合了软件开发中经典的思想和设计模式，融入...
详解MyBatis-Plus Wrapper条件构造器查询大全
08-24
MyBatis-Plus Wrapper 条件构造器查询大全是 MyBatis-Plus 框架中的一种强大查询功能，通过使用 Wrapper 条件构造器，可以实现复杂的查询操作。本文将通过示例代码，详细介绍 MyBatis-Plus Wrapper 条件构造器查询...
【仿真建模-anylogic】FlowchartPort原理解析
zhaoyaxuan001的博客
06-14 384
FlowchartPort是流图组件端口的基类，一般不会直接使用；如果需要自行封装组件库时会用到；FlowchartPort继承Port类，并定义了一系列抽象函数；用于输入端口判定此刻是否不能接收Agent。用于输出端口判定是否有Agent准备离开。判定端口是否发生错误。
（Javascript）AI数字人mp4转canvas播放并去除背景绿幕
lx_nhs的博客
06-12 555
去除前：去除后： 3、可能会出现的报错 （1）视频路径跨域问题：解决：vue开启代理
盲盒App开发时有哪些技术框架可以借鉴
最新发布
bytekj的博客
06-14 651
在开发盲盒App时，可以根据项目需求和团队技术栈选择合适的技术框架。前端可以选择微信小程序框架、React Native或Vue.js等；后端可以选择Node.js或Spring Boot等；数据库可以选择MySQL或MongoDB等。同时，还需要考虑缓存、消息队列、支付和物流接口等其他技术来完善应用的功能和性能。
SpringBoot之请求映射原理
好记性不如烂笔头
06-12 1271
我们发出的请求，SpringMVC是如何精准定位到那个Controller以及具体方法？其实这都是 HandlerMapping 发挥的作用，这篇博文我们以 RequestMappingHandlerMapping 为例并结合源码一步步进行分析。默认 HandlerMapping 主要定义在和其祖父类中获取所有类型是 Object 的 beans，并且 beanName 不以开头根据 beanName 获取 beanType如果 beanType 上存在注解则进行处理。
Mybatisplus 自定义sql 使用条件构造器
03-29
Mybatisplus 自定义sql 使用条件构造器可以在自定义 SQL 语句中使用 Mybatisplus 的条件构造器，方便快捷地构造查询条件。 使用步骤： 1. 在 Mapper 接口中定义自定义 SQL 语句的方法，方法返回值为 List 或者其他...

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值