夜雨聆风第5期：代码生成器、Excel、工作流：6.X 业务能力的新老对比
前几篇更多是在讲底座和公共能力，这一篇回到业务开发现场：新建一个 CRUD 模块、导出一批数据、发起一个流程、展示审批人、做一个左侧树筛选页面。
这些需求本身并不复杂，但在真实项目里经常消耗时间。原因不是业务难，而是每个页面、每个模块都要重复处理导出、状态字段、唯一校验、排序、流程跳转、用户详情、树组件这些细节。
6.X 这部分变化的主线，就是把常见业务动作沉淀到生成器、Builder API 和公共组件里。它不会替你设计业务，但能减少大量重复劳动，让新模块从一开始就更接近项目统一写法。
更新概览
frontendTypevm/{frontendType} | ||
ExcelUtil | ExcelBuilder | |
UserNameDisplay | ||
TreePanel |
1. 代码生成器：前端模板类型进入 GenTable
生成器这次不是简单加几个模板文件，而是把“生成什么前端、是否带导出、是否带状态、是否做唯一校验、是否支持排序”这些选择写进生成上下文。生成出来的代码更接近实际项目需要二次开发的样子。
6.X 新增字段
// ruoyi-modules/ruoyi-gen/src/main/java/org/dromara/gen/domain/GenTable.java/** * 前端模板类型，对应 vm 下的模板目录 */private String frontendType;生成选项也变多了
/** * 是否启用导出 */@TableField(exist = false)private Boolean enableExport;/** * 是否启用状态切换 */@TableField(exist = false)private Boolean enableStatus;/** * 状态字段 */@TableField(exist = false)private String statusField;/** * 是否启用组合唯一校验 */@TableField(exist = false)private Boolean enableUnique;/** * 组合唯一字段 */@TableField(exist = false)private List<String> uniqueFields;/** * 是否启用排序调整 */@TableField(exist = false)private Boolean enableSort;/** * 排序字段 */@TableField(exist = false)private String sortField;2. 代码生成器：模板上下文写入更多变量
6.X 模板上下文
// ruoyi-modules/ruoyi-gen/src/main/java/org/dromara/gen/util/TemplateEngineUtils.javacontext.put("tplCategory", genTable.getTplCategory());context.put("frontendType", resolveFrontendType(genTable.getFrontendType()));context.put("tableName", genTable.getTableName());context.put("functionName", StringUtils.isNotEmpty(functionName) ? functionName : "【请填写功能名称】");context.put("ClassName", genTable.getClassName());context.put("className", StringUtils.uncapitalize(genTable.getClassName()));context.put("moduleName", moduleName);context.put("BusinessName", StringUtils.capitalize(businessName));context.put("businessName", businessName);context.put("columns", genTable.getColumns());context.put("table", genTable);导出、状态、唯一校验、排序开关
String options = genTable.getOptions();Dict paramsObj = JsonUtils.parseMap(options);if (ObjectUtil.isNull(paramsObj)) { paramsObj = new Dict();}boolean enableExport = getBooleanOption(paramsObj, GenConstants.ENABLE_EXPORT, true);boolean enableStatus = getBooleanOption(paramsObj, GenConstants.ENABLE_STATUS, false);boolean enableUnique = getBooleanOption(paramsObj, GenConstants.ENABLE_UNIQUE, false);boolean enableSort = getBooleanOption(paramsObj, GenConstants.ENABLE_SORT, false);GenTableColumn statusColumn = getColumn(genTable, paramsObj.getStr(GenConstants.STATUS_FIELD));GenTableColumn sortColumn = getColumn(genTable, paramsObj.getStr(GenConstants.SORT_FIELD));List<GenTableColumn> uniqueColumns = getColumns(genTable, paramsObj.get(GenConstants.UNIQUE_FIELDS));context.put("enableExport", enableExport);context.put("enableStatus", enableStatus && ObjectUtil.isNotNull(statusColumn));context.put("statusColumn", statusColumn);context.put("statusField", ObjectUtil.isNotNull(statusColumn) ? statusColumn.getJavaField() : StringUtils.EMPTY);context.put("enableUnique", enableUnique && CollUtil.isNotEmpty(uniqueColumns));context.put("uniqueColumns", uniqueColumns);context.put("enableSort", enableSort && ObjectUtil.isNotNull(sortColumn));context.put("sortColumn", sortColumn);context.put("sortField", ObjectUtil.isNotNull(sortColumn) ? sortColumn.getJavaField() : StringUtils.EMPTY);3. 代码生成器：按 frontendType 动态取模板
兼容旧入口
publicstatic List<PathNamedTemplate> getTemplateList(String tplCategory, String dsName){return getTemplateList(tplCategory, dsName, GenConstants.FRONTEND_TYPE_VUE);}新入口：多前端模板
publicstatic List<PathNamedTemplate> getTemplateList(String tplCategory, String dsName, String frontendType){ List<PathNamedTemplate> templates = new ArrayList<>();// 后端源码模板 templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_DOMAIN_TEMPLATE_PATH)); templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_VO_TEMPLATE_PATH)); templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_BO_TEMPLATE_PATH)); templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_MAPPER_TEMPLATE_PATH)); templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_SERVICE_TEMPLATE_PATH)); templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_SERVICE_IMPL_TEMPLATE_PATH)); templates.add(TEMPLATE_MAPPER.get(GenConstants.JAVA_CONTROLLER_TEMPLATE_PATH));// 前端 API 与类型模板 templates.add(getTemplate(getFrontendApiTemplatePath(frontendType))); templates.add(getTemplate(getFrontendTypesTemplatePath(frontendType)));// 前端页面模板if (GenConstants.TPL_CRUD.equals(tplCategory)) { templates.add(getTemplate(getFrontendIndexTemplatePath(frontendType))); } elseif (GenConstants.TPL_TREE.equals(tplCategory)) { templates.add(getTemplate(getFrontendIndexTreeTemplatePath(frontendType))); }return templates;}动态加载 vm/{frontendType}
privatestatic PathNamedTemplate getTemplate(String templatePath){ PathNamedTemplate template = TEMPLATE_MAPPER.get(templatePath);if (ObjectUtil.isNotNull(template)) {return template; }return PathNamedTemplate.form(TEMPLATE_ENGINE, templatePath);}前端类型也同步到 TS
// plus-ui-new/src/api/tool/gen/types.tsexportinterface GenTableVO { tableComment: string; className: string; tplCategory: string; frontendType: string; enableExport?: boolean; enableStatus?: boolean; statusField?: string; enableUnique?: boolean;}4. Excel：ExcelUtil -> ExcelBuilder 链式导出
Excel 导入导出属于后台系统的高频能力。旧写法偏工具类调用，新版改成 ExcelBuilder 链式 API 后，普通导出、模板导出、多 Sheet、ZIP 分页导出可以放在同一套语义里理解。
普通导出
// ruoyi-modules/ruoyi-workflow/src/main/java/.../TestLeaveController.java@PostMapping("/export")publicvoidexport(TestLeaveBo bo, HttpServletResponse response){ List<TestLeaveVo> list = testLeaveService.queryList(bo); ExcelBuilder.of(list, TestLeaveVo.class) .sheetName("请假") .toResponse(response);}树表示例
@GetMapping("/export")publicvoidexport(@Validated TestTreeBo bo, HttpServletResponse response){ List<TestTreeVo> list = testTreeService.queryList(bo); ExcelBuilder.of(list, TestTreeVo.class) .sheetName("测试树表") .toResponse(response);}5. Excel：模板导出、多列表、多 Sheet
单列表模板
ExcelBuilder.template("excel/单列表.xlsx") .filename("单列表.xlsx") .data(CollUtil.newArrayList(map, list)) .toResponse(response);多列表模板
Map<String, Object> multiListMap = new HashMap<>();multiListMap.put("map", map);multiListMap.put("data1", list1);multiListMap.put("data2", list2);multiListMap.put("data3", list3);multiListMap.put("data4", list4);ExcelBuilder.template("excel/多列表.xlsx") .filename("多列表.xlsx") .multiList(multiListMap) .toResponse(response);多 Sheet 模板
List<Map<String, Object>> list = new ArrayList<>();list.add(sheetMap1);list.add(sheetMap2);list.add(sheetMap3);list.add(sheetMap4);ExcelBuilder.template("excel/多sheet列表.xlsx") .filename("多sheet列表") .multiSheet(list) .toResponse(response);6. Excel：导入读取也统一到 ExcelBuilder
@PostMapping(value = "/importWithOptions", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)public List<ExportDemoVo> importWithOptions(@RequestPart("file") MultipartFile file) throws Exception { ExcelResult<ExportDemoVo> excelResult = ExcelBuilder.read(file.getInputStream(), ExportDemoVo.class) .listener(newExportDemoListener()) .doRead();return excelResult.getList();}7. Excel：ZIP 分页导出能力
Builder API
public ExcelBuilder<T> zip(){return zip(DEFAULT_ZIP_PAGE_SIZE);}public ExcelBuilder<T> zip(int pageSize){if (pageSize <= 0) {thrownew IllegalArgumentException("pageSize 必须大于 0"); }this.zip = true;this.pageSize = pageSize;returnthis;}toResponse 自动判断 zip
publicvoidtoResponse(HttpServletResponse response){if (zip) { exportZipToResponse(response);return; }try { resetResponse(sheetName, response); ServletOutputStream os = response.getOutputStream(); writeSheet(os); } catch (IOException e) {thrownew RuntimeException("导出Excel异常", e); }}8. 工作流：保存并发起流程
前端 API
// src/api/workflow/leave/index.tsexportconst submitAndFlowStart = (data: LeaveForm): AxiosPromise<LeaveVO> => {return request({ url: '/workflow/leave/submitAndFlowStart', method: 'post', data: data });};页面调用
// src/views/workflow/leave/leaveEdit.vueif (mode && status != 'draft') {const res = await submitAndFlowStart(form.value).finally(() => (buttonLoading.value = false)); form.value = res.data; buttonLoading.value = false; modal.msgSuccess('操作成功'); tab.closePage(route); router.go(-1);} else {let res;if (form.value.id) { res = await updateLeave(form.value).finally(() => (buttonLoading.value = false)); } else { res = await addLeave(form.value).finally(() => (buttonLoading.value = false)); } form.value = res.data;if (status === 'draft') { modal.msgSuccess('暂存成功'); } else {await handleStartWorkFlow(res.data); }}后端接口
@SaCheckPermission("workflow:leave:add")@Log(title = "请假", businessType = BusinessType.INSERT)@RepeatSubmit()@PostMapping("/submitAndFlowStart")public R<TestLeaveVo> submitAndFlowStart(@Validated(AddGroup.class) @RequestBody TestLeaveBo bo) {return R.ok(testLeaveService.submitAndFlowStart(bo));}9. 工作流：发起流程变量和业务扩展
const handleStartWorkFlow = async (data: LeaveForm) => {try { submitFormData.value.flowCode = flowCode.value; submitFormData.value.businessId = data.id; taskVariables.value = { leaveDays: data.leaveDays, userList: ['1', '3', '4'] }; bizExt.value = { businessTitle: '请假申请', businessCode: data.applyCode }; submitFormData.value.variables = taskVariables.value; submitFormData.value.bizExt = bizExt.value;const resp = await startWorkFlow(submitFormData.value);if (submitVerifyRef.value) { buttonLoading.value = false; submitVerifyRef.value.openDialog(resp.data.taskId); } } finally { buttonLoading.value = false; }};10. 工作流：办理人展示组件化
页面使用
<el-table-column align="center" label="办理人" min-width="180"> <template #default="scope"> <UserNameDisplay :content="scope.row.assigneeNames" /> </template></el-table-column>组件实现
<template> <el-tooltip :disabled="!displayText" :content="displayText || emptyText" effect="dark" placement="top-start"> <div class="user-name-display" :style="{ '--user-name-max-lines': maxLines }"> {{ displayText || emptyText }} </div> </el-tooltip></template><script setup lang="ts">const props = withDefaults( defineProps<{ content?: string | null; emptyText?: string; maxLines?: number; }>(), { content: '', emptyText: '无', maxLines: 3 });const displayText = computed(() => props.content ?.split(',') .map(item => item.trim()) .filter(Boolean) .join('、') ?? '');</script>CSS 控制最多三行
.user-name-display { display: -webkit-box; overflow: hidden; width: 100%; line-height: 20px; max-height: calc(20px * var(--user-name-max-lines)); white-space: normal; word-break: break-all; -webkit-box-orient: vertical; -webkit-line-clamp: var(--user-name-max-lines);}11. 工作流：统一 routerJump
// src/api/workflow/workflowCommon/index.tsexportdefault { routerJump(routerJumpVo: RouterJumpVo) { tab.closePage(router.currentRoute.value); router.push({ path: routerJumpVo.formPath, query: { id: routerJumpVo.businessId,type: routerJumpVo.type, taskId: routerJumpVo.taskId } }); }};待办页调用
const handleOpen = async (row: Partial<FlowTaskVO>) => {const routerJumpVo = reactive<RouterJumpVo>({ businessId: row.businessId, taskId: row.id,type: 'approval', formCustom: row.formCustom, formPath: row.formPath }); workflowCommon.routerJump(routerJumpVo);};12. 系统管理：用户详情抽屉
页面结构
<el-drawer v-model="visible" title="用户信息详情" :size="680" append-to-body :close-on-click-modal="true" @closed="info = null"> <el-descriptions v-if="info" v-loading="loading" :column="2" border> <el-descriptions-item label="用户名称">{{ info.nickName }}</el-descriptions-item> <el-descriptions-item label="归属部门"> {{ info.deptName || (info.dept && info.dept.deptName) || '-' }} </el-descriptions-item> <el-descriptions-item label="手机号码">{{ info.phoneNumber || '-' }}</el-descriptions-item> <el-descriptions-item label="邮箱">{{ info.email || '-' }}</el-descriptions-item> <el-descriptions-item label="登录账号">{{ info.userName }}</el-descriptions-item> </el-descriptions></el-drawer>打开抽屉并加载数据
asyncfunctionopenDrawer(userId: string | number) { visible.value = true; loading.value = true;try {const { data } = await api.getUser(userId); info.value = data.user; postOptions.value = data.posts || []; roleOptions.value = data.roles || []; postIds.value = (data.postIds || []).map(String); roleIds.value = (data.roleIds || []).map(String); } catch (error) {console.error('获取用户信息失败:', error); } finally { loading.value = false; }}defineExpose({ openDrawer });13. 系统页面：TreePanel 抽成公共组件
组件使用场景
<TreePanel v-model:collapsed="treeCollapsed" title="部门列表" placeholder="请输入部门名称" :data="deptOptions" node-key="id" disabled-field="disabled" @node-click="handleNodeClick"/>组件核心结构
<el-card shadow="hover" class="side-panel tree-panel-shell" :class="{ 'is-collapsed': modelCollapsed }"> <template #header> <div class="panel-heading search-panel-toggle tree-panel-header" @click.stop="toggleCollapsed"> <div v-show="!modelCollapsed"> <h3>{{ title }}</h3> </div> </div> </template> <template v-if="!modelCollapsed"> <el-input v-model="filterText" :placeholder="placeholder" prefix-icon="Search" clearable /> <el-tree ref="treeRef" class="mt-2 dept-tree" :node-key="nodeKey" :data="data" :props="mergedTreeProps as any" :expand-on-click-node="false" :filter-node-method="internalFilterNode" highlight-current default-expand-all @node-click="onNodeClick" /> </template></el-card>禁用节点不允许点击
const isNodeDisabled = (data: any) => {if (!props.disabledField) {returnfalse; }returnBoolean(data?.[props.disabledField]);};const onNodeClick = (data: any, node: any, component: any) => {if (isNodeDisabled(data)) { treeRef.value?.setCurrentKey(undefined);return; } emit('node-click', data, node, component);};14. 写在最后：这些更新更像“真实项目增强”
代码生成器： 多前端模板 + 导出/状态/唯一/排序/树字段配置Excel： ExcelBuilder 链式 API + 模板 + 多列表 + 多 Sheet + ZIP工作流： 保存并发起流程 + 统一跳转 + 办理人展示组件系统页面： 用户详情抽屉 + TreePanel + 页面 hooks从新老对比看，6.X 更重视把业务开发里的重复动作产品化：生成器不只是生成基础 CRUD，Excel 不只是导出列表，工作流页面也不只是拼接口和路由。新版把这些常见动作沉淀成模板、Builder 和组件，让业务代码更接近统一范式。
