芋道 Spring Boot MyBatis 入门（三）之 MyBatis-Plus

最新推荐文章于 2025-07-14 10:10:48 发布
原创 最新推荐文章于 2025-07-14 10:10:48 发布 · 553 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

本文详细介绍MyBatis-Plus的使用，包括依赖引入、配置、实体类定义、Mapper接口扩展及测试，展示其简化CRUD操作的强大功能。
部署运行你感兴趣的模型镜像

点击上方“芋道源码

做积极的人，而不是积极废人！

源码精品专栏

 

摘要: 原创出处 http://www.iocoder.cn/Spring-Boot/MyBatis/ 「芋道源码」欢迎转载，保留摘要，谢谢！

  • 1. 概述

  • 2. MyBatis + XML

    • 2.1 引入依赖

    • 2.2 Application

    • 2.3 应用配置文件

    • 2.4 MyBatis 配置文件

    • 2.5 UserDO

    • 2.6 UserMapper

    • 2.7 简单测试

  • 3. MyBatis + 注解

    • 3.1 差异部分

    • 3.2 UserMapper

    • 3.3 简单测试

  • 4. MyBatis-Plus

    • 4.1 引入依赖

    • 4.2 Application

    • 4.3 应用配置文件

    • 4.4 UserDO

    • 4.5 UserMapper

    • 4.6 简单测试

  • 5. tkmybatis

    • 5.1 引入依赖

    • 5.2 Application

    • 5.3 应用配置文件

    • 5.4 MyBatis 配置文件

    • 5.5 UserDO

    • 5.6 UserMapper

    • 5.7 简单测试

  • 666. 彩蛋

4. MyBatis-Plus

关于 MyBatis-Plus 的介绍，直接到 https://mybatis.plus/ 官网，艿艿就不多哔哔，嘿嘿。

示例代码对应仓库：mybatis-plus 。

本小节，我们会使用 mybatis-plus-boot-starter 自动化配置 MyBatis-Plus 的配置。同时，演示如何使用 MyBatis-Plus 实现我们在 「2. MyBatis + XML」 演示的各种 CRUD 的操作。

4.1 引入依赖

在 pom.xml 文件中，引入相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>lab-12-mybatis-plus</artifactId>

    <dependencies>
        <!-- 实现对数据库连接池的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency> <!-- 本示例，我们使用 MySQL -->
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.48</version>
        </dependency>

        <!-- 实现对 MyBatis Plus 的自动化配置 -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.2.0</version>
        </dependency>

        <!-- 方便等会写单元测试 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>

</project>

  • 相比来说，将 mybatis-spring-boot-starter 替换成 mybatis-plus-boot-starter 。

4.2 Application

创建 Application.java 类，配置 @MapperScan 注解，扫描对应 Mapper 接口所在的包路径。代码如下：

// Application.java

@SpringBootApplication
@MapperScan(basePackages = "cn.iocoder.springboot.lab12.mybatis.mapper")
public class Application {
}

  • 和 「2.2 Application」 一致。

4.3 应用配置文件

在 resources 目录下，创建 application.yaml 配置文件。配置如下：

spring:
  # datasource 数据源配置内容
  datasource:
    url: jdbc:mysql://47.112.193.81:3306/testb5f4?useSSL=false&useUnicode=true&characterEncoding=UTF-8
    driver-class-name: com.mysql.jdbc.Driver
    username: testb5f4
    password: F4df4db0ed86@11

