MyBatis-Plus代码生成器自定义模板优化实践

背景介绍

MyBatis-Plus作为MyBatis的增强工具，其代码生成器功能广受开发者欢迎。在实际开发中，我们经常需要生成DTO(数据传输对象)等自定义代码结构，但当前版本在自定义模板支持上存在一些不便之处。

问题分析

当使用MyBatis-Plus代码生成器的自定义文件功能时，开发者会遇到两个主要痛点：

1. 包路径重复配置：在定义DTO等自定义文件时，虽然已经通过packageName()方法配置了包路径，但在模板中仍需重复拼接父包路径，如${package.Parent}.model.dto。

2. 命名规则不统一：对于自定义文件的类名，开发者需要手动处理命名规则（如添加DTO后缀），而无法像内置模板那样自动获取格式化后的名称。

解决方案

包路径自动注入

理想情况下，代码生成器应自动将自定义文件的包路径注入到模板上下文中的package对象。例如，当配置：

.customFile(builder -> builder
    .fileName("DTO.java")
    .packageName("model.dto"))

生成器应自动在模板上下文中添加：

package.put("DTO", "基础包路径.model.dto");

这样在模板中就可以直接使用${package.DTO}来获取完整包路径。

类名自动处理

对于自定义文件的类名，生成器应提供自动处理机制。例如，对于配置的文件名"DTO.java"，生成器可以：

1. 自动识别后缀（如DTO）
2. 基于实体名生成格式化后的类名（如User实体生成UserDTO）
3. 将格式化后的类名注入模板上下文

实现建议

MyBatis-Plus可以在InjectionConfig中增强以下功能：

1. 自动包路径注入：解析packageName()配置，自动构建完整包路径并注入模板上下文。

2. 智能类名处理：提供命名策略接口，允许开发者自定义类名生成规则，同时内置常用策略（如添加后缀）。

3. 上下文扩展机制：提供更灵活的上下文扩展点，方便开发者添加自定义变量。

最佳实践

在当前版本下，开发者可以通过以下方式临时解决问题：

injectionConfig(builder -> {
    builder.beforeOutputFile((tableInfo, objectMap) -> {
        // 手动处理包路径
        String parentPackage = (String)objectMap.get("package").get("Parent");
        objectMap.put("package", Map.of(
            "Parent", parentPackage,
            "DTO", parentPackage + ".model.dto"
        ));
        
        // 手动处理类名
        objectMap.put("DTOName", tableInfo.getEntityName() + "DTO");
    });
});

总结

MyBatis-Plus代码生成器的自定义模板功能在实际应用中还有优化空间。通过增强包路径和类名的自动处理能力，可以显著提升开发体验。期待官方在后续版本中提供更完善的自定义模板支持，减少开发者的重复配置工作。