162 lines
6.3 KiB
TypeScript
162 lines
6.3 KiB
TypeScript
/**
|
||
* 静态路由表(PAGE_REGISTRY)
|
||
*
|
||
* 为什么需要它:`pages.json` 只服务于**编译**(微信只认 pages / style / subPackages / tabBar),
|
||
* 运行时代码里**读不出来**。而后端 `user.info` 下发的菜单只给**逻辑路径**
|
||
* (`wms_permission.path`,形如 `/inbound/list`),前端必须持有一份
|
||
* 「逻辑路径 → 物理页面」的运行时映射,才能渲染入口并跳转。
|
||
*
|
||
* 三条约定(务必遵守):
|
||
* 1. `key` = 逻辑路径,**必须与后端 `wms_permission.path`(type='miniprogram_pages')一致**
|
||
* 2. `path` = 物理页面路径,**必须与 `pages.json` 完全一致**(页面挪分包 / 改目录名只改这一处)
|
||
* 3. **只登记真实存在的页面** —— 登记了 `pages.json` 里没有的页面,用户点进去必然失败
|
||
* (用 `npm run check:pages` 校验 1/2/3 是否成立)
|
||
*
|
||
* 与 new3 的 `router/map.ts`(`componentMap`)是同一个思想:
|
||
* **后端只给逻辑标识,前端持有「标识 → 真实页面」的映射**。
|
||
*
|
||
* 详见《页面渲染框架-设计与任务清单.md》§3.2
|
||
*/
|
||
|
||
/** 页面登录策略 —— 见设计文档 §3.4 */
|
||
export type AuthMode = 'public' | 'optional' | 'required'
|
||
|
||
export interface PageMeta {
|
||
/** 逻辑路径:与后端 `wms_permission.path` 对齐(后端只需知道这个,不感知分包/目录) */
|
||
key: string
|
||
/** 小程序物理页面路径(必须与 `pages.json` 一致,不带 `.vue` 后缀、不带前导 `/`) */
|
||
path: string
|
||
/** 页面标题:后端菜单未下发 `meta_title` 时的兜底显示名 */
|
||
title: string
|
||
/** uview-plus 图标名:后端菜单未下发 `meta_icon` 时的兜底 */
|
||
icon?: string
|
||
/**
|
||
* 登录策略:
|
||
* - `public` 未登录即可看完整内容
|
||
* - `optional` 未登录渲染占位/引导,已登录渲染真实数据
|
||
* - `required` 未登录页内提示「请先登录」(**不自动跳转**)
|
||
*/
|
||
auth: AuthMode
|
||
/** 是否 tabBar 页 —— 跳转必须用 `uni.switchTab`,不能用 `navigateTo` */
|
||
tabBar?: boolean
|
||
/** 是否不进导航入口(九宫格 / 功能菜单):可被跳转,但不作为入口展示 */
|
||
hidden?: boolean
|
||
}
|
||
|
||
export const PAGE_REGISTRY: PageMeta[] = [
|
||
// ─────────────── 公共页面:无需登录即可访问,不会被拦截 ───────────────
|
||
{
|
||
key: '/home',
|
||
path: 'pages/index/index',
|
||
title: '首页',
|
||
icon: 'home',
|
||
auth: 'public',
|
||
tabBar: true,
|
||
// tabBar 本身就是入口,不再进九宫格
|
||
hidden: true
|
||
},
|
||
{
|
||
key: '/mine',
|
||
path: 'pages/mine/mine',
|
||
title: '我的',
|
||
icon: 'account',
|
||
auth: 'optional',
|
||
tabBar: true,
|
||
hidden: true
|
||
},
|
||
{
|
||
key: '/mine/user-info',
|
||
path: 'pages/mine/user-info',
|
||
title: '用户信息',
|
||
icon: 'account-fill',
|
||
// 未登录也能进(页内引导登录,不自动跳转),故为 optional
|
||
auth: 'optional',
|
||
// 仅由「我的」页菜单进入,不作为九宫格 / 功能菜单入口
|
||
hidden: true
|
||
},
|
||
{
|
||
key: '/login',
|
||
path: 'pages/login/login',
|
||
title: '登录 / 注册',
|
||
icon: 'account-fill',
|
||
auth: 'public',
|
||
// 由「我的」页主动进入,不作为入口展示
|
||
hidden: true
|
||
},
|
||
{
|
||
key: '/login/confirm-login',
|
||
path: 'pages/login/confirm-login',
|
||
title: '确认登录',
|
||
icon: 'checkmark-circle',
|
||
// 未登录也能进(页内引导登录),故为 public
|
||
auth: 'public',
|
||
// 仅由扫码入口(spm 场景 4)navigateTo 进入,不作为入口展示
|
||
hidden: true
|
||
},
|
||
|
||
// ──────── 框架示例页(分包 pagesA):验证三态渲染与权限,业务页上线后可删 ────────
|
||
{
|
||
key: '/demo/public',
|
||
path: 'pagesA/demo/public',
|
||
title: '公开示例',
|
||
icon: 'info-circle',
|
||
auth: 'public'
|
||
// 不设 hidden → 未登录时会自动出现在首页九宫格(LOCAL_PUBLIC_ENTRIES)
|
||
},
|
||
{
|
||
key: '/demo/required',
|
||
path: 'pagesA/demo/required',
|
||
title: '需登录示例',
|
||
icon: 'lock',
|
||
auth: 'required',
|
||
// 需登录的页不进公共入口;登录后由后端菜单下发才出现在九宫格
|
||
hidden: true
|
||
},
|
||
{
|
||
key: '/test/index',
|
||
path: 'pagesA/test/index',
|
||
title: '测试页',
|
||
icon: 'grid',
|
||
auth: 'required'
|
||
// 不设 hidden → 登录后由后端菜单(wms_permission id=627)下发生效,出现在首页「常用功能」
|
||
},
|
||
|
||
// ─────────────── 业务页(分包):待页面文件就绪后再启用 ───────────────
|
||
// ⚠️ pagesA / pagesB / pagesC 目前只有 .gitkeep 占位,**先不登记**:
|
||
// 登记了 pages.json 里没有的页面 = 用户点进去必然失败。
|
||
// 启用步骤:① 建页面文件 → ② 注册到 pages.json 的 subPackages → ③ 打开下面的注释。
|
||
// { key: '/inbound/list', path: 'pagesA/inbound/list', title: '入库', icon: 'bag', auth: 'required' },
|
||
// { key: '/outbound/list', path: 'pagesB/outbound/list', title: '出库', icon: 'car', auth: 'required' },
|
||
// { key: '/stocktaking/list', path: 'pagesC/stocktaking/list', title: '盘点', icon: 'list', auth: 'required' },
|
||
// { key: '/inventory/list', path: 'pagesC/inventory/list', title: '库存查询', icon: 'search', auth: 'required' }
|
||
]
|
||
|
||
/** 逻辑路径 → 页面元数据(菜单渲染 / 跳转时查表用) */
|
||
export const PAGE_MAP = new Map<string, PageMeta>(
|
||
PAGE_REGISTRY.map((page) => [page.key, page])
|
||
)
|
||
|
||
/** 物理路径 → 页面元数据(「当前页面反查元数据」时用) */
|
||
export const PAGE_BY_PATH = new Map<string, PageMeta>(
|
||
PAGE_REGISTRY.map((page) => [page.path, page])
|
||
)
|
||
|
||
/** 按逻辑路径取页面元数据 */
|
||
export function getPageByKey(key: string): PageMeta | undefined {
|
||
return PAGE_MAP.get(key)
|
||
}
|
||
|
||
/**
|
||
* 按物理路径取页面元数据
|
||
* 兼容带前导 `/` 的写法(如 `getCurrentPages()` 与手写路径两种习惯)
|
||
*/
|
||
export function getPageByPath(path: string): PageMeta | undefined {
|
||
return PAGE_BY_PATH.get(path.replace(/^\//, ''))
|
||
}
|
||
|
||
/** 是否为 tabBar 页 —— 决定跳转用 `switchTab` 还是 `navigateTo` */
|
||
export function isTabBarPage(keyOrPath: string): boolean {
|
||
const page = getPageByKey(keyOrPath) || getPageByPath(keyOrPath)
|
||
return !!page?.tabBar
|
||
}
|