# mybatis-plus 配置内容
mybatis-plus:
  configuration:
    map-underscore-to-camel-case: true # 虽然默认为 true ，但是还是显示去指定下。
  global-config:
    db-config:
      id-type: auto # ID 主键自增
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
  mapper-locations: classpath*:mapper/*.xml
  type-aliases-package: cn.iocoder.springboot.lab12.mybatis.dataobject

# logging
logging:
  level:
    # dao 开启 debug 模式 mybatis 输入 sql
    cn:
      iocoder:
        springboot:
          lab12:
            mybatis:
              mapper: debug

  • 将 mybatis 替换成 mybatis-plus 配置项目。实际上，如果老项目在用 mybatis-spring-boot-starter 的话，直接将 mybatis 修改成 mybatis-plus 即可。

  • 相比 mybatis 配置项来说，mybatis-plus 增加了更多配置项，也因此我们无需在配置 `mybatis-config.xml` 配置文件。

  • 更多的 MyBatis-Plus 配置项，可以看看 MyBatis-Plus 使用配置 。

  • 配置 logging 的原因是，方便我们看到 MyBatis-Plus 自动生成的 SQL 。生产环境下，记得关闭噢。

4.4 UserDO

在 cn.iocoder.springboot.lab12.mybatis.dataobject 包路径下，创建 UserDO.java 类，用户 DO 。代码如下：

// UserDO.java
@TableName(value = "users")
public class UserDO {

    /**
     * 用户编号
     */
    private Integer id;
    /**
     * 账号
     */
    private String username;
    /**
     * 密码（明文）
     *
     * ps：生产环境下，千万不要明文噢
     */
    private String password;
    /**
     * 创建时间
     */
    private Date createTime;
    /**
     * 是否删除
     */
    @TableLogic
    private Integer deleted;

    // ... 省略 setting/getting 方法

}

  • 相比 「2.5 UserDO」 来说，主要有两点差别。

  • 增加了 `@TableName` 注解，设置了 UserDO 对应的表名是 users 。毕竟，我们要使用 MyBatis-Plus 给咱自动生成 CRUD 操作。

  • 增加了 deleted 字段，并添加了 `@TableLogic` 注解，设置该字段为逻辑删除的标记。

    • 在 `application.yaml` 配置文件中，我们配置了删除（`logic-delete-value = 1`）和未删除（`logic-not-delete-value = 0`）。当然，也可以通过注解的 `value` 和 `delval` 来定义未删除和删除。

    • 具体关于 MyBatis-Plus 的逻辑删除功能，看下 逻辑删除 部分的文档。

对应的创建表的 SQL 如下：

CREATE TABLE `users` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户编号',
  `username` varchar(64) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '账号',
  `password` varchar(32) COLLATE utf8mb4_bin DEFAULT NULL COMMENT '密码',
  `create_time` datetime DEFAULT NULL COMMENT '创建时间',
  `deleted` bit(1) DEFAULT NULL COMMENT '是否删除。0-未删除；1-删除',
  PRIMARY KEY (`id`),
  UNIQUE KEY `idx_username` (`username`)
) ENGINE=InnoDB AUTO_INCREMENT=7 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

4.5 UserMapper

在 cn.iocoder.springboot.lab12.mybatis.mapper 包路径下，创建 UserMapper 接口。代码如下：

// UserMapper.java

@Repository
public interface UserMapper extends BaseMapper<UserDO> {

    default UserDO selectByUsername(@Param("username") String username) {
        return selectOne(new QueryWrapper<UserDO>().eq("username", username));
    }

    List<UserDO> selectByIds(@Param("ids") Collection<Integer> ids);

    default IPage<UserDO> selectPageByCreateTime(IPage<UserDO> page, @Param("createTime") Date createTime) {
        return selectPage(page,
                new QueryWrapper<UserDO>().gt("create_time", createTime));
    }

}

  • 还是老样子，我们来比较下 「2.6 UserMapper」 接口。

  • 继承了 com.baomidou.mybatisplus.core.mapper.BaseMapper 接口，这样常规的 CRUD 操作，MyBatis-Plus 就可以替我们自动生成。一般来说，开发 CRUD 业务的时候，最枯燥的就是要写 CRUD 的常用 SQL ，完全跟不上艿艿的思绪哈。

    • 因为继承了 BaseMapper 接口，所以我们删除了 `#insert(UserDO user)`、`#updateById(UserDO user)`、`#deleteById(@Param("id") Integer id)`、`#selectById(@Param("id") Integer id)` 四个 CRUD 方法。

    • 更多 BaseMapper 已经提供好的接口方法，可以看看 《MyBatis-Plus 文档 —— CRUD 接口》 。

  • 对于 #selectByUsername(@Param("username") String username) 方法，我们使用了 com.baomidou.mybatisplus.core.conditions.query.QueryWrapper 构造相对灵活的条件，这样一些动态 SQL 我们就无需在 XML 中编写。

    • 更多 QueryWrapper 已经提供好的拼接方法，可以看看 《MyBatis-Plus 文档 —— 条件构造器》 。

    • 建议 1 ：不要在 Service 中，使用 QueryWrapper 拼接动态条件。因为 BaseMapper 提供了 `#selectList(Wrapper

       queryWrapper)` 等方法，促使我们能够在 Service 层的逻辑中，使用 QueryWrapper 拼接动态条件，这样会导致逻辑里遍布了各种查询，使我们无法对实际有哪些查询条件做统一的管理。碰到这种情况，建议封装到对应的 Mapper 中，这样会更加简洁干净可管理。

    • 建议 2 ：因为 QueryWrapper 暂时不支持一些类似 `

      ` 等 MyBatis 的 OGNL 表达式，所以艿艿在 onemall 中，通过继承 QueryWrapper 类，封装了 QueryWrapperX 类。

  • 对于 #selectByIds(@Param("ids") 方法，实际也可以使用 MyBatis-Plus 的 QueryWrapper 很方便的实现，这里仅仅是为了演示在 MyBatis-Plus 混合使用 XML 。

  • 对于 #selectPageByCreateTime(IPage page, @Param("createTime") Date createTime) 方法，是我们额外添加的，用于演示 MyBatis-Plus 提供的分页插件。

    • 更多 IPage 的内容，可以看看 《MyBatis-Plus 文档 —— 分页插件》 。

