MyBatis-Plus代码生成器使用指南 - 快速生成Entity、Service、Controller代码

• Java
• Kotlin

支持的组件类型：

• Entity
• Mapper
• Service
• ServiceImpl
• Controller
• DTO
• VO
• BO
• Model

如何使用此技能

关键：此技能应仅在用户明确提及 MyBatis-Plus 或 mybatis-plus-generator 时触发。对于没有 MyBatis-Plus 上下文的通用代码生成请求，请勿触发。

工作流程概述

此技能遵循一个系统化的 8 步工作流程：

1. 收集配置 - 收集数据库信息、全局配置、包配置、策略配置
2. 确定架构 - 询问用户架构类型以确定需要生成哪些对象
3. 收集需求 - 询问用户功能需求以分析并确定需要生成的方法
4. 确定语言 - 询问用户编程语言
5. 创建待办列表 - 生成包含表名、对象类型和方法名的详细待办列表
6. 生成代码 - 根据表结构和需求生成带有智能注释的代码文件
7. 进度更新 - 在代码生成过程中提供实时进度更新
8. 统计信息 - 生成完成后输出统计信息

分步流程

步骤 1：收集配置

关键：在生成任何代码之前，您必须收集以下配置：

1. 数据库信息：

   • 数据库类型
   • 数据库连接 URL（或请用户提供表结构）
   • 数据库名称
   • 表名（一个或多个表）
   • 如果用户无法提供数据库连接，请询问表结构

2. 全局配置：

   • 作者姓名
   • 输出目录
   • 文件覆盖策略
   • 启用 Lombok
   • 启用 API 文档
   • API 文档类型：
     • Swagger 2
     • OpenAPI 3
   • 启用验证注解

3. 包配置：

   • 父包名称
   • Entity 包
   • Mapper 包
   • Service 包
   • ServiceImpl 包
   • Controller 包
   • DTO 包
   • VO 包
   • BO 包

4. 策略配置：

   • 命名策略
   • 表前缀移除
   • 字段命名策略
   • 主键策略

重要：API 文档类型选择：

当用户启用 API 文档时，您必须询问：

请选择 API 文档类型：
- [ ] Swagger 2
  - 使用注解：@ApiModel, @ApiModelProperty, @Api, @ApiOperation
  - 依赖：springfox-swagger2, springfox-swagger-ui
  - 适用于：Spring Boot 2.x 项目
- [ ] OpenAPI 3
  - 使用注解：@Schema, @Tag, @Operation, @Parameter
  - 依赖：springdoc-openapi-ui
  - 适用于：Spring Boot 2.2+ 和 Spring Boot 3.x 项目

等待用户确认后再继续。

输出：显示所有收集信息的配置摘要，包括 API 文档类型。

步骤 2：确定架构

关键：您必须询问用户架构类型，以确定需要生成哪些对象。

呈现架构选项：

请选择项目架构类型：
- [ ] 传统 MVC
  - 生成：Entity, Mapper, Service, ServiceImpl, Controller
- [ ] DDD
  - 生成：Entity, Mapper, Service, ServiceImpl, Controller, DTO, VO, BO
- [ ] 分层架构
  - 生成：Entity, Mapper, Service, ServiceImpl, Controller
- [ ] 整洁架构
  - 生成：Entity, Repository, UseCase, Controller, DTO
- [ ] 自定义架构
  - 请指定需要生成的对象类型

等待用户确认后再继续。

重要：基于架构的目录映射

确定架构类型后，您必须为每个生成的对象确定正确的输出目录。

关键步骤：

1. 询问用户基础包路径
2. 使用架构目录映射来确定正确的路径：
   • 快速参考：查看 reference/architecture-directory-quick-reference.md 中的查找表
   • 详细指南：查看 reference/architecture-directory-mapping-guide.md 中的完整映射规则
3. 验证目录是否存在，如果不存在则创建
4. 生成文件到正确的位置

常见路径示例：

