Appearance
Menu 菜单模块
Menu 模块提供灵活的菜单管理能力,支持 12 个菜单位置槽位(PC/手机导航拆分)、树形菜单项、权限控制。是门户/官网/后台导航的基础设施。
模块信息
| 属性 | 值 |
|---|---|
| 名称 | menu |
| 类型 | 核心模块(基座内置) |
| 描述 | 菜单管理 -- 位置槽位/树形菜单项/PC手机拆分 |
| 版本 | v2.1.0 新增 |
核心概念
菜单位置(Menu Location)
菜单位置是菜单的"槽位",例如:头部导航、侧边栏、页脚等。系统预置 12 个位置槽位:
| 位置标识 | 说明 |
|---|---|
header_nav | PC 端头部导航 |
mobile_nav | 手机端底部导航 |
sidebar | 侧边栏菜单 |
footer_links | 页脚链接 |
user_menu | 用户中心菜单 |
admin_sidebar | 后台侧边栏 |
admin_topbar | 后台顶栏 |
portal_header | 门户头部导航 |
portal_footer | 门户页脚 |
portal_sidebar | 门户侧边栏 |
custom_1 ~ custom_2 | 自定义位置预留 |
菜单项(Menu Item)
菜单项是具体的菜单条目,支持树形结构(父子关系)、排序、图标、外链、权限控制。
| 字段 | 类型 | 说明 |
|---|---|---|
| LocationID | string | 所属位置 ID |
| ParentID | string | 父菜单项 ID(空=顶级) |
| Title | string(200) | 菜单标题 |
| URL | string(500) | 链接地址 |
| Icon | string(100) | 图标类名 |
| SortOrder | int | 排序权重 |
| IsExternal | bool | 是否外链 |
| IsVisible | bool | 是否可见 |
| Permission | string(100) | 权限标识(空=无需权限) |
数据模型
MenuLocation(菜单位置)
表名: menu_locations
| 字段 | 类型 | 说明 |
|---|---|---|
| (BaseEntity) | embedded | ID, TenantID, CreatedAt, UpdatedAt, DeletedAt |
| Name | string(100) | 位置标识(如 header_nav) |
| Title | string(200) | 显示名称(如"头部导航") |
| Description | text | 备注说明 |
| MaxItems | int | 最大菜单项数(0=不限) |
MenuItem(菜单项)
表名: menu_items
| 字段 | 类型 | 说明 |
|---|---|---|
| (BaseEntity) | embedded | ID, TenantID, CreatedAt, UpdatedAt, DeletedAt |
| LocationID | string | 所属位置 ID |
| ParentID | string | 父菜单项 ID |
| Title | string(200) | 菜单标题 |
| URL | string(500) | 链接地址 |
| Icon | string(100) | 图标类名 |
| SortOrder | int | 排序权重 |
| IsExternal | bool | 是否外链 |
| IsVisible | bool | 是否可见 |
| Permission | string(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_split | PC/手机导航拆分(header_nav + mobile_nav) |
使用示例
前台查询菜单
javascript
// Nuxt3 SSR 中查询头部导航
const { data } = await useFetch('/api/v1/menu/header_nav')
// 返回树形结构:[{ id, title, url, icon, children: [...] }]后台管理菜单
- 进入「系统管理 → 菜单管理」
- 选择菜单位置(如"头部导航")
- 添加/编辑/排序菜单项
- 设置权限(可选)
- 保存后前台即时生效
与其他模块关系
| 模块 | 关系 |
|---|---|
| rbac | 菜单项可绑定权限,无权限不显示 |
| portal | 门户前台导航依赖菜单模块 |
| website | 官网导航依赖菜单模块 |