在 resources/mapper 路径下，创建 UserMapper.xml 配置文件。代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="cn.iocoder.springboot.lab12.mybatis.mapper.UserMapper">

    <sql id="FIELDS">
        id, username, password, create_time
    </sql>

    <select id="selectByIds" resultType="UserDO">
        SELECT
            <include refid="FIELDS" />
        FROM users
        WHERE id IN
            <foreach item="id" collection="ids" separator="," open="(" close=")" index="">
                #{id}
            </foreach>
    </select>

</mapper>

  • 是不是一下子，瘦了！

4.6 简单测试

创建 UserMapperTest 测试类，我们来测试一下简单的 UserMapper 的每个操作。代码如下：

// UserMapperTest.java

@RunWith(SpringRunner.class)
@SpringBootTest(classes = Application.class)
public class UserMapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testInsert() {
        UserDO user = new UserDO().setUsername(UUID.randomUUID().toString())
                .setPassword("nicai").setCreateTime(new Date())
                .setDeleted(0); // 一般情况下，是否删除，可以全局枚举下。
        userMapper.insert(user);
    }

    @Test
    public void testUpdateById() {
        UserDO updateUser = new UserDO().setId(1)
                .setPassword("wobucai");
        userMapper.updateById(updateUser);
    }

    @Test
    public void testDeleteById() {
        userMapper.deleteById(2);
    }

    @Test
    public void testSelectById() {
        userMapper.selectById(1);
    }

    @Test
    public void testSelectByUsername() {
        userMapper.selectByUsername("yunai");
    }

    @Test
    public void testSelectByIds() {
        List<UserDO> users = userMapper.selectByIds(Arrays.asList(1, 3));
        System.out.println("users：" + users.size());
    }

    @Test
    public void testSelectPageByCreateTime() {
        IPage<UserDO> page = new Page<>(1, 10);
        Date createTime = new Date(2018 - 1990, Calendar.FEBRUARY, 24); // 临时 Demo ，实际不建议这么写
        page = userMapper.selectPageByCreateTime(page, createTime);
        System.out.println("users：" + page.getRecords().size());
    }

}

  • 和 「2.7 简单测试」 差不多，只是多了一个分页的单元测试方法。

总的来说，MyBatis-Plus 给我们日常开发，还是提供了蛮多便利性的，胖友不烦尝试下。

欢迎加入我的知识星球，一起探讨架构，交流源码。加入方式，长按下方二维码噢：

640?wx_fmt=jpeg

已在知识星球更新源码解析如下：

如果你喜欢这篇文章，喜欢，转发。

生活很美好，明天见(｡･ω･｡)ﾉ♡

您可能感兴趣的与本文相关的镜像

Seed-Coder-8B-Base

Seed-Coder-8B-Base

文本生成
Seed-Coder

Seed-Coder是一个功能强大、透明、参数高效的 8B 级开源代码模型系列，包括基础变体、指导变体和推理变体，由字节团队开源

