Skip to content

代码生成闭环 ​

一句话:从数据库读表 → CodegenBuilder 把表结构翻译成带默认值的「代码生成模型」 → CodegenEngine 选模板、算路径、Velocity 渲染 → 预览或打包下载;生成物不直接写进工程,落盘是人工的一次拷贝。

适用场景:加新表后生成 CRUD;改表结构后用「同步」增量更新;自定义前端模板套数。

不适用场景:复杂业务逻辑的骨架(生成的是标准 CRUD,业务方法要自己补);已有手写代码的逆向工程(同步只更新字段级元数据,不合并业务代码)。

1. 闭环六步 ​

text
① 选表导入  →  ② Builder 组装模型  →  ③ Engine 选模板
      ↑                                        ↓
⑥ 同步表结构  ←  ⑤ 人工落盘  ←  ④ 预览 / 下载 zip
步骤入口关键代码
① 导入POST /infra/codegen/create-listCodegenServiceImpl#createCodegenList(#L68-L75)逐表 createCodegen
② 组装自动CodegenBuilder#buildTable(#L100-L104)+ buildColumns(#L126-L143)
③ 渲染自动CodegenEngine#execute(#L374-L409)
④ 预览GET /infra/codegen/previewCodegenController#L135-L141
④ 下载GET /infra/codegen/downloadCodegenController#L143-L158,ZipUtil.zip 后 writeAttachment("codegen.zip")
⑥ 同步PUT /infra/codegen/sync-from-dbCodegenServiceImpl#syncCodegenFromDB(#L155-L167)→ syncCodegen0(#L169-L215)

