MyBatis-Plus代码生成模板配置实战手册
2026/6/6 4:13:20 网站建设 项目流程

还在为重复的CRUD代码编写而烦恼吗?MyBatis-Plus的代码生成器能帮你大幅提升开发效率,而掌握自定义模板配置技巧更是让你的项目代码风格统一、维护性更强。今天就来分享一套实用的模板配置方案,让你轻松玩转代码生成!

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

常见痛点与解决方案

痛点一:默认模板无法满足业务需求

很多开发者发现默认生成的实体类缺少DTO、VO等业务对象,每次都要手动创建,效率低下。

解决方案:通过自定义模板,你可以:

  • 生成完整的DTO数据传输对象
  • 自动添加Swagger注解
  • 定制化字段过滤规则
  • 统一项目代码规范

痛点二:多环境配置复杂

不同项目可能需要不同的代码风格,传统方式需要频繁修改生成器配置。

🚀解决方案:模板化配置,一套配置多处使用:

// 快速配置模板路径 TemplateConfig templateConfig = new TemplateConfig.Builder() .entity("templates/my-entity.java.ftl") .entityDto("templates/entity-dto.java.ftl") .controller("templates/my-controller.java.ftl") .build();

模板引擎深度对比

FreeMarker vs Velocity 怎么选?

FreeMarker优势

  • 语法更直观,学习曲线平缓
  • 错误信息友好,调试方便
  • 社区活跃,文档完善

Velocity优势

  • 性能在某些场景下更优
  • 配置相对简单
  • 老项目兼容性好

💡选择建议:新项目推荐FreeMarker,老项目迁移考虑Velocity。

实战:自定义DTO模板配置

步骤1:创建模板文件

resources/templates目录下新建entity-dto.java.ftl

package ${package.EntityDTO}; import java.io.Serializable; <#if swagger2> import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; </#if> /** * ${table.comment!}数据传输对象 * 生成时间:${date} */ <#if swagger2> @ApiModel("${entity}DTO") </#if> public class ${entity}DTO implements Serializable { private static final long serialVersionUID = 1L; <#-- 字段循环生成 --> <#list table.fields as field> <#if field.comment!?length gt 0> /** * ${field.comment} */ </#if> private ${field.propertyType} ${field.propertyName}; </#list> <#-- Getter/Setter方法 --> <#list table.fields as field> public ${field.propertyType} get${field.propertyName?cap_first}() { return this.${field.propertyName}; } public ${entity}DTO set${field.propertyName?cap_first}(${field.propertyType} ${field.propertyName}) { this.${field.propertyName} = ${field.propertyName}; return this; } </#list> }

步骤2:配置生成器参数

FastAutoGenerator.create(dataSourceConfig) .globalConfig(builder -> { builder.author("yourname") .outputDir("src/main/java"); }) .templateConfig(builder -> { builder.entity("templates/my-entity.java.ftl") .entityDto("templates/entity-dto.java.ftl"); }) .execute();

高级配置技巧

条件分支控制

根据不同的业务场景生成不同的代码结构:

<#if table.convert> @TableName("${table.name}") </#if> <#if superEntityClass??> public class ${entity}DTO extends ${superEntityClass} { <#elseif activeRecord> public class ${entity}DTO extends Model<${entity}> { <#else> public class ${entity}DTO { </#if>

字段过滤策略

<#list table.fields as field> <#if !field.keyFlag> <#-- 非主键字段 --> <#if field.fill??> <#-- 填充字段处理 --> </#if> </#list>

常见配置误区解析

误区1:模板路径配置错误

❌ 错误方式:"entity-dto.java.ftl"✅ 正确方式:`"templates/entity-dto.java.ftl"

误区2:变量名称拼写错误

${package.entityDto}${package.EntityDTO}

误区3:忽略版本兼容性

不同版本的MyBatis-Plus可能使用不同的变量名,务必查看对应版本的文档。

性能优化建议

模板缓存配置

启用模板缓存可以显著提升生成速度:

TemplateConfig templateConfig = new TemplateConfig.Builder() .disableCache() // 开发时关闭缓存 .build();

批量生成优化

对于大型项目,建议分模块生成:

// 按表前缀分组生成 .strategyConfig(builder -> { builder.addInclude("sys_*") // 系统模块 .addInclude("biz_*"); // 业务模块 })

最佳实践总结

  1. 模板标准化:建立团队统一的模板库
  2. 版本控制:模板文件纳入Git管理
  3. 文档完善:为每个模板添加使用说明
  4. 持续优化:根据项目反馈不断改进模板

通过合理的MyBatis-Plus代码生成模板配置,你不仅能提升开发效率,还能确保项目代码的质量和一致性。赶快动手试试吧,让你的编码工作变得更加轻松高效!

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

创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

需要专业的网站建设服务?

联系我们获取免费的网站建设咨询和方案报价,让我们帮助您实现业务目标

立即咨询