超越CRUD用人人开源的代码生成器定制你的专属业务模块当后台管理系统的基础框架搭建完成后开发者往往会遇到一个共同痛点标准生成的CRUD代码难以满足复杂业务场景的需求。人人开源的代码生成器renren-generator提供了从数据库表到前后端代码的一键生成能力但真正的价值在于它的高度可定制性。本文将带你深入探索如何改造这个工具使其成为贴合你业务需求的专属代码工厂。1. 理解生成器的核心机制renren-generator的本质是一个基于Velocity模板引擎的代码工厂。它的工作流程可以简化为读取数据库元数据 → 应用模板规则 → 输出代码文件。要定制生成器关键在于掌握两个核心部分配置文件位于src/main/resources目录下的generator.properties和application.yml控制数据库连接、包路径等基础设置模板文件.vm后缀的Velocity模板决定最终生成的代码结构和内容一个典型的模板文件结构如下renren-generator ├── src/main/resources │ ├── template │ │ ├── Controller.java.vm │ │ ├── Entity.java.vm │ │ ├── Mapper.java.vm │ │ ├── Mapper.xml.vm │ │ ├── Service.java.vm │ │ ├── ServiceImpl.java.vm │ │ └── vue │ │ ├── api.js.vm │ │ └── index.vue.vm │ ├── application.yml │ └── generator.properties2. 定制化数据库映射规则大多数企业都有自己的数据库设计规范与默认生成规则可能存在冲突。以下是几个常见的定制场景2.1 表名前缀处理假设公司规定所有业务表以biz_开头但生成实体类时需要去掉这个前缀。修改Entity.java.vm模板#set($tableName $tableInfo.name.replaceFirst(biz_, )) #set($entityName $tableTool.convertToCamelCase($tableName)) public class ${entityName}Entity implements Serializable { // 字段生成逻辑保持不变 }2.2 字段类型特殊处理对于数据库中的特殊字段类型可以添加自定义类型转换规则。在模板中加入如下判断#foreach($column in $tableInfo.fullColumn) #if($column.type.equals(tinyint(1))) private Boolean ${column.name}; #elseif($column.type.contains(datetime)) private LocalDateTime ${column.name}; #else private ${column.shortType} ${column.name}; #end #end2.3 逻辑删除集成MyBatis-Plus的TableLogic注解可以方便地实现逻辑删除。修改实体类模板#foreach($column in $tableInfo.fullColumn) #if($column.name.equals(is_deleted)) TableLogic private Integer ${column.name}; #else private ${column.shortType} ${column.name}; #end #end3. 增强前端组件功能默认生成的Vue组件往往只包含基础CRUD功能我们可以通过修改模板增加高级特性。3.1 复杂查询表单在index.vue.vm模板中增加高级查询区域template div classfilter-container el-form :inlinetrue submit.native.preventhandleFilter !-- 基础查询字段 -- el-form-item label名称 el-input v-modellistQuery.name placeholder名称 / /el-form-item !-- 日期范围查询 -- el-form-item label创建时间 el-date-picker v-modeldateRange typedaterange range-separator至 start-placeholder开始日期 end-placeholder结束日期 /el-date-picker /el-form-item el-form-item el-button typeprimary clickhandleFilter查询/el-button el-button clickresetQuery重置/el-button /el-form-item /el-form /div /template3.2 表格列自定义增强表格的展示功能添加状态标签、操作按钮等el-table-column label状态 aligncenter template slot-scopescope el-tag :typescope.row.status | statusFilter {{ scope.row.status | statusNameFilter }} /el-tag /template /el-table-column el-table-column label操作 aligncenter template slot-scopescope el-button sizemini clickhandleDetail(scope.row)详情/el-button el-button sizemini typeprimary clickhandleEdit(scope.row)编辑/el-button el-button sizemini typedanger clickhandleDelete(scope.row)删除/el-button /template /el-table-column4. 后端业务逻辑增强4.1 自定义校验规则在实体类模板中加入校验注解public class ${entityName}Entity implements Serializable { NotBlank(message 名称不能为空) Size(max 50, message 名称长度不能超过50个字符) private String name; Email(message 邮箱格式不正确) private String email; Pattern(regexp ^1[3-9]\\d{9}$, message 手机号格式不正确) private String mobile; }4.2 关联查询支持修改Mapper模板支持关联查询select idselectDetailById resultType${package}.modules.${moduleName}.entity.${entityName}Entity SELECT t.*, d.department_name FROM ${tableInfo.name} t LEFT JOIN department d ON t.department_id d.id WHERE t.id #{id} /select对应的Service模板中增加方法public ${entityName}Entity getDetailById(Long id) { return baseMapper.selectDetailById(id); }5. 微服务集成实践将生成的代码集成到现有微服务架构时需要注意以下关键点5.1 依赖管理建议创建一个公共模块存放共享依赖避免每个微服务重复引入。典型依赖配置dependencies !-- MyBatis-Plus -- dependency groupIdcom.baomidou/groupId artifactIdmybatis-plus-boot-starter/artifactId version3.5.1/version /dependency !-- 数据库相关 -- dependency groupIdmysql/groupId artifactIdmysql-connector-java/artifactId version8.0.28/version /dependency !-- 工具类 -- dependency groupIdorg.apache.commons/groupId artifactIdcommons-lang3/artifactId version3.12.0/version /dependency /dependencies5.2 权限控制调整如果系统不使用Shiro需要注释掉相关注解并替换为适合的权限控制方案// 替换前 //RequiresPermissions(system:user:list) // 替换后假设使用Spring Security PreAuthorize(hasAuthority(system:user:list)) public Result list(RequestParam MapString, Object params) { // 方法实现 }5.3 分布式事务处理在微服务环境下跨服务操作需要处理分布式事务。可以在Service模板中加入Seata支持GlobalTransactional public boolean updateWithTransaction(${entityName}Entity entity) { boolean updateResult updateById(entity); // 调用其他微服务 boolean rpcResult otherService.doSomething(entity.getId()); return updateResult rpcResult; }6. 高级定制技巧6.1 多数据源支持修改生成器配置使其能够识别多数据源配置spring: datasource: primary: url: jdbc:mysql://localhost:3306/db1 username: root password: 123456 secondary: url: jdbc:mysql://localhost:3306/db2 username: root password: 123456在模板中根据表前缀选择数据源DS(${tableInfo.name.startsWith(biz_) ? primary : secondary}) public interface ${entityName}Mapper extends BaseMapper${entityName}Entity { }6.2 生成单元测试扩展模板自动生成基础单元测试SpringBootTest public class ${entityName}ServiceTest { Autowired private ${entityName}Service ${tableTool.firstLowerCase($entityName)}Service; Test public void testGetById() { ${entityName}Entity entity ${tableTool.firstLowerCase($entityName)}Service.getById(1L); Assert.assertNotNull(entity); } }6.3 生成Swagger文档在Controller模板中加入API文档注解Api(tags ${tableInfo.comment}管理) RestController RequestMapping(/${moduleName}/${tableTool.convertToCamelCase($tableInfo.name)}) public class ${entityName}Controller { ApiOperation(分页查询) GetMapping(/page) public Result page(ApiParam(查询参数) PageParam param) { // 方法实现 } }7. 持续维护与更新定制后的生成器需要建立版本管理机制模板版本控制为每个业务线维护独立的模板分支变更日志记录每次模板修改的内容和影响回归测试修改模板后对典型表结构生成代码进行验证建议的目录结构generator-templates/ ├── ecommerce/ # 电商业务线模板 ├── crm/ # CRM业务线模板 ├── common/ # 公共模板 └── CHANGELOG.md # 变更记录在实际项目中我们通过定制renren-generator将重复性的CRUD开发时间缩短了70%同时保证了代码风格和质量的统一性。关键在于理解模板引擎的工作原理并根据团队的实际需求进行有针对性的改造。
