guard.ts 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. import type { Router } from 'vue-router';
  2. import { DEFAULT_HOME_PATH, LOGIN_PATH } from '@vben/constants';
  3. import { preferences } from '@vben/preferences';
  4. import { useAccessStore, useUserStore } from '@vben/stores';
  5. import { startProgress, stopProgress } from '@vben/utils';
  6. import { accessRoutes, coreRouteNames } from '#/router/routes';
  7. import { useAuthStore } from '#/store';
  8. import { generateAccess } from './access';
  9. /**
  10. * 通用守卫配置
  11. * @param router
  12. */
  13. function setupCommonGuard(router: Router) {
  14. // 记录已经加载的页面
  15. const loadedPaths = new Set<string>();
  16. router.beforeEach(async (to) => {
  17. to.meta.loaded = loadedPaths.has(to.path);
  18. // 页面加载进度条
  19. if (!to.meta.loaded && preferences.transition.progress) {
  20. startProgress();
  21. }
  22. return true;
  23. });
  24. router.afterEach((to) => {
  25. // 记录页面是否加载,如果已经加载,后续的页面切换动画等效果不在重复执行
  26. loadedPaths.add(to.path);
  27. // 关闭页面加载进度条
  28. if (preferences.transition.progress) {
  29. stopProgress();
  30. }
  31. });
  32. }
  33. /**
  34. * 权限访问守卫配置
  35. * @param router
  36. */
  37. function setupAccessGuard(router: Router) {
  38. router.beforeEach(async (to, from) => {
  39. const accessStore = useAccessStore();
  40. const userStore = useUserStore();
  41. const authStore = useAuthStore();
  42. // 基本路由,这些路由不需要进入权限拦截
  43. if (coreRouteNames.includes(to.name as string)) {
  44. if (to.path === LOGIN_PATH && accessStore.accessToken) {
  45. return decodeURIComponent(
  46. (to.query?.redirect as string) || DEFAULT_HOME_PATH,
  47. );
  48. }
  49. return true;
  50. }
  51. // accessToken 检查
  52. if (!accessStore.accessToken) {
  53. // 明确声明忽略权限访问权限,则可以访问
  54. if (to.meta.ignoreAccess) {
  55. return true;
  56. }
  57. // 没有访问权限,跳转登录页面
  58. if (to.fullPath !== LOGIN_PATH) {
  59. return {
  60. path: LOGIN_PATH,
  61. // 如不需要,直接删除 query
  62. query: { redirect: encodeURIComponent(to.fullPath) },
  63. // 携带当前跳转的页面,登录后重新跳转该页面
  64. replace: true,
  65. };
  66. }
  67. return to;
  68. }
  69. // 是否已经生成过动态路由
  70. if (accessStore.isAccessChecked) {
  71. return true;
  72. }
  73. // 生成路由表
  74. // 当前登录用户拥有的角色标识列表
  75. const userInfo = userStore.userInfo || (await authStore.fetchUserInfo());
  76. const userRoles = userInfo.roles ?? [];
  77. // 生成菜单和路由
  78. const { accessibleMenus, accessibleRoutes } = await generateAccess({
  79. roles: userRoles,
  80. router,
  81. // 则会在菜单中显示,但是访问会被重定向到403
  82. routes: accessRoutes,
  83. });
  84. // 保存菜单信息和路由信息
  85. accessStore.setAccessMenus(accessibleMenus);
  86. accessStore.setAccessRoutes(accessibleRoutes);
  87. accessStore.setIsAccessChecked(true);
  88. const redirectPath = (from.query.redirect ?? to.fullPath) as string;
  89. return {
  90. ...router.resolve(decodeURIComponent(redirectPath)),
  91. replace: true,
  92. };
  93. });
  94. }
  95. /**
  96. * 项目守卫配置
  97. * @param router
  98. */
  99. function createRouterGuard(router: Router) {
  100. /** 通用 */
  101. setupCommonGuard(router);
  102. /** 权限访问 */
  103. setupAccessGuard(router);
  104. }
  105. export { createRouterGuard };