MBG 配置自定义模板javamodelGenerator全流程指南

一、引言：MBG与javamodelGenerator的核心价值

MyBatis Generator（MBG）作为MyBatis框架的代码生成工具，通过自动化生成POJO、Mapper接口及XML映射文件，显著提升了开发效率。其中，javamodelGenerator是MBG的核心组件之一，负责生成Java实体类（POJO）。默认生成的实体类可能无法满足复杂业务需求（如字段校验、关联对象处理等），而通过配置自定义模板，开发者可以精准控制生成逻辑，实现代码的灵活定制。

本文将围绕MBG的javamodelGenerator配置展开，从基础配置到高级模板定制，系统讲解如何通过自定义模板优化代码生成流程，提升开发效率与代码质量。

二、MBG基础配置：环境搭建与核心文件解析

1. 依赖引入与插件配置

在Maven项目中，需引入MBG核心依赖及插件：

<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.2</version>
</dependency>
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.2</version>
    <configuration>
        <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

2. generatorConfig.xml结构解析

generatorConfig.xml是MBG的配置核心，包含数据库连接、表映射、生成策略等配置。其中，<javaModelGenerator>标签用于定义实体类生成规则：

<context id="DB2Tables" targetRuntime="MyBatis3">
    <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
        <property name="enableSubPackages" value="true"/>
        <property name="trimStrings" value="true"/>
    </javaModelGenerator>
</context>

• targetPackage：指定生成的实体类包路径。
• targetProject：指定生成文件的输出目录。
• enableSubPackages：是否按表名生成子包（如com.example.model.user）。
• trimStrings：是否自动去除字符串字段的首尾空格。

三、javamodelGenerator自定义模板配置：从默认到进阶

1. 默认模板的局限性

默认生成的实体类仅包含字段、Getter/Setter及基础构造方法，缺乏：

• 字段校验（如非空、长度限制）。
• 关联对象处理（如一对多关系）。
• 业务逻辑方法（如状态转换）。

2. 自定义模板的配置步骤

步骤1：定位模板文件

MBG的模板文件位于org.mybatis.generator.internal.DefaultCommentGenerator的默认实现中，开发者需复制并修改以下模板：

• JavaModelGenerator.ftl（实体类模板）。
• JavaClientGenerator.ftl（Mapper接口模板）。

模板文件通常放置在src/main/resources/templates目录下，并通过<property>标签指定路径：

<javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java">
    <property name="templateFile" value="src/main/resources/templates/JavaModelGenerator.ftl"/>
</javaModelGenerator>

步骤2：模板语法与变量解析

MBG模板基于FreeMarker引擎，支持以下变量：

• table：表信息（如表名、字段列表）。
• field：字段信息（如字段名、类型、注释）。
• properties：配置属性（如trimStrings）。

示例：生成带校验注解的字段

<#list table.fullyQualifiedTable.columns as column>
    <#if column.javaProperty != "id">
    @NotNull(message = "${column.remarks}不能为空")
    @Size(max = ${column.length}, message = "${column.remarks}长度不能超过${column.length}")
    private ${column.javaType} ${column.javaProperty};
    </#if>
</#list>

步骤3：高级模板定制场景

场景1：添加Lombok支持
通过模板注入@Data、@NoArgsConstructor等注解：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ${table.className} {
    <#list table.fullyQualifiedTable.columns as column>
    private ${column.javaType} ${column.javaProperty};
    </#list>
}

场景2：处理枚举类型
若字段为枚举类型，可在模板中生成枚举类：

<#if column.javaType == "String" && column.remarks.contains("状态")>
public enum ${table.className}Status {
    <#list ["ACTIVE", "INACTIVE"] as status>
    ${status}("${status}"),
    </#list>
    private String value;
    // 构造方法与Getter
}
</#if>

四、实战案例：从需求到代码生成

案例1：生成带校验的实体类

需求：用户表包含username（非空，长度≤20）、age（范围1-120）字段。

步骤：

1. 修改模板，添加校验注解：

   <#list table.fullyQualifiedTable.columns as column>
    <#if column.javaProperty == "username">
    @NotNull(message = "用户名不能为空")
    @Size(max = 20, message = "用户名长度不能超过20")
    </#if>
    <#if column.javaProperty == "age">
    @Min(value = 1, message = "年龄不能小于1")
    @Max(value = 120, message = "年龄不能大于120")
    </#if>
    private ${column.javaType} ${column.javaProperty};
   </#list>

2. 执行生成命令：

   mvn mybatis-generator:generate

案例2：生成关联对象

需求：订单表关联用户表，生成带用户信息的订单实体。

步骤：

1. 在模板中添加关联字段：
   ```freemarker
   private User user; // 假设User类已存在

public User getUser() {
return user;
}

public void setUser(User user) {
this.user = user;
}
```

1. 配置<table>标签的domainObjectName属性，确保表名与类名匹配。

五、最佳实践与注意事项

1. 模板版本控制

将自定义模板纳入版本管理（如Git），避免因环境差异导致生成结果不一致。

2. 兼容性测试

修改模板后，需测试生成代码的编译通过性及业务逻辑正确性。

3. 性能优化

• 避免在模板中执行复杂逻辑（如循环嵌套）。
• 使用<#if>条件判断减少不必要的代码生成。

4. 文档维护

记录模板修改点及业务规则，便于后续维护。

六、总结与展望

通过配置MBG的javamodelGenerator自定义模板，开发者可以精准控制实体类生成逻辑，满足复杂业务需求。本文从基础配置到高级模板定制，系统讲解了实现路径与实战案例。未来，随着MyBatis生态的完善，模板定制将更加智能化（如AI辅助生成校验规则），进一步降低开发成本。

建议开发者结合实际项目需求，逐步优化模板，形成可复用的代码生成规范，提升团队开发效率。