Mybatis Plus与SpringBoot的集成

已于 2025-04-10 18:48:19 修改
阅读量746 收藏 9
点赞数 16
分类专栏： SpringBoot 文章标签： mybatis spring boot 后端
于 2025-04-09 19:35:50 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/pageniao/article/details/147100280
版权

Mybatis Plus与SpringBoot的集成

1.引入Maven 依赖

提前创建好一个SpringBoot项目，然后在项目中引入MyBatis Plus依赖

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

完整的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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.0.9</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.atguigu</groupId>
    <artifactId>hello-mp</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>hello-mp</name>
    <description>hello-mp</description>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </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.3.2</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2.配置application.yml文件

配置数据库相关内容如下

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: <password>
    url: jdbc:mysql://host:post/database_name?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2b8

3.创建实体类

创建与user表相对应的实体类，如下

@Data
@TableName("user")
public class User {

    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @TableField("name")
    private String name;

    @TableField("age")
    private Integer age;

    @TableField("email")
    private String email;
}

知识点：

实体类中的三个注解的含义如下

  • @TableName：表名注解，用于标识实体类所对应的表

    • value：用于声明表名

  • @TableId：主键注解，用于标识主键字段

    • value：用于声明主键的字段名
    • type：用于声明主键的生成策略，常用的策略有AUTO、ASSIGN_UUID、INPUT等等

  • @TableField：普通字段注解，用于标识属性所对应的表字段

    • value：用于声明普通字段的字段名

4.分页插件

Mybatis-Plus提供了一个分页插件，使用它可以十分方便的完成分页查询。

  • 配置分页插件
@Configuration
public class MPConfiguration {

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

分页插件使用说明

  • 构造分页对象

    分页对象包含了分页的各项信息，其核心属性如下：

    属性名类型默认值描述
    recordsListemptyList查询数据列表
    totalLong0查询列表总记录数
    sizeLong10每页显示条数，默认10
    currentLong1当前页

    分页对象既作为分页查询的参数，也作为分页查询的返回结果，当作为查询参数时，通常只需提供current和size属性，如下

    IPage<T> page = new Page<>(current, size);

    注：IPage为分页接口，Page为IPage接口的一个实现类。

  • 分页查询

    Mybatis Plus的BaseMapper和ServiceImpl均提供了常用的分页查询的方法，例如：

    • BaseMapper的分页查询：

      IPage<T> selectPage(IPage<T> page,Wrapper<T> queryWrapper);

    • ServiceImpl的分页查询：

      // 无条件分页查询
IPage<T> page(IPage<T> page);
// 条件分页查询
IPage<T> page(IPage<T> page, Wrapper<T> queryWrapper);

    • 自定义Mapper

      对于自定义SQL，也可以十分方便的完成分页查询，如下

      Mapper接口：

      IPage<UserVo> selectPageVo(IPage<?> page, Integer state);

      Mapper.xml：

      <select id="selectPageVo" resultType="xxx.xxx.xxx.UserVo">
    SELECT id,name FROM user WHERE state=#{state}
</select>

      注意：Mapper.xml中的SQL只需实现查询list的逻辑即可，无需关注分页的逻辑。

      5.逻辑删除功能

由于数据库中所有表均采用逻辑删除策略，所以查询数据时均需要增加过滤条件is_deleted=0。
上述操作虽不难实现，但是每个查询接口都要考虑到，也显得有些繁琐。为简化上述操作，可以使用Mybatis-Plus提供的逻辑删除功能，它可以自动为查询操作增加is_deleted=0过滤条件，并将删除操作转为更新语句。

  • 步骤一：在application.yml中增加如下内容

    mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag # 全局逻辑删除的实体字段名(配置后可以忽略不配置步骤二)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

  • 步骤二：在实体类中的删除标识字段上增加@TableLogic注解

    @Data
public class BaseEntity {

    @Schema(description = "主键")
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @Schema(description = "创建时间")
    @JsonIgnore
    private Date createTime;

