Skip to content

Menu 菜单模块 ​

Menu 模块提供灵活的菜单管理能力,支持 12 个菜单位置槽位(PC/手机导航拆分)、树形菜单项、权限控制。是门户/官网/后台导航的基础设施。

模块信息 ​

属性值
名称menu
类型核心模块(基座内置)
描述菜单管理 -- 位置槽位/树形菜单项/PC手机拆分
版本v2.1.0 新增

核心概念 ​

菜单位置(Menu Location) ​

菜单位置是菜单的"槽位",例如:头部导航、侧边栏、页脚等。系统预置 12 个位置槽位:

位置标识说明
header_navPC 端头部导航
mobile_nav手机端底部导航
sidebar侧边栏菜单
footer_links页脚链接
user_menu用户中心菜单
admin_sidebar后台侧边栏
admin_topbar后台顶栏
portal_header门户头部导航
portal_footer门户页脚
portal_sidebar门户侧边栏
custom_1 ~ custom_2自定义位置预留

菜单项(Menu Item) ​

菜单项是具体的菜单条目,支持树形结构(父子关系)、排序、图标、外链、权限控制。

字段类型说明
LocationIDstring所属位置 ID
ParentIDstring父菜单项 ID(空=顶级)
Titlestring(200)菜单标题
URLstring(500)链接地址
Iconstring(100)图标类名
SortOrderint排序权重
IsExternalbool是否外链
IsVisiblebool是否可见
Permissionstring(100)权限标识(空=无需权限)

数据模型 ​

表名: menu_locations

字段类型说明
(BaseEntity)embeddedID, TenantID, CreatedAt, UpdatedAt, DeletedAt
Namestring(100)位置标识(如 header_nav)
Titlestring(200)显示名称(如"头部导航")
Descriptiontext备注说明
MaxItemsint最大菜单项数(0=不限)

表名: menu_items

字段类型说明
(BaseEntity)embeddedID, TenantID, CreatedAt, UpdatedAt, DeletedAt
LocationIDstring所属位置 ID
ParentIDstring父菜单项 ID
Titlestring(200)菜单标题
URLstring(500)链接地址
Iconstring(100)图标类名
SortOrderint排序权重
IsExternalbool是否外链
IsVisiblebool是否可见
Permissionstring(100)权限标识

API 端点 ​

位置管理 ​

GET    /api/v1/menu-locations       # 位置列表
POST   /api/v1/menu-locations       # 创建位置
GET    /api/v1/menu-locations/:id   # 位置详情
PUT    /api/v1/menu-locations/:id   # 更新位置
DELETE /api/v1/menu-locations/:id   # 删除位置

菜单项管理 ​

GET    /api/v1/menu-locations/:locationId/items      # 菜单项列表(树形)
POST   /api/v1/menu-locations/:locationId/items      # 创建菜单项
GET    /api/v1/menu-items/:id                        # 菜单项详情
PUT    /api/v1/menu-items/:id                        # 更新菜单项
DELETE /api/v1/menu-items/:id                        # 删除菜单项
PUT    /api/v1/menu-items/:id/sort                   # 调整排序

公开查询(前台使用) ​

GET /api/v1/menu/:locationName  # 按位置名查询菜单(如 header_nav)

权限点 ​

权限说明
menu.location.read查看菜单位置
menu.location.write管理菜单位置
menu.item.read查看菜单项
menu.item.write管理菜单项

迁移历史 ​

迁移编号说明
000012_menu_core菜单核心表(menu_locations + menu_items)
000013_menu_locations预置 12 个位置槽位种子数据
000014_menu_nav_splitPC/手机导航拆分(header_nav + mobile_nav)

使用示例 ​

前台查询菜单 ​

javascript
// Nuxt3 SSR 中查询头部导航
const { data } = await useFetch('/api/v1/menu/header_nav')
// 返回树形结构:[{ id, title, url, icon, children: [...] }]

后台管理菜单 ​

  1. 进入「系统管理 → 菜单管理」
  2. 选择菜单位置(如"头部导航")
  3. 添加/编辑/排序菜单项
  4. 设置权限(可选)
  5. 保存后前台即时生效

与其他模块关系 ​

模块关系
rbac菜单项可绑定权限,无权限不显示
portal门户前台导航依赖菜单模块
website官网导航依赖菜单模块

Released under the Apache 2.0 License.