对于基础包为 com.example.order 的 user 表：

• MVC：Entity → com/example/order/entity/User.java, Controller → com/example/order/controller/UserController.java
• DDD：Entity → com/example/order/domain/model/aggregate/user/User.java, Controller → com/example/order/interfaces/web/controller/UserController.java
• 六边形架构：Entity → com/example/order/domain/model/entity/User.java, Controller → com/example/order/infrastructure/adapter/inbound/web/controller/UserController.java
• 整洁架构：Entity → com/example/order/domain/entity/User.java, Controller → com/example/order/infrastructure/web/controller/UserController.java
• COLA：Entity → com/example/order/domain/model/entity/User.java, Controller → com/example/order/adapter/web/controller/UserController.java

关键：如果项目结构不明确，请始终与用户确认确切的目录结构。询问："请确认项目的目录结构，以便我将生成的代码放在正确的位置。"

步骤 3：收集需求

关键：询问用户功能需求，以了解需要生成哪些方法。

询问用户：

请描述此次生成代码的功能需求：

例如：
- 用户管理：需要根据邮箱查询用户、根据用户名查询用户、用户登录验证
- 订单管理：需要订单统计、订单分页查询、订单状态更新
- 商品管理：需要商品搜索、商品分类查询、库存管理

请详细描述每个表需要哪些功能，我会根据需求自动分析需要生成的方法。

用户提供需求后：

1. 分析需求以识别：

   • 标准 CRUD 方法
   • 自定义查询方法
   • 自定义业务方法
   • 自定义更新方法

2. 对于每个表，识别：

   • 需要的标准方法
   • 基于需求需要的自定义方法
   • 方法参数和返回类型
   • 业务逻辑提示

输出：显示以下内容的需求分析：

• 每个表的标准方法
• 每个表的自定义方法
• 方法签名

步骤 4：确定语言

关键：询问用户编程语言。

请选择编程语言：
- [ ] Java
- [ ] Kotlin

等待用户确认后再继续。

注意：templates/ 目录中的模板支持 Java 和 Kotlin。根据用户的选择使用适当的模板。

步骤 5：创建待办列表

关键：收集所有信息后，创建一个详细的待办列表。

对于每个表，生成一个结构化的待办列表：

## Todo List: MyBatis-Plus Code Generation

### Table: user

#### Entity 层
- [ ] User.java - 实体类
  - [ ] 类注释
  - [ ] 字段定义（id, username, email, password, status, createTime, updateTime）
  - [ ] 字段注释

#### Mapper 层
- [ ] UserMapper.java - 数据访问接口
  - [ ] 类注释
  - [ ] 基础 CRUD 方法（继承 BaseMapper）

#### Service 层
- [ ] UserService.java - 服务接口
  - [ ] 类注释
  - [ ] saveUser() - 保存用户
  - [ ] findById() - 根据ID查询
  - [ ] updateUser() - 更新用户
  - [ ] deleteById() - 删除用户
  - [ ] findByEmail() - 根据邮箱查询（自定义方法）
  - [ ] findByUsername() - 根据用户名查询（自定义方法）

#### ServiceImpl 层
- [ ] UserServiceImpl.java - 服务实现类
  - [ ] 类注释
  - [ ] 实现所有 Service 接口方法
  - [ ] 方法注释和实现骨架

#### Controller 层
- [ ] UserController.java - 控制器
  - [ ] 类注释
  - [ ] createUser() - 创建用户
  - [ ] getUserById() - 查询用户
  - [ ] updateUser() - 更新用户
  - [ ] deleteUser() - 删除用户
  - [ ] getUserByEmail() - 根据邮箱查询（自定义接口）

#### DTO 层（如果架构需要）
- [ ] UserCreateDTO.java - 创建用户DTO
- [ ] UserUpdateDTO.java - 更新用户DTO
- [ ] UserQueryDTO.java - 查询用户DTO

