【mybatis-plus】---- Spring Boot 3 整合 MyBatis-Plus 完整示例

本文提供Spring Boot 3整合MyBatis-Plus的完整示例，包含以下核心内容：1）添加Maven依赖（Spring Boot 3.1.3+MyBatis-Plus 3.5.3.1）；2）配置application.yml文件（数据源、MyBatis-Plus参数）；3）定义基础PO类（含公共字段和逻辑删除）；4）创建PhoneAreaCodePO实体类继承基础PO，实现规范的CRUD

qq_24923619

529人浏览 · 2025-08-24 10:34:22

qq_24923619 · 2025-08-24 10:34:22 发布

文章目录

Spring Boot 3 整合 MyBatis-Plus 完整示例

下面我将按照你的需求，创建一个完整的 Spring Boot 3 整合 MyBatis-Plus 的示例，实现规范的 CRUD 操作。

1. 首先添加 Maven 依赖 (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.1.3</version>
        <relativePath/>
    </parent>
    
    <groupId>com.example</groupId>
    <artifactId>phone-area-code</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>phone-area-code</name>
    
    <properties>
        <java.version>17</java.version>
        <mybatis-plus.version>3.5.3.1</mybatis-plus.version>
    </properties>
    
    <dependencies>
        <!-- Spring Boot Starter Web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <!-- MyBatis-Plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis-plus.version}</version>
        </dependency>
        
        <!-- MySQL Driver -->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        
        <!-- Lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        
        <!-- Spring Boot Starter Test -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2. 配置文件 (application.yml)

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database_name?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: password
    driver-class-name: com.mysql.cj.jdbc.Driver

mybatis-plus:
  mapper-locations: classpath*:mapper/**/*.xml
  global-config:
    db-config:
      logic-delete-field: idDeleted  # 全局逻辑删除的实体字段名
      logic-delete-value: 1          # 逻辑已删除值(默认为1)
      logic-not-delete-value: 0      # 逻辑未删除值(默认为0)
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl  # 打印SQL日志
    map-underscore-to-camel-case: true  # 开启驼峰命名转换

3. 基础 PO 类

package com.example.phoneareacode.po;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableLogic;
import lombok.Data;

import java.time.LocalDateTime;

/**
 * 基础PO类，包含公共字段
 */
@Data
public class BasePO {

    /**
     * 状态：0-禁用 1-启用
     */
    private Integer status;

    /**
     * 备注
     */
    private String remark;

    /**
     * 创建时间
     */
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createdTime;

    /**
     * 更新时间
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updatedTime;

    /**
     * 创建人
     */
    @TableField(fill = FieldFill.INSERT)
    private String createdBy;

    /**
     * 更新人
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private String updatedBy;

    /**
     * 是否删除：0-未删除 1-已删除
     */
    @TableLogic
    private Integer idDeleted;
}

4. 实体类 PhoneAreaCodePO

package com.example.phoneareacode.po;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.EqualsAndHashCode;

/**
 * 全球手机区号实体类
 */
@Data
@EqualsAndHashCode(callSuper = true)
@TableName("app_phone_area_code")
public class PhoneAreaCodePO extends BasePO {

    /**
     * 主键ID
     */
    @TableId(type = IdType.AUTO)
    private Integer id;

    /**
     * 国家/地区名称
     */
    private String countryName;

    /**
     * 手机区号
     */
    private String areaCode;

    /**
     * 排序字段，值越大越靠前
     */
    private Integer sortOrder;
}

5. MyBatis-Plus 自动填充处理器

package com.example.phoneareacode.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 * MyBatis-Plus 自动填充处理器
 */
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    /**
     * 插入时的填充策略
     */
    @Override
    public void insertFill(MetaObject metaObject) {
        // 自动填充创建时间和更新时间
        this.strictInsertFill(metaObject, "createdTime", LocalDateTime.class, LocalDateTime.now());
        this.strictInsertFill(metaObject, "updatedTime", LocalDateTime.class, LocalDateTime.now());
        
        // 默认状态为启用
        this.strictInsertFill(metaObject, "status", Integer.class, 1);
    }

    /**
     * 更新时的填充策略
     */
    @Override
    public void updateFill(MetaObject metaObject) {
        // 自动填充更新时间
        this.strictUpdateFill(metaObject, "updatedTime", LocalDateTime.class, LocalDateTime.now());
    }
}

6. 通用分页请求对象

package com.example.phoneareacode.dto;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

/**
 * 通用分页请求对象
 */
@Data
@Schema(description = "分页请求参数")
public class PageRequest {

    @Schema(description = "页码，从1开始", example = "1")
    private Integer pageNum = 1;

    @Schema(description = "每页条数", example = "10")
    private Integer pageSize = 10;
}

7. 通用响应对象

