菜单管理
菜单是 Erupt 权限体系的最小单位。它不只是左侧导航:一个 Erupt 类、一个外部链接、一个自定义页面、一个按钮、一个接口,都以「菜单」的形式登记,然后在角色管理中勾选授权。
自动生成
引入模块时,各模块通过 initMenus() 声明自己的菜单,启动时自动写入数据库并在定义变化后持续对齐(受 erupt.init-modules-menu 控制,默认开启,见参数配置与下文模块菜单的自动维护)。对于类型为表格 / 树的菜单,Erupt 会根据 @Erupt(power) 自动生成下级功能按钮菜单:新增、修改、删除、查看详情、导出、导入。角色勾选了哪些按钮,用户界面上就只出现哪些按钮,后端接口同样按此校验。
自己的业务模型也可以在代码里声明菜单,而不必手工录入,见 插件开发 EruptModule。
模块菜单的自动维护
2.4.0+
2.4.0 之前,模块菜单只在首次启动时写入一次,依据是 .erupt/<module>.loaded 标记文件——容器重建后文件丢失,集群各节点各持一份,升级后新增的菜单也进不了库。现在由 EruptMenuSeeder 在每次启动时把菜单表与各模块的 initMenus() 对齐,状态记录在数据库表 e_upms_module 中,所有实例共享:
| 列 | 说明 |
|---|---|
module | 模块名,唯一 |
fingerprint | 模块菜单定义(含自动生成的功能按钮)的 SHA-256 指纹 |
snapshot | 上次写入时每个菜单的各字段值(JSON) |
erupt_version / seeded_at | 最后一次写入的 erupt 版本与时间 |
enabled | 在模块中心被关闭后为 false |
payload | 模块按库保存的小段数据(如遥测实例 ID) |
对齐规则:
- 指纹一致则跳过:定义没变的模块只多一次查询,什么都不写。
- 逐字段三方合并:定义变了的模块,对每个菜单的名称、类型、值、排序、图标、状态、上级逐字段比较——字段仍等于模块上次写入的值,说明没人动过,采用新定义;管理员改过的字段保留。库里没有的菜单新建;定义未变而被管理员删除的菜单不会复活。
- 功能按钮也在定义内:
@Erupt(power)后来打开的开关,下次启动会补上对应按钮。 - 不再声明的菜单禁用而非删除:模块去掉的菜单(或模块在模块中心被关闭)状态改为禁用——退出导航树且不再授权(隐藏菜单仍会授权,所以不用隐藏);再次声明即恢复打开。多个模块共同声明的菜单(如「系统管理」目录)不会因其中一个停止声明而被禁用。
- 并发启动安全:多个实例同时启动时在模块行上加锁串行执行,不会重复插入。
initFun()每个数据库只执行一次,在该模块首次写入菜单之前;2.4.0 之前的安装靠原有.erupt/<module>.loaded文件判定已初始化(仅当库中已有用户时才采信,避免把空库误判为已初始化)。
同一张表还承担两项按库记录的一次性状态:默认管理员账号 erupt / erupt 只在每个数据库首次初始化时创建一次(以前标记文件丢失后,只要库里没有管理员就会重新放回这个众所周知的密码),以及遥测实例 ID 不再随容器变化。
erupt.init-modules-menu
erupt.init-method-enum 已移除,由 erupt.init-modules-menu: true | false 替代。设为 false 的场景:数据库账号只读、菜单由脚本维护、多个应用共用一个库时只让其中一个负责写入。关闭后 initFun() 也不会执行。
根菜单排序区间
各模块的根菜单按用途落在固定区间内,侧栏据此按模块分组显示小标题(平台菜单与用户自建菜单不加标题,排在哪个区间里就归入哪组)。自己声明根菜单时按同样的区间取值即可:
| 分组 | 排序区间 | 内置模块示例 |
|---|---|---|
平台 PLATFORM | 0 ~ 20 | 首页 0、系统管理 10 |
业务 BUSINESS | 30 ~ 80 | 报表 30、消息通知 60、打印 70 |
AI AI | 100 ~ 150 | AI 管理 100、知识库 120、AI 员工 130、AI 决策 140、AI Dev 150 |
开发工具 DEV_TOOLS | 200 ~ 240 | 模型图谱 230、配置中心 240 |
运维 OPS | 300 ~ 340 | 系统监控 300、任务调度 310、远程桌面 330、微节点管理 340 |
需要紧跟某个兄弟菜单放置时,用 MetaMenu.after(code) 代替硬编码排序值,见插件开发。
模块中心
2.4.0+
系统管理 → 模块中心(路由 /module-center,菜单编码 $modules)把已安装的模块按分组列成卡片:平台 / 业务 / AI / 开发工具 / 运维 / 数据源 / 其他,每张卡片显示模块名、一句话说明、文档链接(跳转 docs.erupt.xyz,按当前界面语言选择中英文)、声明的菜单数,以及一个开关。
- 关闭模块:把该模块单独声明的菜单置为禁用(与其他模块共用的菜单保留),菜单缓存立即刷新,侧栏随之更新;状态写入
e_upms_module.enabled,重启后保持关闭,启动时跳过该模块。 - 重新打开:按当前定义重新对齐菜单,
initFun()不会再执行一次。 - erupt-upms 不能关闭(卡片标为「核心模块」)——关掉它就连模块中心自己的菜单也没了。
- 不声明菜单的模块(如数据连接器)没有开关,只作展示。
- 分组、说明与文档链接来自各模块
ModuleInfo的group/description/docs,未填分组的模块列在「其他」,见插件开发。
页面接口 GET /erupt-api/modules 与 POST /erupt-api/modules/{name}/enabled?value=true|false 均按「模块中心」菜单权限校验。
菜单类型
| 菜单类型 | 类型值 | 说明 |
|---|---|---|
| 表格 | Erupt 类名(不区分大小写) | 表格视图展示 |
| 树 | Erupt 类名(不区分大小写) | 树视图展示 |
| 表单 | Erupt 类名(不区分大小写) | 直接以表单视图打开 |
| 链接 | 互联网地址 | 在菜单容器(iframe)中打开 |
| 微前端链接 | 互联网地址 | 在微前端容器中打开(2.2.0+),适用于目标站点用 X-Frame-Options / frame-ancestors 拒绝被 iframe 嵌入、但允许跨域读取的场景 |
| 新页签 | 互联网地址 | 在新 Tab 页中打开 |
| 当前窗口 | 互联网地址 | 在当前窗口整页跳转 |
| 页面路由 | 路由地址 | 前端路由 hash 值 |
| 充满屏幕 | 路由地址 | 隐藏导航与侧栏,全屏展示页面 |
| 按钮 | 权限字符串 | 控制按钮的显示与隐藏,不出现在导航中 |
| 接口名称 | 接口名 | 接口权限字符串,配合 @EruptMenuAuth 使用 |
| 报表 | 报表编码 | 需引入 erupt-report 模块 |
| 模板 | 模板文件名(在 tpl 目录下) | 需引入 erupt-tpl 模块 |
链接 vs 微前端链接
「微前端链接」和「链接」都用来嵌入外部站点,类型值填完整 URL,区别在于对方站点需要满足的条件不同。
微前端方式不受对方 X-Frame-Options 和 frame-ancestors 的限制,因为远端页面从未作为 frame 被导航,是宿主 fetch 回来的。代价是对方必须允许跨域读取——HTML 和每一个静态资源都要带上放行你后台域名的 CORS 响应头。
如果改用「链接」(iframe 方式),则相反:不需要 CORS,但只要对方响应头里有下面任意一条,浏览器就会拒绝,页面显示为空白或裂开的文档图标:
X-Frame-Options: DENY
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: frame-ancestors 'none'这是对方服务端的策略,前端无法绕过,只能请对方把 frame-ancestors 放开到你的后台域名。
字段说明
| 字段 | 说明 |
|---|---|
| 名称 | 导航中显示的文字,支持 i18n |
| 状态 | 打开 / 隐藏 / 禁用。隐藏的菜单不出现在导航中,但权限仍然有效,适合只通过链接进入的页面 |
| 上级菜单 | 支持任意层级,导航默认展开一级 |
| 排序 | 数值越小越靠前 |
| 图标 | 使用 Font Awesome 图标类名,如 fa fa-users,图标参考:https://www.thinkcmf.com/font/search/index.html |
| 编码 | 唯一标识,自动生成后只读,模块菜单的自动维护依据此值识别同一个菜单 |
| 自定义参数 | 传给页面的附加参数,TPL 页面与前端可读取 |
按菜单控制界面元素
菜单值也可以作为业务代码中的开关。ViaMenuValueCtrl 实现了 ExprBool.ExprHandler,用于按「当前用户是否拥有某菜单」控制字段、按钮是否显示:
@RowOperation(
title = "审核",
show = @ExprBool(exprHandler = ViaMenuValueCtrl.class, params = "audit_btn"),
operationHandler = AuditHandler.class
)params 即菜单的类型值。只需再建一个类型为「按钮」、值为 audit_btn 的菜单,授予哪些角色,哪些人就能看到这个按钮。
菜单权限在登录时加载并缓存,修改菜单或角色后用户需重新登录或点击导航栏刷新按钮生效。