MyBatis-Plus自定义模板终极指南：从零构建企业级代码生成方案

MyBatis-Plus自定义模板终极指南：从零构建企业级代码生成方案

【免费下载链接】mybatis-plusmybatis 增强工具包，简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.com项目地址: https://gitcode.com/baomidou/mybatis-plus

在实际项目开发中，我们经常面临这样的困境：标准代码生成器生成的实体类无法满足复杂业务需求，手动编写DTO、VO等对象又效率低下。本文将带你深度实践MyBatis-Plus自定义模板功能，解决这一痛点问题。

为什么我们需要自定义模板？

场景还原：某电商项目中，订单表包含30多个字段，但前端页面仅需展示其中10个字段。如果直接使用生成的实体类，会造成数据传输冗余；如果手动编写DTO，又面临维护困难的问题。

这正是自定义模板的价值所在——通过模板化配置，我们可以精准控制生成代码的结构和内容。

核心实现：两种模板引擎深度对比

FreeMarker vs Velocity：技术选型决策

笔者建议：对于新项目，推荐使用FreeMarker，其语法更现代，错误提示更友好。

实战案例：构建用户管理模块DTO模板

第一步：创建模板文件结构

在项目resources/templates目录下创建userDTO.java.ftl：

package ${package.EntityDTO}; <#list table.importPackages as pkg> import ${pkg}; </#list> import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** * ${table.comment!}数据传输对象 * * @author ${author} * @since ${date} */ @Data @ApiModel(value = "${entity}DTO", description = "${table.comment!}") public class ${entity}DTO { <#-- 只生成核心业务字段，排除技术字段 --> <#list table.fields as field> <#if !field.propertyName?contains("create") && !field.propertyName?contains("update") && !field.propertyName?contains("delete")> @ApiModelProperty("${field.comment}") private ${field.propertyType} ${field.propertyName}; </#if> </#list> }

第二步：配置生成器参数

// 构建自定义模板配置 TemplateConfig templateConfig = new TemplateConfig.Builder() .entity("/templates/entity.java") // 默认实体模板 .entityDto("/templates/userDTO.java.ftl") // 自定义DTO模板 .controller("/templates/controller.java") // 控制器模板 .service("/templates/service.java") // 服务层模板 .mapper("/templates/mapper.java") // Mapper接口模板 .build(); // 集成到代码生成器 FastAutoGenerator.create(dataSourceConfig) .templateConfig(templateConfig) .execute();

第三步：模板变量深度解析

掌握以下关键变量，让你的模板更智能：

• 表结构变量：${table.fields}- 所有字段集合
• 继承关系：${superEntityClass}- 父类判断
• 字段过滤：${field.keyFlag}- 主键标识
• 类型映射：${field.propertyType}- 自动类型转换

高级技巧：模板条件逻辑与业务适配

场景一：按业务模块差异化生成

<#-- 根据不同业务模块应用不同注解 --> <#if table.name?contains("order")> @Validated(OrderGroup.class) <#elseif table.name?contains("user")> @Validated(UserGroup.class) </#if>

场景二：字段级别的智能处理

<#list table.fields as field> <#-- 时间字段特殊处理 --> <#if field.propertyType?contains("Date")> @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") </#if> private ${field.propertyType} ${field.propertyName}; </#list>

效果验证：前后对比分析

改造前问题：

• 数据传输对象包含过多无用字段
• 手动维护DTO与实体类映射关系
• 代码风格不统一，维护成本高

改造后效果：

• 精准生成符合业务需求的DTO类
• 自动保持与数据库字段的同步
• 统一代码规范，降低维护难度

避坑指南：常见问题解决方案

问题1：模板变量无法解析原因：变量名称拼写错误或版本不兼容解决：检查MyBatis-Plus版本对应的变量文档

问题2：生成代码格式混乱原因：模板中的缩进和换行处理不当解决：在模板中统一使用4空格缩进

问题3：循环嵌套导致性能问题原因：复杂模板中的多重循环解决：优化循环逻辑，避免深度嵌套

最佳实践：企业级部署建议

1. 模板版本管理：将模板文件纳入Git仓库，记录每次优化

2. 模板测试流程：

   • 创建测试数据表
   • 执行代码生成
   • 验证生成代码功能

3. 团队协作规范：

   • 建立模板使用文档
   • 制定模板修改审批流程
   • 定期组织模板使用培训

总结：从工具使用者到架构设计者

通过深度掌握MyBatis-Plus自定义模板功能，我们不再仅仅是代码生成工具的使用者，而是能够根据业务需求设计出最适合的代码架构。这种能力的提升，让我们在项目开发中拥有更大的灵活性和控制力。

记住：好的工具应该服务于业务，而不是限制业务。自定义模板正是实现这一目标的关键技术手段。

【免费下载链接】mybatis-plusmybatis 增强工具包，简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.com项目地址: https://gitcode.com/baomidou/mybatis-plus