【限时免费】 MyBatis-Plus代码生成器自定义模板配置指南

问题背景

在使用MyBatis-Plus的FastAutoGenerator进行代码生成时，开发者经常需要自定义生成模板以满足特定项目需求。近期有开发者反馈在3.5.12版本中，通过templateConfig配置自定义模板无效，特别是希望单独自定义controller模板而其他组件使用默认模板的情况。

核心问题分析

经过深入分析，我们发现从MyBatis-Plus 3.5.6版本开始，模板配置方式发生了重要变化：

1. 配置位置变更：templateConfig的配置项已合并到StrategyConfig中，不再作为独立配置
2. 模板禁用机制：disable()方法的使用方式也相应调整

正确配置方法

1. 自定义特定模板

若只需自定义controller模板而其他组件使用默认模板，应采用如下配置方式：

.strategyConfig(builder -> {
    builder.controllerBuilder()
           .enableFileOverride()
           .formatControllerFileName("%sController")
           .enableRestStyle()
           .build();
})

2. 完全禁用默认模板

如需完全禁用默认模板并全部使用自定义模板，应使用：

.strategyConfig(builder -> {
    builder.disableGenerateFile();  // 禁用所有默认生成
    builder.controllerBuilder().enableFileOverride().build();  // 单独启用controller
})

模板文件存放位置

自定义模板文件应放置在项目的资源目录下：

src/main/resources/templates/custom/controller.java.vm

版本兼容性说明

不同MyBatis-Plus版本对模板配置的处理方式：

• 3.5.6之前：使用templateConfig独立配置
• 3.5.6及之后：模板配置合并到StrategyConfig

最佳实践建议

1. 版本检查：使用前确认MyBatis-Plus版本号
2. 配置顺序：StrategyConfig应放在生成器配置的最后部分
3. 模板调试：建议先测试单个模板文件是否被正确加载
4. 文件覆盖：启用enableFileOverride()避免重复生成时的冲突

总结

MyBatis-Plus在3.5.6版本对代码生成器的模板配置进行了优化整合，将相关配置统一到StrategyConfig中。开发者在使用新版本时需要注意这一变化，按照新的配置方式调整代码生成逻辑。通过合理配置，可以灵活实现各种自定义代码生成需求，同时保持生成代码的一致性和规范性。