权限点分别是 infra:codegen:query/create/update/delete/preview/download(CodegenController#L56、#L137、#L146)。

2. 导入:读表 + 校验 + 落元数据 ​

createCodegen0(#L84-L109):

  1. databaseTableService.getTable(dataSourceConfigId, tableName) 读 JDBC 元数据(#L79);
  2. validateTableInfo(#L111-L127)四项硬校验:表存在、表有注释、有字段、每个字段有注释。缺一个就抛 CODEGEN_IMPORT_TABLE_NULL / CODEGEN_TABLE_INFO_TABLE_COMMENT_IS_NULL / CODEGEN_IMPORT_COLUMNS_NULL / CODEGEN_TABLE_INFO_COLUMN_COMMENT_IS_NULL;
  3. 同名表已导入抛 CODEGEN_TABLE_EXISTS(#L88-L91);
  4. codegenBuilder.buildTable(tableInfo)(#L94);
  5. 固定 scene=ADMIN(#L96),frontType 取配置默认值(#L97);
  6. 插 codegen_table,再 buildColumns 插 codegen_column(#L102-L107);
  7. 没有主键时把第一个字段当主键(#L104-L106)——这是很多「生成出来不能编辑」的根源,导入前请给表加主键。

字段注释不是可选项:Builder 用注释生成 classComment、fieldComment、example,缺注释生成物里全是占位文本。

3. Builder:给表结构补「人话」默认值 ​

CodegenBuilder 是纯函数式翻译,不碰数据库:

表级(initTableDefault,#L111-L124):

推导规则行
moduleName表名第一个 _ 之前,小写#L116
businessName第一个 _ 之后转驼峰,首字母小写#L118
className同上,首字母大写#L120
classComment表注释去掉结尾的「表」字#L122
templateType默认 ONE#L123

列级(processColumnOperation / processColumnUI,#L145-L183):

输入特征结果
字段名以 name 结尾 / 含 time、date 的查询条件LIKE / BETWEEN(#L38-L43)
字段名 status、sex单选框 RADIO
字段名 type下拉 SELECT
字段名 image / file图片上传 / 文件上传
字段名 content、description、demo富文本 EDITOR
时间类型 LocalDateTime日期时间选择(#L176-L178)
布尔类型RADIO(#L172-L174)
其它文本框 INPUT(#L180-L182)

另外 Byte 会转成 Integer(#L133-L136),避免前端拿到 byte 类型;BASE_DO_FIELDS(#L88-L98)把 BaseDO 的审计字段与 tenantId 从新增/修改表单里排除,但列表查询保留 createTime(#L95、#L97)——所以生成的新增表单不会让你填创建时间。

4. 模板:10 种前端类型,7 个模板目录 ​

resources/codegen/ 顶层 9 个目录:java、sql 与 7 个前端目录。前端「套数」与目录不是一一对应:vben5 的三个目录各含 general 与 schema 两套,所以 7 个目录对应 10 个 CodegenFrontTypeEnum 取值。

目录模板数(.vm)对应 frontType
vue/8VUE2_ELEMENT_UI(10)
vue3/9VUE3_ELEMENT_PLUS(20)
vue3_admin_uniapp/5VUE3_ADMIN_UNIAPP_WOT(60)
vue3_vben/4VUE3_VBEN2_ANTD_SCHEMA(30)
vue3_vben5_antd/19(general 9 + schema 10)VUE3_VBEN5_ANTD_SCHEMA(40) / VUE3_VBEN5_ANTD_GENERAL(41)
vue3_vben5_antdv_next/19(general 9 + schema 10)VUE3_VBEN5_ANTDV_NEXT_SCHEMA(42) / ..._GENERAL(43)
vue3_vben5_ele/19(general 9 + schema 10)VUE3_VBEN5_EP_SCHEMA(50) / VUE3_VBEN5_EP_GENERAL(51)

schema 比 general 多一个 views/data.ts.vm(列定义),所以是 10 对 9。

模板路径里的 _sub 是「主子表专属」的开关:isSubTemplate 只要路径含 _sub 就走子表渲染(#L733-L735),单表模式下 5 个 form_sub_*/list_sub_* 组件根本不会生成。

java/ 有 16 个 .vm:controller、6 个 VO、DO(主子表额外 do_sub)、mapper 与 mapper.xml(主子表额外 mapper_sub)、service/serviceImpl、errorcode、serviceTest;sql/ 有 sql.vm 与 h2.vm。

模板在 CodegenEngine 里分成两张表:

  • SERVER_TEMPLATES(有序 Map,#L69-L99):模板路径 → 生成路径。errorcode.vm 的输出文件名故意叫 ErrorCodeConstants_手动操作(#L95),提醒你要手动合并错误码,不是覆盖。
  • FRONT_TEMPLATES(Guava Table<frontType, 模板路径, 生成路径>,#L108-L284):同一模板路径在不同 frontType 下可以生成到不同位置。

getTemplates(#L578-L601)在两张表基础上做裁剪:

条件效果
cloudEnable=false去掉 api/server 模块路径段(#L583-L589)
unitTestEnable=false去掉 serviceTest 与 h2.sql(#L591-L594)
voType != VO去掉 respVO 与 saveReqVO(#L596-L599)
importEnable != TRUE跳过导入模板(#L399-L403)
树表跳过 pageReqVO(#L389-L393)
非树表跳过 listReqVO(#L394-L398)

当前 application.yaml#L303-L310 的默认值:front-type: 20(Vue3 Element Plus)、vo-type: 10、delete-batch-enable: true、unit-test-enable: false、import-enable: false。按这套默认值,一张 ONE 类型、非树、无导入的表实际生成 10 个 Java 文件 + 1 个 SQL + 3 个前端文件。

5. 渲染:绑定变量 → 算路径 → Velocity ​

execute(dbType, table, columns, subTables, subColumnsList)(#L374-L409):

  1. initBindingMap:把 table/columns 以及各种派生变量塞进 Velocity Context;
  2. getTemplates(table.getFrontType()) 拿到本次要渲染的模板集合;
  3. 按顺序遍历:子表模板走 generateSubCode(#L385-L387),其余走 generateCode(#L406);
  4. generateCode(#L411-L418):formatFilePath 算输出路径 → templateEngine.getTemplate(vmPath).render(bindingMap) → prettyCode 格式化 → 放进 LinkedHashMap。

initGlobalBindingMap(#L329-L362)在 @PostConstruct 里只算一次全局变量:basePackage、baseFrameworkPackage、jakartaPackage(jakarta 或 javax,#L336)、BaseDOClassName、BaseMapperClassName、QueryWrapperClassName 等。所以改 pmforge.codegen.base-package 后要重启才会生效;测试里改完配置要手动再调一次 initGlobalBindingMap(CodegenEngineAbstractTest#L55-L56)。

路径占位符在 formatFilePath(#L604-L633):${basePackage}(点转斜杠)、${classNameVar}、${simpleClassName}、${sceneEnum.prefixClass}、${table.*},主子表还有 ${subTable.*} 与 ${subSimpleClassName}(含下划线形式)。

6. 生成物包含哪些文件 ​

以默认配置(Vue3 Element Plus、VO、无导入、无单测)为例:

层文件
Javacontroller/...Controller.java、vo/...PageReqVO.java、vo/...RespVO.java、dal/dataobject/...DO.java、dal/mysql/...Mapper.java、dal/mysql/...Mapper.xml、service/...Service.java、service/...ServiceImpl.java
SQLsql/sql.sql(建表语句)
前端api/api.ts、views/index.vue、views/form.vue(主子表额外 5 个 components)

主子表时还会多出 do_sub、mapper_sub 与子表组件;MASTER_ERP、MASTER_INNER 的区别只在生成的子表组件形态(erp/inner/normal)。

7. 如何新增一套前端模板 ​

  1. 在 resources/codegen/ 下新建目录(如 vue3_xxx/),放入 .vm,路径与现有模板保持一致(api/、views/、views/components/);
  2. 在 CodegenFrontTypeEnum 加一个取值(enums/codegen/CodegenFrontTypeEnum.java#L15-L30),注意 type 数值不要与已有冲突;
  3. 在 CodegenEngine.FRONT_TEMPLATES(#L108-L284)为每个模板加一行 put(frontType, "vue3_xxx/api/api.ts.vm", "src/api/...");
  4. 如需在生成器 UI 里可选,确认前端读取的是枚举列表而不是硬编码;
  5. 加测试:在 CodegenEngineAbstractTest 子类里 execute 一次,assertResult 会比对快照。

快照机制(CodegenEngineAbstractTest#L95-L115):先比对文件路径集合完全一致(#L103-L106),再逐文件比对内容;首次生成用 -Dcodegen.regenerate=true 写快照(#L93、#L97-L99)。比较前会 normalizeLineEndings(#L120-L126,\r\n → \n、去掉尾部换行),所以 Windows 上生成不会因为换行符假失败。

现有测试类:CodegenEngineVue3Test(one/tree/master_normal/master_erp/master_inner)、CodegenEngineVue2Test、CodegenEngineUniappTest、CodegenEngineVben5AntdSchemaTest、CodegenEngineVben5AntdGeneralTest、CodegenEngineVben5EleSchemaTest、CodegenEngineVben5EleGeneralTest。新增 frontType 至少要加一个对应的 testExecute_xxx,否则这条分支没有回归保护。

8. 排错清单 ​

症状先看判断依据
导入按钮报「表注释为空」CodegenServiceImpl#L111-L127表和字段都必须有注释,这是硬校验
生成的新增表单不能提交createCodegen0#L104-L106表没有主键,第一个字段被当主键
生成物缺文件getTemplates#L578-L601unitTestEnable、importEnable、voType、cloudEnable 任一开关都会裁剪模板
改了 base-package 没生效initGlobalBindingMap#L329-L362只在 @PostConstruct 算一次,改配置要重启
前端类型改了但页面没变CodegenTableSaveReqVO#L61frontType 存在表里,需重新 update 再 preview
同步报「没有变化」syncCodegen0#L205字段级元数据没差异,抛 CODEGEN_SYNC_NONE_CHANGE 属正常
下载的 zip 是空的#L150-L157generationCodes 返回空,通常是 frontType 在 FRONT_TEMPLATES 里没有行
快照测试全红但内容一样normalizeLineEndings#L120-L126换行已被归一;多半是路径集合多了/少了文件
生成的代码 import 的是 javaxinitGlobalBindingMap#L336jakartaEnable 由 JDK 版本与 jakarta.annotation.Resource 是否存在决定