package com.example.phoneareacode.common;

import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

/**
 * 通用API响应对象
 */
@Data
@Schema(description = "API响应结果")
public class ApiResponse<T> {

    @Schema(description = "状态码：200表示成功，其他表示失败", example = "200")
    private int code;

    @Schema(description = "响应消息", example = "操作成功")
    private String message;

    @Schema(description = "响应数据")
    private T data;

    /**
     * 成功响应
     */
    public static <T> ApiResponse<T> success(T data) {
        ApiResponse<T> response = new ApiResponse<>();
        response.setCode(200);
        response.setMessage("操作成功");
        response.setData(data);
        return response;
    }

    /**
     * 成功响应（无数据）
     */
    public static <T> ApiResponse<T> success() {
        return success(null);
    }

    /**
     * 失败响应
     */
    public static <T> ApiResponse<T> fail(int code, String message) {
        ApiResponse<T> response = new ApiResponse<>();
        response.setCode(code);
        response.setMessage(message);
        response.setData(null);
        return response;
    }

    /**
     * 失败响应（默认错误码）
     */
    public static <T> ApiResponse<T> fail(String message) {
        return fail(500, message);
    }
}

8. Mapper 接口

package com.example.phoneareacode.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.example.phoneareacode.po.PhoneAreaCodePO;
import org.apache.ibatis.annotations.Mapper;

/**
 * 手机区号Mapper接口
 */
@Mapper
public interface PhoneAreaCodeMapper extends BaseMapper<PhoneAreaCodePO> {
}

9. Service 接口及实现

package com.example.phoneareacode.service;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.service.IService;
import com.example.phoneareacode.dto.PageRequest;
import com.example.phoneareacode.po.PhoneAreaCodePO;

/**
 * 手机区号Service接口
 */
public interface PhoneAreaCodeService extends IService<PhoneAreaCodePO> {

    /**
     * 分页查询手机区号列表
     */
    IPage<PhoneAreaCodePO> getPageList(PageRequest pageRequest);

    /**
     * 根据ID查询
     */
    PhoneAreaCodePO getById(Integer id);

    /**
     * 新增
     */
    boolean save(PhoneAreaCodePO phoneAreaCodePO);

    /**
     * 更新
     */
    boolean update(PhoneAreaCodePO phoneAreaCodePO);

    /**
     * 删除（逻辑删除）
     */
    boolean removeById(Integer id);
}

10. Controller 层

package com.example.phoneareacode.controller;

import com.baomidou.mybatisplus.core.metadata.IPage;
import com.example.phoneareacode.common.ApiResponse;
import com.example.phoneareacode.dto.PageRequest;
import com.example.phoneareacode.po.PhoneAreaCodePO;
import com.example.phoneareacode.service.PhoneAreaCodeService;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * 手机区号Controller
 * 统一使用POST请求
 */
@RestController
@RequestMapping("/api/phone-area-code")
@Tag(name = "手机区号管理", description = "手机区号CRUD操作")
public class PhoneAreaCodeController {

    @Autowired
    private PhoneAreaCodeService phoneAreaCodeService;

    /**
     * 分页查询列表
     */
    @PostMapping("/page")
    @Operation(summary = "分页查询手机区号列表")
    public ApiResponse<IPage<PhoneAreaCodePO>> getPageList(@RequestBody PageRequest pageRequest) {
        return ApiResponse.success(phoneAreaCodeService.getPageList(pageRequest));
    }

    /**
     * 根据ID查询
     */
    @PostMapping("/getById")
    @Operation(summary = "根据ID查询手机区号")
    public ApiResponse<PhoneAreaCodePO> getById(@RequestBody Integer id) {
        return ApiResponse.success(phoneAreaCodeService.getById(id));
    }

    /**
     * 新增
     */
    @PostMapping("/save")
    @Operation(summary = "新增手机区号")
    public ApiResponse<Boolean> save(@RequestBody PhoneAreaCodePO phoneAreaCodePO) {
        return ApiResponse.success(phoneAreaCodeService.save(phoneAreaCodePO));
    }

    /**
     * 更新
     */
    @PostMapping("/update")
    @Operation(summary = "更新手机区号")
    public ApiResponse<Boolean> update(@RequestBody PhoneAreaCodePO phoneAreaCodePO) {
        return ApiResponse.success(phoneAreaCodeService.update(phoneAreaCodePO));
    }

    /**
     * 删除
     */
    @PostMapping("/delete")
    @Operation(summary = "删除手机区号")
    public ApiResponse<Boolean> delete(@RequestBody Integer id) {
        return ApiResponse.success(phoneAreaCodeService.removeById(id));
    }
}

11. MyBatis-Plus 配置类（分页插件）

package com.example.phoneareacode.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * MyBatis-Plus配置类
 */