    @Schema(description = "更新时间")
    @JsonIgnore
    private Date updateTime;

    @Schema(description = "逻辑删除")
    @JsonIgnore
    @TableLogic
    @TableField("is_deleted")
    private Byte isDeleted;

}

    注意：

    逻辑删除功能只对Mybatis-Plus自动注入的sql起效，也就是说，对于手动在Mapper.xml文件配置的sql不会生效，需要单独考虑。

6.忽略特定字段

通常情况下接口响应的Json对象中并不需要create_time、update_time、is_deleted等字段，这时只需在实体类中的相应字段添加@JsonIgnore注解，该字段就会在序列化时被忽略。

具体配置如下

@Data
public class BaseEntity {

    @Schema(description = "主键")
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @Schema(description = "创建时间")
    @JsonIgnore
    @TableField(value = "create_time")
    private Date createTime;

    @Schema(description = "更新时间")
    @JsonIgnore
    @TableField(value = "update_time")
    private Date updateTime;

    @Schema(description = "逻辑删除")
    @JsonIgnore
    @TableField("is_deleted")
    private Byte isDeleted;

}

7.自动填充

保存或更新数据时，前端通常不会传入isDeleted、createTime、updateTime这三个字段，因此我们需要手动赋值。但是数据库中几乎每张表都有上述字段，所以手动去赋值就显得有些繁琐。为简化上述操作，我们可采取以下措施。

  • is_deleted字段：可将数据库中该字段的默认值设置为0。

  • create_time和update_time：可使用mybatis-plus的自动填充功能，所谓自动填充，就是通过统一配置，在插入或更新数据时，自动为某些字段赋值，具体配置如下，详细信息可参考官方文档。

    • 为相关字段配置触发填充的时机，例如create_time需要在插入数据时填充，而update_time需要在更新数据时填充。具体配置如下，观察@TableField注解中的fill属性。

      @Data
public class BaseEntity {

    @Schema(description = "主键")
    @TableId(value = "id", type = IdType.AUTO)
    private Long id;

    @Schema(description = "创建时间")
    @JsonIgnore
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private Date createTime;

    @Schema(description = "更新时间")
    @JsonIgnore
    @TableField(value = "update_time", fill = FieldFill.UPDATE)
    private Date updateTime;

    @Schema(description = "逻辑删除")
    @JsonIgnore
    @TableLogic
    @TableField("is_deleted")
    private Byte isDeleted;

}

