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

MyBatis-Plus作为一款优秀的ORM框架，其代码生成器功能广受开发者喜爱。但在实际使用过程中，很多开发者会遇到自定义模板不生效的问题。本文将深入分析这一问题，并提供完整的解决方案。

问题现象分析

当开发者尝试使用MyBatis-Plus代码生成器时，可能会遇到以下情况：

• 在策略配置中指定了自定义模板路径
• 模板文件已放置在项目中指定位置
• 但生成的代码仍然使用默认模板而非自定义模板

根本原因

经过分析，这类问题通常源于以下两个原因：

1. 模板文件路径配置错误：开发者可能使用了错误的相对路径或绝对路径
2. 构建配置问题：模板文件未被正确包含在构建资源中，导致生成器无法找到模板文件

详细解决方案

1. 模板文件放置位置

MyBatis-Plus代码生成器支持两种模板文件放置方式：

• 类路径下：推荐将模板文件放在src/main/resources/templates目录下
• 文件系统路径：使用绝对路径引用模板文件

2. 正确配置模板路径

在策略配置中，应使用以下方式指定模板路径：

.entityBuilder()
    .javaTemplate("/templates/entity.java")  // 类路径下的模板
.controllerBuilder()
    .template("/templates/controller.java")  // 类路径下的模板

注意路径前缀的/符号，这表示从类路径根目录开始查找。

3. 确保模板文件被包含

在Maven项目中，需要在pom.xml中确保模板文件被包含在资源中：

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

4. 完整配置示例

以下是一个完整的代码生成器配置示例，展示了如何正确使用自定义模板：

FastAutoGenerator.create(dataSourceConfig)
    .globalConfig(builder -> {
        builder.author("author")
            .outputDir("生成路径");
    })
    .packageConfig(builder -> {
        builder.parent("com.example");
    })
    .strategyConfig(builder -> {
        builder.addInclude("表名")
            .entityBuilder()
                .javaTemplate("/templates/entity.java")
                .enableLombok()
            .controllerBuilder()
                .template("/templates/controller.java")
            .serviceBuilder()
                .serviceTemplate("/templates/service.java")
                .serviceImplTemplate("/templates/serviceImpl.java")
            .mapperBuilder()
                .mapperTemplate("/templates/mapper.java")
                .mapperXmlTemplate("/templates/mapper.xml");
    })
    .execute();

常见问题排查

1. 模板文件找不到：检查文件是否在正确位置，以及构建后是否出现在target/classes目录下
2. 路径错误：尝试使用绝对路径进行测试
3. 模板语法错误：确保模板文件使用正确的Velocity或Freemarker语法

最佳实践建议

1. 将模板文件统一放置在resources/templates目录下
2. 在pom.xml中明确包含模板文件类型
3. 开发时先使用简单模板测试路径配置
4. 考虑将模板配置提取为常量，提高代码可维护性

通过以上配置和注意事项，开发者可以充分利用MyBatis-Plus代码生成器的自定义模板功能，根据项目需求生成符合规范的代码结构，大大提高开发效率。