#### VO 层（如果架构需要）
- [ ] UserVO.java - 用户视图对象

### Table: order
...

重要：

• 按表组织
• 列出所有需要生成的对象
• 包含所有方法
• 使用复选框跟踪进度

步骤 6：生成代码

关键：根据表结构和需求生成带有智能注释的代码文件。

生成顺序：

1. Entity - 首先
2. Mapper - 其次
3. Service - 第三
4. ServiceImpl - 第四
5. Controller - 第五
6. DTO/VO/BO - 第六

对于每个对象：

1. 加载适当的模板，基于对象类型和语言
2. 分析表结构：读取列、类型、约束、主键、外键、关系
3. 生成智能注释：基于业务上下文，而不仅仅是技术名称
   • 类注释：解释目的，列出主要字段
   • 方法注释：解释业务逻辑，包含所有参数和返回类型
   • 字段注释：解释业务含义，而不仅仅是列名
4. 生成代码：替换模板变量，添加注解，生成方法骨架
5. 对于自定义方法：生成签名，添加业务逻辑注释，添加 TODO 提示
6. 确定输出目录：使用架构目录映射
7. 保存文件到基于架构和包配置的正确位置

生成每个对象后：

• 更新待办列表：用 [x] 标记已完成的项目
• 向用户显示进度
• 继续下一个对象

代码生成标准：有关注释、模板和代码质量的详细要求，请参阅 reference/code-generation-standards.md。

步骤 7：进度更新

关键：在代码生成过程中提供实时进度更新。

在以下情况后更新进度：

• 开始处理每个表时
• 生成每个对象时
• 添加每个方法时
• 完成每个表时

进度格式：有关进度更新格式和示例的详细信息，请参阅 reference/progress-and-statistics-formats.md。

步骤 8：统计信息

关键：所有代码生成完成后，输出全面的统计信息。

统计信息格式：有关统计信息格式的详细信息，请参阅 reference/progress-and-statistics-formats.md，包括：

• 总体统计信息
• 每个表的统计信息
• 每种类型的统计信息
• 文件位置
• 代码质量检查清单

代码生成标准

重要：生成的代码必须包含智能的、上下文感知的注释，而不仅仅是模板占位符。

关键要求：

1. 类注释：基于业务上下文解释目的，包括表映射，列出主要字段
2. 方法注释：解释业务逻辑，包含所有带类型的参数，带类型的返回值，异常
3. 字段注释：解释业务含义，包括数据类型和约束，而不仅仅是列名

详细标准：有关以下内容的完整信息，请参阅 reference/code-generation-standards.md：

• 完整的注释格式要求
• 模板使用指南
• 模板变量参考
• Swagger 注解选择
• 自定义方法生成标准
• 代码质量要求

最佳实践

1. 智能注释：基于表结构分析和业务需求生成注释，而不仅仅是模板占位符
2. 上下文感知：理解表关系和业务上下文以生成有意义的注释
3. 方法分析：分析用户需求以确定需要哪些方法
4. 进度跟踪：始终更新待办列表并显示进度
5. 代码质量：生成具有适当注解和验证的生产就绪代码
6. 模板增强：使用模板作为基础，但通过智能添加进行增强
7. 语言支持：通过适当的模板支持 Java 和 Kotlin

参考文档

关键：使用这些参考文档获取详细指导：

架构与目录映射

• reference/architecture-directory-mapping-guide.md - 所有架构的完整目录映射指南
• reference/architecture-directory-quick-reference.md - 目录映射快速查找表

代码生成标准

• reference/code-generation-standards.md - 详细的注释标准、模板使用和代码质量要求
• reference/template-variables.md - 模板变量的完整列表
• reference/swagger-annotations-guide.md - Swagger 2 与 OpenAPI 3 注解对比

进度与统计信息

• reference/progress-and-statistics-formats.md - 进度更新和统计信息输出格式

MyBatis-Plus 参考

• reference/mybatis-plus-generator-guide.md - MyBatis-Plus Generator 使用指南

