操作指南

星火赋能平台代码生成器使用指南:一键生成前后端代码与菜单权限

初版内容

本文正在按正式版本补充截图与参数,界面名称与数值以实际软件为准。

要点速览

星火赋能平台的代码生成器按数据表一键生成后端服务、Vue 3 前端页面和对应的菜单与按钮权限,重新编译刷新即可使用。建议把生成代码放进自己新建的应用层工程(引用平台核心层),不要直接改平台核心代码,这样平台升级时不会冲突。

这篇面向使用星火赋能平台做业务开发的后端和前端工程师。读完后你能把一张业务表生成为带菜单和权限的完整模块,并知道生成代码应该放在哪、哪些地方适合手工扩展。前置条件:已按快速入门在本机跑通后端与管理后台,并能用管理员账号登录。

生成前的工程准备 #

代码生成器解决的是“标准增删改查”这部分重复劳动,生成效果很大程度上取决于工程结构是否规范。

新建自己的应用层工程 #

平台推荐的开发方式是:每个应用系统单独创建一个应用层工程,引用平台核心层(Sepe.Net.Core),再由 Web 入口层引用这个新工程。

  • 平台自带的 Sepe.Net.Application 只是示例应用层,不建议把业务代码写进去;
  • 非必要不要修改平台工程名,方便后续随主仓库升级;
  • 多个应用系统可以放在同一个解决方案里,一个后台统一管理,按需切换引用的应用层。

这样做的好处是:平台核心层升级时,你的业务代码在独立工程里,合并冲突最少。

准备数据表或实体 #

生成器以数据表为输入。数据表可以先在数据库中建好,也可以按平台约定编写 SqlSugar 实体类,由平台启动时建表。几个约定值得提前确定:

事项建议
表名与字段命名统一风格(如统一前缀、统一大小写规则),生成的类名、接口名都来自这里
字段注释写清楚中文含义,通常会作为前端表单标签和列表列名
主键与公共字段与平台实体基类保持一致,便于自动填充创建人、创建时间等
是否区分租户多租户场景下业务实体应继承平台的租户实体基类,详见权限与多租户配置指南

配置字段与前端展示控件 #

在管理后台的代码生成功能中选择数据表后,需要逐个字段确认生成方式。

常见字段配置项 #

配置项含义注意事项
展示控件前端表单中该字段使用的控件,如输入框、数字框、下拉选择、日期选择等取值固定的字段优先用下拉 + 字典,字典在“字典管理”中维护
列表显示该字段是否出现在列表页长文本字段一般不放进列表
表单显示该字段是否出现在新增 / 编辑表单系统自动填充的字段(创建时间等)不要放进表单
查询条件是否作为查询项以及匹配方式只给常用字段开查询,查询项过多会拖慢页面和数据库
必填 / 校验是否必填及基本校验规则前端校验只是体验,后端仍要做数据校验

具体可选项以你所用版本管理后台界面为准。

在线表单构建器 #

如果某个页面的表单布局比较特殊,可以先用平台内置的在线构建器拖动表单元素生成 Vue 3 代码,再合并进生成的页面,比手写布局更快。

生成结果 #

执行生成后,平台会输出一个模块所需的三部分内容。

  1. 后端代码:实体、输入输出模型与服务类。平台基于 Furion 的动态 API,服务类即可直接对外暴露为接口,不需要单独写控制器。
  2. 前端代码:Vue 3 + Element Plus 的列表页、表单与接口调用封装。
  3. 菜单与按钮权限:在菜单管理中写入对应菜单,以及增、删、改、查等按钮权限标识。

重新编译、启动后端并刷新管理后台,新菜单就会出现。生成的接口同时会出现在接口文档中(Scalar:/sapi/,Knife4j:/kapi/index.html),可以直接调试。

生成之后:分配权限与二次开发 #

给角色分配新菜单 #

生成的菜单默认只有超级管理员能完整看到。需要到“角色管理”里给相应角色勾选新菜单及其按钮权限,普通用户重新登录后才能看到。

二次开发约定 #

  • 把定制逻辑写在生成代码之外或明确标记的位置:如果之后表结构变化需要重新生成,手工修改容易被覆盖。重新生成前先提交版本,再用对比工具合并。
  • 复杂查询优先考虑数据库视图:平台支持基于 SqlSugar 生成查询 SQL 并维护视图实体,比在服务里拼复杂 SQL 更好维护。
  • 导入导出与打印:平台集成 Magicodes.IE,支持 Excel 导入导出以及按 HTML 模板生成 PDF 报告,常见单据输出不需要从零开发。
  • 零代码接口:对只读或简单场景,平台适配了 APIJSON 协议,可以在不写后端代码的情况下由前端按协议查询。

随平台升级 #

平台核心层升级时,接口、服务、控制器采用合并模式,原则上不影响自建应用层。确需修改平台核心代码时,建议单独记录修改点,升级时逐条核对。

注意事项 #

  • 代码生成器生成的是起点,不是终点:权限校验、业务规则、数据校验仍需按业务补全;
  • 生产环境不要直接在线生成并部署,应在开发环境生成、评审、测试后再按正常发布流程上线;
  • 生成的菜单与按钮权限标识一旦被角色引用,修改标识时要同步调整角色授权。

遇到生成后菜单不出现、接口 404 等问题,可先查看本地部署与联调故障排查,或到技术社区提问。