    • 配置自动填充的内容，具体配置如下

@Component
public class MybatisMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "updateTime", Date.class, new Date());
    }
}
Springboot里集成Mybatis-plus、ClickHouse
Java 技术专栏，从入门到精通，熟悉企业级开发
08-25 4万+
上一章节讲解在阿里云ECS centos服务器上安装ClickHouse。这一章节我们在Springboot里集成Mybatis-plus、ClickHouse。环境：JDK8 + Springboot 2.6.13 + ClickHouse。
Spring Boot 集成MyBatis-Plus
最新发布
web15870359587的博客
12-05 2680
增加集成相关的配置和依赖后，我们又创建了一个简单的接口，用于验证本次集成是否成功。其中谈到了SSM项目中基本的项目结构，相关代码都是从生产代码中抽象出来的，具有很强的参考意义。在古早的应用开发中，需要开发人员写许多的DAL（数据访问层）代码，需要自己管理数据库的连接与关闭，还需要自己从ResultSet中获取数据，然后再将其组装为对象。并且为了保持依赖的松散，控制器是不直接依赖于具体类的，而是依赖于接口。被该注解修饰的类，setters方法返回的该类的实例（即this），而不是void。
springboot：整合mybatis-plus
拒绝熬夜啊的博客
11-03 1817
springboot：整合mybatis-plus
SpringBoot 整合 MyBatisPlus
一个95后开发者，热爱编程，喜欢玩游戏. 希望可以结识更多的小伙伴...
06-30 9273
.
Spring Boot 和 MyBatis-Plus 的简单整合
D_J_Dragon的博客
08-13 3944
打开浏览器访问http://localhost:8080/UserController/insert，可以看到页面上打印“数据插入成功”，刚好和UserController类中的代码功能一致，同时控制台也打印出了insert语句，说明调用成功。MyBatis是一个强大且稳定的持久层解决方案，也是众多java程序员入门的首选，而MyBatis-Plus是MyBatis 的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。需要配置好自己的数据库连接，用户名，密码。
基于Mybatis-Plus的SpringBoot集成与优化设计源码演示
10-01
该项目深入展示了如何通过集成Mybatis-Plus与SpringBoot进行高效的项目开发，通过源码演示来阐述集成与优化设计的概念和实践。Mybatis-Plus作为Mybatis的增强工具，在SpringBoot环境下的集成利用，可以大幅提高开发...
mybatis plus+springboot反向生成代码
09-05
本篇文章将详细讲解如何利用Mybatis Plus与SpringBoot进行反向生成代码，以及这一过程中的关键知识点。 首先，Mybatis Plus（简称MBP）是Mybatis的一个扩展，它简化了Mybatis的日常开发工作，提供了丰富的CRUD操作...
Mybatis Plus与SpringBoot的集成与优势解析
### Mybatis Plus 基于 SpringBoot 源码...通过Mybatis Plus，开发者可以更加高效地进行数据访问层（DAO）的开发，尤其在使用SpringBoot时，Mybatis Plus的集成更为简洁方便，极大地提高了开发效率，并降低了学习成本。
springboot集成mybatis-plus遇到的问题及解决方法
08-25
public class MybatisPlusConfig { @Autowired private DataSource dataSource; @Autowired private MybatisProperties properties; @Autowired private ResourceLoader resourceLoader = new ...
springBoot整合mybatis plus
02-22
springBoot整合mybatis plus
springBoot整合MybatisPlus
weixin_49372978的博客
08-07 352
springBoot整合mybatisplus
springboot集成MyBatis-Plus
Flying_Fish_roe的博客
09-22 2553
MyBatis-Plus 的集成和使用在 Spring Boot 项目中非常简单。通过 `mybatis-plus-boot-starter`，开发者可以轻松构建基础的 CRUD 操作，并利用 MyBatis-Plus 提供的查询构造器、分页插件等功能，快速处理复杂的业务需求。 - **基础 CRUD**：通过继承 `BaseMapper`，可以直接调用常用的数据库操作方法。 - **复杂查询**：利用 `QueryWrapper` 和 `UpdateWrapper`，实现灵活的条件查询和更新。 - *
SpringBoot整合MybatisPlus（详细）
热门推荐
m0_68681879的博客
10-20 1万+
SpringBoot整合MyBatis-Plus基础（详细）
Springboot整合mybatis-plus
分享日常bug
10-30 1158
提示：以下是本篇文章正文内容，下面案例可供参考提示：这里对文章进行总结：例如：以上就是今天要讲的内容，本文仅仅简单介绍了pandas的使用，而pandas提供了大量能使我们快速便捷地处理数据的函数和方法。
MyBatisPlus之SpringBoot集成
码说芯语的博客
04-24 678
1、需要引入的依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org
mybatis-plus整合spring boot极速入门
烛照@123的博客
03-09 1750
学会使用mybatis-plus，简化开发。
SpringBoot整合Mybatis-Plus
qq_42582489的博客
08-01 1400
SpringBoot整合Mybatis-Plus 文章目录SpringBoot整合Mybatis-Plus前言新建项目配置连接快速入门常用注解@TableName@TableId@TableField常用方法查询方法增加方法更新方法删除方法分页查询多数据源配置参考文章 前言 MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。 正如官方文档中所提到的，Mybatis-Plus拥有很多优秀的特性： 无侵入：只做增强
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值