MyBatis-Plus代码生成器自定义模板配置指南

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

问题背景

在使用MyBatis-Plus代码生成器时，开发者可能会遇到自定义模板不生效的问题。本文将详细分析这一问题，并提供完整的解决方案。

核心问题分析

当开发者配置了自定义模板路径（如/templates/entity.java）但生成代码时仍使用默认模板，通常是由于以下原因：

1. 模板文件未被正确放置在资源目录中
2. 项目构建配置忽略了模板资源文件
3. 模板路径配置错误

完整解决方案

1. 模板文件存放位置

确保自定义模板文件存放在项目的资源目录下，通常为：

src/main/resources/templates/

2. 项目构建配置检查

在Maven项目中，确保pom.xml没有忽略资源文件：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>**/*.vm</include>
                <include>**/*.xml</include>
                <include>**/*.properties</include>
            </includes>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

3. 正确配置模板路径

在代码生成器配置中，模板路径应相对于资源目录：

.entityBuilder()
    .javaTemplate("/templates/entity.java")  // 注意是/templates/而非template/

4. 完整配置示例

FastAutoGenerator.create(dataSourceConfig)
    .strategyConfig(builder -> {
        builder.entityBuilder()
            .javaTemplate("/templates/entity.java")
            .enableLombok()
            .enableFileOverride();
            
        builder.controllerBuilder()
            .template("/templates/controller.java")
            .enableRestStyle();
            
        builder.serviceBuilder()
            .serviceTemplate("/templates/service.java")
            .serviceImplTemplate("/templates/serviceImpl.java");
            
        builder.mapperBuilder()
            .mapperTemplate("/templates/mapper.java")
            .mapperXmlTemplate("/templates/mapper.xml");
    })
    .execute();

常见问题排查

1. 模板文件未生效：

   • 检查文件是否在正确目录
   • 检查文件名和扩展名是否正确
   • 确保构建时资源文件被包含

2. 生成代码格式异常：

   • 检查模板语法是否正确
   • 确保模板变量与MyBatis-Plus版本兼容

3. 文件覆盖问题：

   • 显式启用.enableFileOverride()

最佳实践建议

1. 在团队开发中，建议将模板文件统一管理，可以考虑：

   • 创建专门的模板模块
   • 使用版本控制管理模板变更

2. 对于复杂项目，可以考虑：

   • 分层模板设计
   • 自定义模板引擎
   • 模板变量扩展

3. 定期检查模板与MyBatis-Plus版本的兼容性

通过以上配置和注意事项，开发者可以充分利用MyBatis-Plus代码生成器的自定义模板功能，大幅提升开发效率。

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