示例

查看 examples/ 目录获取完整示例：

• examples/mvc-architecture-example.md - MVC 架构生成示例
• examples/ddd-architecture-example.md - DDD 架构生成示例
• examples/full-workflow-example.md - 完整工作流程示例
• examples/architecture-directory-mapping.md - 不同架构的目录映射示例
• examples/swagger-annotations-example.md - Swagger 2 与 OpenAPI 3 注解示例

模板

模板位于 templates/ 目录中，使用 FreeMarker 语法，严格遵循 MyBatis-Plus 官方模板。

标准模板

Java 模板：

• entity.java.ftl - Entity 类模板
• mapper.java.ftl - Mapper 接口模板
• service.java.ftl - Service 接口模板
• serviceImpl.java.ftl - Service 实现模板
• controller.java.ftl - Controller 模板
• dto.java.ftl - DTO 模板
• vo.java.ftl - VO 模板
• bo.java.ftl - BO 模板

Kotlin 模板：

• entity.kt.ftl - Entity 数据类模板
• mapper.kt.ftl - Mapper 接口模板
• service.kt.ftl - Service 接口模板
• serviceImpl.kt.ftl - Service 实现模板
• controller.kt.ftl - Controller 模板
• dto.kt.ftl - DTO 模板
• vo.kt.ftl - VO 模板
• bo.kt.ftl - BO 模板

DDD 架构模板

所有 DDD 模板都位于 templates/ 根目录中，支持 Java 和 Kotlin：

领域层：

• aggregate-root.java.ftl / aggregate-root.kt.ftl - 聚合根模板
• repository.java.ftl / repository.kt.ftl - Repository 接口模板
• domain-service.java.ftl / domain-service.kt.ftl - 领域服务模板
• value-object.java.ftl / value-object.kt.ftl - 值对象模板
• domain-event.java.ftl / domain-event.kt.ftl - 领域事件模板

应用层：

• application-service.java.ftl / application-service.kt.ftl - 应用服务模板

接口层：

• assembler.java.ftl / assembler.kt.ftl - DTO 装配器模板

模板特性：

• 支持 Swagger 2 和 OpenAPI 3 注解
• 基于表结构的智能注释
• 自定义方法生成支持
• Kotlin 特定特性
• DDD 特定模式
• FreeMarker 语法

参考：查看 MyBatis-Plus 官方模板：

• https://github.com/baomidou/mybatis-plus/tree/3.0/mybatis-plus-generator/src/main/resources/templates

关键词

英文关键词： mybatis-plus, mybatis-plus-generator, mybatis-plus code generator, mybatis-plus code generation, generate mybatis-plus code, mybatis-plus entity generator, mybatis-plus mapper generator, mybatis-plus service generator, mybatis-plus controller generator, mybatis-plus crud generation, mybatis-plus from table, mybatis-plus code from database

中文关键词： MyBatis-Plus, mybatis-plus-generator, MyBatis-Plus 代码生成器, MyBatis-Plus 代码生成, 生成 MyBatis-Plus 代码, MyBatis-Plus 实体类生成, MyBatis-Plus Mapper 生成, MyBatis-Plus Service 生成, MyBatis-Plus Controller 生成, MyBatis-Plus CRUD 生成, MyBatis-Plus 根据表生成代码, MyBatis-Plus 数据库转代码, MyBatis-Plus 表转 Java, 使用 MyBatis-Plus 生成代码

重要：所有关键词必须包含 "MyBatis-Plus" 或 "mybatis-plus" 以避免误触发。没有 "MyBatis-Plus" 的通用术语不应触发此技能。

每周安装数

181

仓库

teachingai/full…k-skills

GitHub Stars

208

首次出现

Jan 24, 2026

安全审计

Gen Agent Trust HubPassSocketPassSnykPass

安装于

opencode165

gemini-cli158

codex157

github-copilot150

cursor148

kimi-cli141