init: 初始化 hgmj 后台管理项目
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,56 @@
|
||||
---
|
||||
name: vue2-route-permission
|
||||
description: Use when adding or modifying route/menu/permission access in this Vue2 admin project, including module router files, permissionRouter aggregation, sidebar visibility, and route metadata consistency.
|
||||
disable-model-invocation: true
|
||||
---
|
||||
|
||||
# Vue2 Route Permission
|
||||
|
||||
## 适用场景
|
||||
|
||||
- 新增一个业务页面,需要接入菜单与路由
|
||||
- 新增一个模块路由文件并接入 `permissionRouter`
|
||||
- 调整页面可见性、菜单结构、入口名称
|
||||
- 排查“路由已写但菜单不显示 / 可见但不可访问”问题
|
||||
|
||||
## 本项目路由结构认知
|
||||
|
||||
- 模块路由拆分在 `src/router/*.js`(例如 `signin.js`)
|
||||
- 聚合路由在 `src/router/permissionRouter.js`
|
||||
- 侧边栏使用 `store.state.routerList` 渲染(见 `src/views/main/components/nav.vue`)
|
||||
|
||||
## 接入原则
|
||||
|
||||
- **单模块独立**:每个业务域维护自己的路由文件
|
||||
- **统一聚合出口**:模块路由必须在 `permissionRouter.js` 引入并加入数组
|
||||
- **元信息一致**:`title`、`meta.title`、`name`、`path` 保持语义一致
|
||||
- **层级清晰**:一级菜单挂在 `Main` 下,子页面在 `children`
|
||||
|
||||
## 新页面接入流程
|
||||
|
||||
1. 在 `src/views` 创建页面组件并命名清晰
|
||||
2. 在对应模块路由文件新增子路由(或新建模块路由文件)
|
||||
3. 设置基础字段:`path`、`name`、`title`、`meta.title`
|
||||
4. 需要缓存时补 `meta.keepAlive`
|
||||
5. 在 `permissionRouter.js` 引入并追加模块路由
|
||||
6. 验证菜单显示、点击跳转、激活状态、刷新后可访问
|
||||
|
||||
## 字段约定
|
||||
|
||||
- `path`:使用短横线风格,避免含糊缩写
|
||||
- `name`:驼峰命名,保持唯一
|
||||
- `title`:用于菜单与页面文案,避免同义不同字
|
||||
- `icon`:仅一级菜单使用,沿用 Element 图标
|
||||
- `meta.title`:与 `title` 保持一致,方便统一读取
|
||||
|
||||
## 常见问题处理
|
||||
|
||||
- **菜单不显示**:检查模块路由是否已加入 `permissionRouter` 聚合数组
|
||||
- **菜单显示但跳转异常**:检查 `path` 与组件导入是否正确
|
||||
- **激活态不正确**:检查路由跳转后 `activeRouter` 是否对应当前 `path`
|
||||
- **刷新丢失访问**:检查路由注册时机和权限数据初始化顺序
|
||||
|
||||
## 快速参考
|
||||
|
||||
- 接入示例:见 [examples.md](examples.md)
|
||||
- 自检清单:见 [checklist.md](checklist.md)
|
||||
@@ -0,0 +1,28 @@
|
||||
# Checklist
|
||||
|
||||
## 新增路由检查
|
||||
|
||||
- [ ] 页面组件已创建且导出正常
|
||||
- [ ] 模块路由文件中已添加对应子路由
|
||||
- [ ] 子路由包含 `path`、`name`、`title`、`meta.title`
|
||||
- [ ] `name` 唯一,`path` 可读且与业务语义一致
|
||||
|
||||
## 聚合与菜单检查
|
||||
|
||||
- [ ] 新模块路由已在 `permissionRouter.js` 引入
|
||||
- [ ] 已加入聚合数组并保持风格一致
|
||||
- [ ] 一级菜单 `title/icon` 设置合理
|
||||
- [ ] 侧边栏可见,点击可跳转
|
||||
|
||||
## 权限与体验检查
|
||||
|
||||
- [ ] 刷新页面后路由仍可访问
|
||||
- [ ] 无权限场景有明确反馈(如项目已有拦截逻辑)
|
||||
- [ ] 当前菜单激活态与页面路径一致
|
||||
- [ ] 页面标题与菜单文案一致
|
||||
|
||||
## 交付前检查
|
||||
|
||||
- [ ] 至少执行一次 `npm run lint` 或 `npm run test-build`
|
||||
- [ ] 无新增阻断报错
|
||||
- [ ] 仅提交与路由接入相关改动
|
||||
@@ -0,0 +1,65 @@
|
||||
# Examples
|
||||
|
||||
## 模块路由文件示例(`src/router/demo.js`)
|
||||
|
||||
```js
|
||||
import Main from "../views/main";
|
||||
import DemoList from "../views/demo/list";
|
||||
import DemoConfig from "../views/demo/config";
|
||||
|
||||
const DemoRouter = {
|
||||
path: "/demo",
|
||||
component: Main,
|
||||
title: "示例管理",
|
||||
icon: "el-icon-menu",
|
||||
meta: {
|
||||
keepAlive: true
|
||||
},
|
||||
children: [
|
||||
{
|
||||
path: "/demo-list",
|
||||
component: DemoList,
|
||||
name: "demoList",
|
||||
title: "示例列表",
|
||||
meta: {
|
||||
title: "示例列表",
|
||||
keepAlive: true
|
||||
}
|
||||
},
|
||||
{
|
||||
path: "/demo-config",
|
||||
component: DemoConfig,
|
||||
name: "demoConfig",
|
||||
title: "示例配置",
|
||||
meta: {
|
||||
title: "示例配置",
|
||||
keepAlive: true
|
||||
}
|
||||
}
|
||||
]
|
||||
};
|
||||
|
||||
export default DemoRouter;
|
||||
```
|
||||
|
||||
## 聚合接入示例(`src/router/permissionRouter.js`)
|
||||
|
||||
```js
|
||||
import DemoRouter from "./demo";
|
||||
|
||||
const authRouter = [
|
||||
// ...existing routers
|
||||
DemoRouter
|
||||
];
|
||||
|
||||
export default authRouter;
|
||||
```
|
||||
|
||||
## 路由排查最小步骤
|
||||
|
||||
```js
|
||||
// 1. 看 router 文件是否 export default
|
||||
// 2. 看 permissionRouter 是否 import + push
|
||||
// 3. 看 path/name/title/meta.title 是否齐全
|
||||
// 4. 看页面组件路径是否正确
|
||||
```
|
||||
Reference in New Issue
Block a user