Vue / 系统课时

路由元信息设计

路由元信息设计

路由 meta 适合承载“页面如何被应用解释”的稳定描述,例如标题、菜单、缓存、权限和布局。设计重点不是把字段塞得越多越好,而是先定义类型契约,再明确每个字段由谁消费、默认值是什么,以及父子路由覆盖时采用什么规则。

学习目标

  • 为常用路由元信息建立 TypeScript 类型约束
  • 区分标题、菜单、缓存、权限和布局字段的职责
  • 正确处理嵌套路由中 meta 的合并与覆盖边界

把 meta 设计成应用契约

meta 是路由记录上的描述数据,本身不会自动修改标题、生成菜单、开启缓存或完成鉴权。真正的行为仍由标题同步逻辑、菜单生成器、布局组件、KeepAlive 和导航守卫读取这些字段后实现。

企业项目应先固定一组少而稳定的字段,再让业务页面按约定填写。下面示例把类型扩展与路由配置放在同一个文件中,便于看清字段关系;实际项目也可以把 RouteMeta 扩展单独放到 .d.ts 文件。

ts
import {
  createRouter,
  createWebHistory,
} from 'vue-router'

declare module 'vue-router' {
  interface RouteMeta {
    title: string
    layout?: 'default' | 'blank'
    menu?: {
      label: string
      order: number
    }
    keepAlive?: boolean
    permissions?: string[]
  }
}

const router = createRouter({
  history: createWebHistory(import.meta.env.BASE_URL),
  routes: [
    {
      path: '/orders',
      name: 'orders',
      component: () => import('../views/orders/OrderListView.vue'),
      meta: {
        title: '订单管理',
        layout: 'default',
        menu: {
          label: '订单',
          order: 20,
        },
        keepAlive: true,
        permissions: ['order:read'],
      },
    },
  ],
})

export default router

这是项目上下文中的配置示例,依赖 Vue Router 和对应页面文件。类型扩展让 meta 中的键和值获得补全与检查,但路由行为只有在消费方读取这些字段后才会生效。

明确字段由谁消费

同一个字段只承担一种职责,能显著降低后期耦合。常见字段可以这样分工:

字段 典型消费方 设计要点
title 标题同步逻辑 保存页面标题文本,不混入 HTML
menu 菜单生成器 只描述菜单展示所需信息
keepAlive 布局与缓存容器 表示缓存意图,不代表自动缓存
permissions 导航守卫 保存权限标识,不保存鉴权函数
layout 根布局选择器 使用有限枚举,避免任意字符串

例如 keepAlive: true 只是“这个页面希望被缓存”的声明。若布局没有根据路由状态把页面放进 <KeepAlive>,该字段不会产生任何效果。同理,permissions 只能作为前端导航判断依据,真正的数据访问权限仍必须由服务端校验。

处理父子路由的覆盖规则

Vue Router 会把匹配到的父子路由记录的 meta 合并到 route.meta,但这个合并不是深度递归合并。父路由和子路由出现同名键时,子路由值会覆盖父路由对应值。

这意味着对象型字段尤其要谨慎。例如父路由的 menu 同时保存分组和图标,子路由再次提供 menu 时,不应假设内部属性会自动逐项继承。需要继承的复杂信息可以拆成独立字段,或者直接遍历 to.matched 按应用规则计算。

权限也必须先定义语义。若项目规定“子路由权限覆盖父路由”,读取 to.meta.permissions 即可;若规定“父子权限累加”,就应遍历 to.matched 收集每条记录的权限,而不是依赖浅合并后的单个数组。

用类型检查守住约定

完成类型设计后,应让 TypeScript 在提交前发现拼写错误、非法枚举值和错误字段类型。在已安装 vue-tsc 的 Vue + TypeScript 项目中可以执行:

bash
npx vue-tsc --noEmit

预期结果

text
(无类型错误时通常没有标准输出,进程退出码为 0)

如果把 layout 写成未声明的值,或把 permissions 写成字符串而不是字符串数组,类型检查就应失败。需要注意的是,Vue Router 的路由记录可以完全省略 meta;如果团队要求“每一条业务路由都必须有标题和权限声明”,还需要在路由配置封装或代码审查规则中把 meta 本身也设为必填约束。

路由元信息设计得好,页面组件就不需要反复知道菜单、布局和权限系统的细节。保持字段少、类型明确、消费方单一,并把父子覆盖规则写成团队约定,后续新增页面时才能稳定扩展。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

路由元信息设计

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通