一、Vue Router动态路由加载的基础概念
很多做前端开发的朋友都遇到过这样的需求:不同权限的用户登录系统后,能看到的页面不一样。比如普通员工只能看自己的个人中心和考勤表,部门经理能看到部门管理页,超级管理员能看到系统设置页。如果把所有路由都写死在代码里,就会出现两个问题:一是用户登录后能通过直接改地址栏访问自己没权限的页面,二是路由太多会导致项目启动慢。这时候就需要用到动态路由加载,简单说就是用户登录后,系统根据他的权限动态生成对应的路由,而不是一开始就把所有路由都加载进来。
要理解动态路由加载,得先搞懂Vue Router的路由注册逻辑。普通的静态路由是在创建Vue Router实例的时候就把所有路由配置好,比如:
// 技术栈:Vue 3 + Vue Router 4
const routes = [
{ path: '/login', component: Login },
{ path: '/home', component: Home },
// 更多静态路由...
]
const router = createRouter({ routes, history: createWebHistory() })
这种方式的路由是写死的,所有用户都能访问这些路由(除非做了额外的权限拦截)。而动态路由是等用户登录后,拿到权限信息,再调用Vue Router的addRoute方法把对应的路由加进去,这样只有有权限的用户才有对应的路由。
二、权限匹配的核心逻辑与实现
动态路由加载的第一步是做好权限匹配,也就是怎么判断一个用户能访问哪些路由。权限匹配的核心是把路由的访问权限和用户的权限做对应,常见的做法有两种:一种是给路由加权限标识,另一种是给用户加权限列表。
2.1 基于路由权限标识的匹配
这种做法是在每个需要权限的路由配置里加一个meta字段,里面存这个路由需要的权限标识,比如meta: { permission: 'system:user:view' },意思是只有拥有system:user:view这个权限的用户才能访问这个路由。然后用户登录后,拿到自己的权限列表,比如['system:user:view', 'system:role:view'],然后遍历所有的动态路由配置,把用户权限列表里有的权限对应的路由筛选出来,再注册到Vue Router里。
举个完整的例子,先定义动态路由的配置:
// 技术栈:Vue 3 + Vue Router 4
// 动态路由配置:所有需要权限的路由都写在这里,不要直接加到静态路由里
const asyncRoutes = [
{
path: '/system/user',
name: 'SystemUser',
component: () => import('@/views/system/user/index.vue'),
meta: {
title: '用户管理',
permission: 'system:user:view' // 这个路由需要的权限标识
}
},
{
path: '/system/role',
name: 'SystemRole',
component: () => import('@/views/system/role/index.vue'),
meta: {
title: '角色管理',
permission: 'system:role:view'
}
},
{
path: '/system/menu',
name: 'SystemMenu',
component: () => import('@/views/system/menu/index.vue'),
meta: {
title: '菜单管理',
permission: 'system:menu:view'
}
}
]
然后写一个权限匹配的工具函数,用来筛选用户有权限的路由:
// 技术栈:Vue 3 + Vue Router 4
/**
* 筛选用户有权限的路由
* @param {Array} routes 所有动态路由配置
* @param {Array} userPermissions 用户的权限列表
* @returns {Array} 筛选后的有权限的路由
*/
function filterRoutes(routes, userPermissions) {
return routes.filter(route => {
// 如果路由没有设置权限标识,默认所有用户都能访问
if (!route.meta || !route.meta.permission) {
// 如果有子路由,也要递归筛选子路由
if (route.children) {
route.children = filterRoutes(route.children, userPermissions)
}
return true
}
// 判断用户权限列表里是否包含这个路由需要的权限
const hasPermission = userPermissions.includes(route.meta.permission)
// 如果没有权限,直接返回false,不保留这个路由
if (!hasPermission) return false
// 如果有权限,且有子路由,递归筛选子路由
if (route.children) {
route.children = filterRoutes(route.children, userPermissions)
}
return true
})
}
最后在用户登录成功后调用这个函数,把筛选后的路由注册到Vue Router:
// 技术栈:Vue 3 + Vue Router 4
// 假设用户登录后,从接口拿到用户信息,里面包含权限列表
const userInfo = await loginApi(loginForm) // 调用登录接口
const userPermissions = userInfo.permissions // 拿到用户的权限列表
// 筛选有权限的路由
const allowedRoutes = filterRoutes(asyncRoutes, userPermissions)
// 注册动态路由:addRoute可以传父路由的name,这里所有动态路由都加到根路由下
allowedRoutes.forEach(route => {
router.addRoute(route)
})
// 注册完路由后,跳转到首页
router.push('/home')
2.2 基于用户角色的权限匹配
除了给路由加权限标识,还可以基于角色来做权限匹配,比如给用户分角色:普通员工、部门经理、超级管理员,然后给每个路由设置允许访问的角色,比如meta: { roles: ['manager', 'admin'] },意思是部门经理和超级管理员能访问这个路由。这种做法的逻辑和基于权限标识的类似,只是匹配的时候判断用户的角色是否在路由的允许角色列表里。
比如修改上面的工具函数:
// 技术栈:Vue 3 + Vue Router 4
function filterRoutesByRole(routes, userRole) {
return routes.filter(route => {
if (!route.meta || !route.meta.roles) {
if (route.children) {
route.children = filterRoutesByRole(route.children, userRole)
}
return true
}
const hasRole = route.meta.roles.includes(userRole)
if (!hasRole) return false
if (route.children) {
route.children = filterRoutesByRole(route.children, userRole)
}
return true
})
}
这种做法的优点是逻辑简单,适合角色少、权限划分清晰的系统;缺点是如果系统角色多,或者一个用户有多个角色,管理起来会比较麻烦,所以现在大部分系统都是用基于权限标识的匹配方式。
三、路由重复注册的异常处理
动态路由加载的时候,最容易遇到的问题就是路由重复注册。比如用户A登录后,注册了/system/user这个路由,然后用户A退出登录,用户B登录,又注册了一次/system/user,这时候Vue Router就会报错,提示“Duplicate named routes definition”(重复的命名路由定义)。为什么会出现这个问题?因为Vue Router的路由是全局的,只要没有移除,就会一直存在,第二次注册同一个name的路由就会冲突。
3.1 重复注册的原因分析
重复注册的常见场景有两个:一是用户退出登录后没有移除之前注册的动态路由,二是用户在不刷新页面的情况下切换账号,比如一个用户登录后,不刷新页面直接切换到另一个账号,这时候之前的动态路由还在,新账号又要注册一次。
3.2 解决方案一:每次注册前移除旧的动态路由
最直接的解决办法是,在每次注册新的动态路由之前,先把之前注册的动态路由全部移除。那怎么移除动态路由?Vue Router的addRoute方法会返回一个移除函数,或者可以通过路由的name来移除。
具体实现步骤:
- 定义一个数组,用来保存所有动态路由的name,方便后面移除;
- 每次注册动态路由的时候,把路由的name保存到这个数组里;
- 每次注册新的动态路由之前,先遍历这个数组,把对应的路由移除,然后清空数组。
示例代码:
// 技术栈:Vue 3 + Vue Router 4
// 用来保存动态路由的name,方便移除
let dynamicRouteNames = []
/**
* 注册动态路由
* @param {Array} allowedRoutes 筛选后的有权限的路由
*/
function registerDynamicRoutes(allowedRoutes) {
// 第一步:先移除之前注册的所有动态路由
dynamicRouteNames.forEach(routeName => {
router.removeRoute(routeName)
})
// 清空保存的路由name数组
dynamicRouteNames = []
// 第二步:注册新的动态路由
allowedRoutes.forEach(route => {
// 注册路由,同时把路由的name保存到数组里
router.addRoute(route)
dynamicRouteNames.push(route.name)
// 如果有子路由,递归保存子路由的name
function saveChildRouteNames(children) {
children.forEach(child => {
dynamicRouteNames.push(child.name)
if (child.children) {
saveChildRouteNames(child.children)
}
})
}
if (route.children) {
saveChildRouteNames(route.children)
}
})
}
// 登录的时候调用:先拿到权限列表,筛选路由,再注册
const userInfo = await loginApi(loginForm)
const allowedRoutes = filterRoutes(asyncRoutes, userInfo.permissions)
registerDynamicRoutes(allowedRoutes)
router.push('/home')
// 退出登录的时候调用:移除所有动态路由
function logout() {
// 移除动态路由
dynamicRouteNames.forEach(routeName => {
router.removeRoute(routeName)
})
dynamicRouteNames = []
// 清空用户信息,跳转到登录页
localStorage.removeItem('userInfo')
router.push('/login')
}
3.3 解决方案二:利用Vue Router的路由重置方法
除了自己维护动态路由的name,还可以用Vue Router的路由重置方法。Vue Router 4有一个getRoutes方法,可以拿到所有注册的路由,然后可以重新创建一个新的Router实例,替换原来的实例。这种方法适合在用户退出登录或者切换账号的时候,完全重置路由。
示例代码:
// 技术栈:Vue 3 + Vue Router 4
// 先定义静态路由,也就是所有用户都能访问的路由
const staticRoutes = [
{ path: '/login', component: Login },
{ path: '/home', component: Home },
{ path: '/404', component: NotFound },
{ path: '/:pathMatch(.*)*', redirect: '/404' } // 捕获所有未匹配的路由
]
// 初始化路由实例
let router = createRouter({
routes: staticRoutes,
history: createWebHistory()
})
// 重置路由的方法:重新创建一个只有静态路由的实例,替换原来的
function resetRouter() {
const newRouter = createRouter({
routes: staticRoutes,
history: createWebHistory()
})
router = newRouter
}
// 登录的时候调用:先重置路由,再注册动态路由
const userInfo = await loginApi(loginForm)
resetRouter() // 先重置,移除所有动态路由
const allowedRoutes = filterRoutes(asyncRoutes, userInfo.permissions)
allowedRoutes.forEach(route => {
router.addRoute(route)
})
router.push('/home')
// 退出登录的时候调用:重置路由
function logout() {
resetRouter()
localStorage.removeItem('userInfo')
router.push('/login')
}
这种方法的优点是不用自己维护动态路由的name,代码更简洁;缺点是重新创建Router实例的时候,会丢失原来的一些路由状态,比如当前的导航状态,所以要注意在重置后处理好跳转逻辑。
四、应用场景、技术优缺点与注意事项
4.1 应用场景
动态路由加载主要用在需要权限控制的前端系统,比如企业内部的管理系统、后台管理系统、多角色的电商后台等。具体的应用场景包括:
- 多角色权限系统:不同角色的用户看到不同的菜单和页面;
- 大型项目优化:项目路由太多,静态加载会导致首屏加载慢,动态加载可以按需加载路由,减少首屏时间;
- 避免未授权访问:防止用户通过直接修改地址栏访问自己没有权限的页面。
4.2 技术优缺点
优点
- 权限控制更灵活:可以根据用户的权限动态生成路由,不同用户看到的页面完全不同;
- 提升首屏性能:只有用户需要的路由才会被加载,减少了初始加载的路由数量,适合大型项目;
- 安全性更高:没有权限的路由不会被注册,用户无法通过地址栏访问未授权的页面。
缺点
- 实现复杂度高:需要处理权限匹配、路由注册、重复注册等问题,代码量比静态路由多;
- 路由状态管理复杂:动态路由的添加和移除需要额外的逻辑,比如切换账号时需要重置路由;
- 调试难度大:动态路由是运行时生成的,在开发调试的时候,需要看接口返回的权限和路由配置是否匹配,比静态路由难调试。
4.3 注意事项
- 404路由的位置:动态路由加载的时候,404路由必须放在静态路由的最后,因为Vue Router的路由匹配是按顺序的,如果404路由放在动态路由前面,会导致动态路由无法匹配,直接跳转到404;
- 路由的name必须唯一:不管是静态路由还是动态路由,name都不能重复,否则会导致路由冲突;
- 子路由的处理:动态路由如果有子路由,在筛选和移除的时候要递归处理,否则会出现子路由无法访问或者无法移除的问题;
- 权限的前端校验只是辅助:前端的动态路由加载只是权限控制的一部分,后端必须做对应的接口权限校验,防止用户绕过前端访问接口;
- 路由的缓存问题:如果用了
<keep-alive>缓存组件,动态路由的组件缓存可能会出现问题,比如切换账号后,之前的组件缓存还在,需要在重置路由的时候清理缓存。
五、文章总结
动态路由加载是前端权限控制的重要技术,核心是根据用户的权限动态生成对应的路由,解决了静态路由权限控制不灵活、首屏加载慢的问题。权限匹配是动态路由加载的基础,需要根据项目的实际情况选择基于权限标识还是基于角色的匹配方式;路由重复注册是动态路由加载最常见的问题,需要通过移除旧路由或者重置路由的方式解决。
在实际开发中,要根据项目的规模和需求选择合适的实现方式:如果项目比较小,角色和权限少,可以用静态路由加路由拦截的方式;如果项目比较大,权限复杂,就需要用动态路由加载的方式。同时要注意,前端的权限控制只是第一道防线,后端必须做好对应的权限校验,才能保证系统的安全性。
评论
围绕“Vue Router动态路由加载:权限匹配与路由重复注册的异常处理”参与讨论