@Configuration
public class MyBatisPlusConfig {

    /**
     * 配置分页插件
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        // 添加分页插件
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

12. 启动类

package com.example.phoneareacode;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.example.phoneareacode.mapper") // 扫描Mapper接口
public class PhoneAreaCodeApplication {

    public static void main(String[] args) {
        SpringApplication.run(PhoneAreaCodeApplication.class, args);
    }
}

项目结构说明

整个项目按照标准的分层架构设计：

PO层：存放实体类，继承基础BasePO，包含公共字段
Mapper层：数据访问层，继承MyBatis-Plus的BaseMapper
Service层：业务逻辑层，实现具体的业务逻辑
Controller层：控制层，只负责接收请求和返回响应，不包含业务逻辑
Common：存放通用响应对象等公共类
Config：存放配置类
DTO：存放数据传输对象，如分页请求对象

为了测试上述接口，我们可以使用Postman或编写单元测试来验证接口的正确性。下面提供两种测试方案：

一、使用Postman测试接口

所有接口都使用POST方法，以下是各接口的测试示例：

分页查询接口
- URL: http://localhost:8080/api/phone-area-code/page
- 请求体:
```
{
  "pageNum": 1,
  "pageSize": 10
}
```

新增接口

URL: http://localhost:8080/api/phone-area-code/save
请求体:

{
  "countryName": "中国",
  "areaCode": "+86",
  "sortOrder": 100,
  "remark": "中国大陆地区"
}

查询单个接口
- URL: http://localhost:8080/api/phone-area-code/getById
- 请求体: 1 (要查询的ID)

更新接口

URL: http://localhost:8080/api/phone-area-code/update
请求体:

{
  "id": 1,
  "countryName": "中国",
  "areaCode": "+86",
  "sortOrder": 200,
  "remark": "中国大陆地区手机号"
}

删除接口
- URL: http://localhost:8080/api/phone-area-code/delete
- 请求体: 1 (要删除的ID)

二、编写单元测试

下面是使用Spring Boot Test编写的单元测试代码：

三、测试注意事项

数据库准备：
- 确保测试前已创建好数据库表结构
- 可以在测试类上添加@Sql注解自动执行初始化SQL脚本
测试顺序：
- 建议先执行新增测试，再执行查询、更新测试
- 最后执行删除测试

测试环境：

可以在application-test.yml中配置测试环境的数据库，避免影响生产数据

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test_database?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: password

添加测试依赖：
如果需要更丰富的测试支持，可以在pom.xml中添加：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>test</scope>
</dependency>

通过以上测试方法，可以全面验证我们实现的接口功能是否正常，确保代码的质量和稳定性。

实现特点

统一响应格式：使用ApiResponse统一封装响应结果
通用分页：实现了通用的PageRequest分页请求对象
统一使用POST请求：所有接口都使用POST方法
逻辑删除：通过MyBatis-Plus实现逻辑删除功能
自动填充：自动填充创建时间、更新时间等公共字段
Lombok：使用@Data等注解减少getter、setter等模板代码
控制层无业务逻辑：Controller只负责转发请求和响应结果

通过以上实现，我们构建了一个规范、高效的Spring Boot 3整合MyBatis-Plus的项目，实现了对手机区号表的完整CRUD操作。

魔乐社区

魔乐社区（Modelers.cn) 是一个中立、公益的人工智能社区，提供人工智能工具、模型、数据的托管、展示与应用协同服务，为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作，由全产业链共同建设、共同运营、共同享有，推动国产AI生态繁荣发展。

更多推荐

全家桶集齐！Qwen3.5四款小模型上线魔乐社区，附昇腾全套实践教程

魔乐社区

Pont - 搭建前后端之桥：高效、灵活的接口管理工具

Pont 是一款强大的数据服务层解决方案，它能够帮助开发者快速搭建前后端之间的桥梁，实现接口的高效管理和代码自动生成。无论是新手还是有经验的开发者，都能通过 Pont 轻松处理接口文档、生成类型安全的 API 代码，从而显著提升开发效率。[![Pont 工具标志](https://raw.gitcode.com/gh_mirrors/po/pont/raw/3f1b7d4bbba3fd2dda

魔乐社区

如何快速上手 hvac：HashiCorp Vault Python 客户端零基础入门指南

**hvac** 是 HashiCorp Vault 的 Python 3.X 客户端库，专为开发者提供简单高效的 Vault 交互方式。无论你是需要管理密钥、配置身份验证，还是实现安全的秘密数据存储，hvac 都能帮助你轻松搞定 Vault 的各项操作。本文将带你零基础快速入门，从安装到基础操作，让你在几分钟内即可上手使用这个强大的工具。[![hvac 客户端 Logo](https://r