028-若依pro(ruoyi-vue-pro)MyBatis 数据库
RichardHLee的博客
09-18 2035
继承 MyBatis Plus 的条件构造器，拓展了 LambdaQueryWrapperX (opens new window)和 QueryWrapperX (opens new window)类，主要是增加 xxxIfPresent 方法，用于判断值不存在的时候，不要拼接到条件中。另外，如果你后续要拓展自定义的 TypeHandler 实现，可以添加到 cn.iocoder.yudao.framework.mybatis.core.type (opens new window)包下。
Mybatis-Plus的条件构造器（Wrapper）
qq_43223307的博客
11-24 935
一.介绍 在mybatis-plus中提了构造条件的类Wrapper,它可以根据自己的意图定义我们需要的条件。Wrapper是一个抽象类，一般情况下我们用它的子类QueryWrapper来实现自定义条件查询。 二.常用方法 1.selectOne方法//查询姓名为刘辉军并且性别为男的员工 @Test public void testSelectOne(){ QueryWrapper<Employee> queryWrapper=new QueryWrapper<>(); qu
用Spring Boot逻辑删除（isDelete）优雅守护你的数据资产：告别物理删除的烦恼
最新发布
RoseJunjun666的博客
07-14 1100
/ 查询时自动忽略已删除数据// 手动查询已删除数据（突破@Where限制）逻辑删除不是简单的技术选型，而是数据治理理念的升级。在Spring Boot生态中，无论是MyBatis-Plus的还是Spring Data JPA的@Where注解，都能以极低成本实现这一能力。数据最有价值的时刻，往往是在你以为不再需要它之后—— 某个深夜恢复数据的程序员Spring Data JPA官方文档 - 实体状态管理MyBatis-Plus逻辑删除配置指南👉如有疑问欢迎评论区交流~
芋道 Spring Boot MyBatis 入门（一）之 MyBatis + XML
芋艿V
11-04 508
点击上方“芋道源码”，选择“设为星标”做积极的人，而不是积极废人！源码精品专栏原创 | Java 2019 超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络...
spring学习（六）——1.3 initializeBean：InitializingBean 和 init-method
大风的博客
03-23 985
参考文章： http://www.iocoder.cn/ bean实例化过程中在激活Aware，调用后置处理之后最后一步是InitializingBean（初始化bean） 和 init-method（调用bean的初始化方法） InitializingBean bean 提供了定义初始化方法的方式，它仅包含了一个方法：#afterPropertiesSet() 方法在Ab...
芋道源码
李昊的博客
04-06 2260
芋道源码 来源链接：http://www.iocoder.cn/
看了我的mybatis-plus用法，同事也开始悄悄模仿了
芋艿V
08-05 280
点击上方“芋道源码”，选择“设为星标”管她前浪，还是后浪？能浪的浪，才是好浪！每天 10:33更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2021超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络应用框架 Netty 源码解析消息中间件 RocketMQ 源码解析数据库中间件 Sharding-JDBC 和 MyCAT ...
看完这篇，不信你还能不会用 MyBatis-Plus
芋艿V
06-22 352
点击上方“芋道源码”，选择“设为星标”管她前浪，还是后浪？能浪的浪，才是好浪！每天 10:33更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2021超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络应用框架 Netty 源码解析消息中间件 RocketMQ 源码解析数据库中间件 Sharding-JDBC 和 MyCAT ...
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.1.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.0.2.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
mybatis-plus-spring-boot3-starter-3.5.9.jar
12-06
mybatisplus，MyBatis-Plus 是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。... <artifactId>mybatis-plus-spring-boot3-starter <version>3.5.9 </dependency>
Mybatis Plus分页实现逻辑整理（结合芋道整合进行解析）
IT小辉同学
11-21 4877
我希望如春天般的你，身着白色的婚纱，向我奔赴而来，我愿意用全世界最温情的目光，朝着你的方向望去——姗姗来迟。
还再手写逻辑删除？一个注解 @TableLogic 轻松搞定！
犬小哈
01-20 619
来源：https://blog.youkuaiyun.com/qq_43842093???? 欢迎加入小哈的星球，你将获得:专属的项目实战 /1v1 提问/Java 学习路线 /学习打卡/每月赠书/社群讨论新项目:《从零手撸：仿小红书（微服务架构）》正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...,点击查看项目介绍；《从...
Mybatis Plus 是如何实现动态 SQL 语句的？原理你懂吗？
芋艿V
12-21 487
点击上方“芋道源码”，选择“设为星标”管她前浪，还是后浪？能浪的浪，才是好浪！每天 10:33更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2021超神之路，很肝~...
如何让mybatis-plus的逻辑删除注解@TableLogic临时失效
weixin_49514605的博客
12-21 1180
mybatis-plus的逻辑删除注解@TableLogic临时失效
Springboot中Mybatis属性映射--开启驼峰命名
29岁的裴野永远爱你
04-29 4128
mybatis默认是属性名和数据库字段名一一对应的，即 数据库表列：user_name 实体类属性：user_name 但是java中一般使用驼峰命名 数据库表列：user_name 实体类属性：userName 在Springboot中，可以通过设置map-underscore-to-camel-case属性为true来开启驼峰功能。 application.yml中： mybatis: c...
Spring Boot整合Mybatis-Plus源码示例解析
资源摘要信息: "Spring Boot整合MyBatis-Plus项目源码示例" Spring Boot整合MyBatis-Plus是一个流行的技术组合，用于构建高效、稳定的Java Web应用程序。Spring Boot提供了一种简便的方式来构建独立的、生产级别的...
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值