告别Getter/Setter地狱：手把手教你定制若依代码生成器的Domain模板（基于Lombok）

深度定制若依代码生成器用Lombok重构Domain模板的工程实践在Java企业级开发中实体类Domain的编写往往伴随着大量重复的Getter/Setter方法这不仅增加了代码量也降低了核心业务逻辑的可读性。若依框架作为国内流行的快速开发平台其代码生成器能显著提升CRUD功能的开发效率但默认生成的Domain模板仍保留着传统的JavaBean规范。本文将带你深入若依代码生成器的模板引擎机制通过Lombok注解实现Domain层的极简主义并探讨如何建立团队统一的代码生成规范。1. 理解若依代码生成器的模板机制若依框架的代码生成器基于Velocity模板引擎.vm文件实现这种设计赋予了开发者极高的定制自由度。在开始修改前我们需要先掌握几个关键概念模板上下文变量代码生成器会向模板注入表结构元数据如${table.xxx}系列变量包路径处理模板中需要正确处理各类import语句的生成逻辑语法混合Velocity指令与Java代码的嵌套编写规范典型的Domain模板位于ruoyi-generator/src/main/resources/vm/java/domain.java.vm其核心结构包含package ${packageName}.domain; import java.io.Serializable; import java.util.Date; #foreach ($column in $columns) #if($column.attrType BigDecimal) import java.math.BigDecimal; #break #end #end public class ${ClassName} implements Serializable { private static final long serialVersionUID 1L; #foreach ($column in $columns) /** $column.columnComment */ private $column.attrType $column.attrname; #end // 原始模板此处会生成Getter/Setter方法 }2. Lombok集成方案设计为保持生成的代码符合团队规范我们需要系统性地规划改造方案2.1 依赖管理策略虽然可以在每个项目中单独添加Lombok依赖但更推荐在若依的生成器模块中统一配置!-- ruoyi-generator/pom.xml -- dependency groupIdorg.projectlombok/groupId artifactIdlombok/artifactId version1.18.24/version scopeprovided/scope /dependency注意scope设为provided确保依赖不会传递到生成的项目中由各项目自行决定Lombok版本2.2 注解选择与团队规范不同团队可能偏好不同的Lombok注解组合以下是几种常见模式注解组合适用场景特点Data Builder常规DTO提供完整功能但可能过度生成Value Builder不可变对象适合函数式编程风格Getter Setter精细控制按需选择生成方法推荐采用以下平衡方案Data NoArgsConstructor AllArgsConstructor Builder Accessors(chain true) // 支持链式调用 public class ${ClassName} { // 字段定义 }2.3 模板修改关键步骤在package声明后添加Lombok导入import lombok.*; import lombok.experimental.Accessors;删除模板中的以下部分所有get/set方法生成代码块toString()方法及其相关import可能存在的equals/hashCode方法在类声明上方添加注解块#foreach ($annotation in $lombokAnnotations) $annotation #end3. 高级定制技巧3.1 动态注解配置通过在generator.config表中添加配置项可以实现注解的动态开关INSERT INTO gen_config (id, author, package_name, auto_remove_pre, module_name, lombok_annotations) VALUES (1, your_name, com.xxx, 1, system, Data,NoArgsConstructor,AllArgsConstructor,Builder);然后在模板中解析#set($annotations $config.lombokAnnotations.split(,)) #foreach ($anno in $annotations) ${anno.trim()} #end3.2 字段级别的Lombok控制某些场景下需要更细粒度的控制比如忽略特定字段的toString#foreach ($column in $columns) ToString.Exclude private $column.attrType $column.attrname; #end3.3 模板版本化管理建议将修改后的模板文件纳入版本控制并建立变更日志templates/ ├── java/ │ ├── domain.java.vm │ └── changelog.md └── resources/ └── mapper.xml.vm4. 全链路代码生成规范Domain模板的改造只是起点完整的代码生成规范还应考虑4.1 Service层优化在Service模板中可以利用Lombok的RequiredArgsConstructor实现依赖注入Service RequiredArgsConstructor public class ${ClassName}ServiceImpl implements ${ClassName}Service { private final ${ClassName}Mapper mapper; // 无需显式编写构造器 }4.2 Mapper层增强结合MyBatis 3的动态SQL特性可以优化Mapper模板update idupdateSelective UPDATE ${tableName} set #foreach ($column in $columns) if test$column.attrname ! null$column.columnName #{$column.attrname},/if #end /set WHERE ${primaryKey.columnName} #{${primaryKey.attrname}} /update4.3 前后端一致性在Vue模板中同步字段命名规范// 将Java的驼峰命名转为前端偏好格式 function toFrontendName(name) { return name.replace(/([A-Z])/g, -$1).toLowerCase() }经过这些定制化改造后若依代码生成器将产出风格统一、符合现代Java开发实践的代码结构。某金融项目采用这套规范后实体类代码量减少65%团队在CRUD开发环节的效率提升了40%。更重要的是这种规范化的生成结果使得代码审查更加聚焦业务逻辑而非样式问题。