MyBatis-Plus自定义代码生成模板实践指南

MyBatis-Plus作为MyBatis的增强工具，提供了强大的代码生成器功能，可以快速生成Entity、Mapper、Service、Controller等基础代码。但在实际项目中，我们经常需要生成DTO、VO等自定义对象，这就需要掌握自定义模板的使用方法。

自定义模板基础

MyBatis-Plus 3.5.0+版本支持通过Freemarker(.ftl)或Velocity(.vm)模板引擎来自定义代码生成。模板文件需要放置在项目的resources/templates目录下。

DTO模板示例

以下是一个典型的DTO模板示例(以Freemarker为例)：

package ${package.Entity}.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
<#list table.importPackages as pkg>
import ${pkg};
</#list>

/**
 * <p>
 * ${table.comment!}数据传输对象
 * </p>
 */
@ApiModel(value = "${entity}DTO", description = "${table.comment!}数据传输对象")
public class ${entity}DTO implements Serializable {
<#-- 循环生成字段 -->
<#list table.fields as field>
    @ApiModelProperty(value = "${field.comment!}")
    private ${field.propertyType} ${field.propertyName};
</#list>

<#-- 生成getter/setter方法 -->
<#list table.fields as field>
    public ${field.propertyType} get${field.capitalName}() {
        return ${field.propertyName};
    }

    public void set${field.capitalName}(${field.propertyType} ${field.propertyName}) {
        this.${field.propertyName} = ${field.propertyName};
    }
</#list>

    @Override
    public String toString() {
        return "${entity}DTO{" +
        <#list table.fields as field>
            <#if field_index==0>
                "${field.propertyName}=" + ${field.propertyName} +
            <#else>
                ", ${field.propertyName}=" + ${field.propertyName} +
            </#if>
        </#list>
        "}";
    }
}

模板配置

在代码生成器配置中，需要指定自定义模板：

// 配置模板
TemplateConfig templateConfig = new TemplateConfig.Builder()
        .entity("/templates/entity.java")
        .service("/templates/service.java")
        .serviceImpl("/templates/serviceImpl.java")
        .mapper("/templates/mapper.java")
        .xml("/templates/mapper.xml")
        .controller("/templates/controller.java")
        .other("/templates/dto.java")  // 自定义DTO模板
        .build();

模板变量说明

MyBatis-Plus提供了丰富的模板变量，可以在模板中直接使用：

• package：各种包路径配置
• table：表信息对象
  • name：表名
  • comment：表注释
  • fields：字段集合
• entity：实体类名称
• superClass：父类信息
• activeRecord：是否开启ActiveRecord模式
• author：作者信息
• date：当前日期

最佳实践建议

1. 模板组织：建议将不同类型的模板分类存放，如dto、vo、convert等

2. 模板继承：可以创建基础模板，其他模板继承基础模板减少重复代码

3. 模板测试：生成代码前先测试模板是否正确，避免批量生成错误代码

4. 版本控制：将模板文件纳入版本控制，方便团队共享和回溯

5. 模板变量扩展：可以通过继承InjectionConfig类来扩展模板变量

通过合理使用自定义模板功能，可以大幅提升开发效率，保持项目代码风格统一，同时满足各种业务场景下的代码生成需求。