create-iking-admin/template-v2/main-app/router/index.ts

金合技术中台脚手架

import { createRouter, createWebHashHistory } from 'vue-router'
import type { RouteRecordRaw } from 'vue-router'
import { useNProgress } from '@vueuse/integrations/useNProgress'
import '@main/assets/styles/nprogress.scss'

// 路由相关数据
import pinia from '@main/store'
import useSettingsStore from '@main/store/modules/settings'
import useKeepAliveStore from '@main/store/modules/keepAlive'
import useUserStore from '@main/store/modules/user'
import useRouteStore from '@main/store/modules/route'
import useMenuStore from '@main/store/modules/menu'
import useTabbarStore from '@main/store/modules/tabbar'
import useIframeStore from '@main/store/modules/iframe'
import useFavoritesStore from '@main/store/modules/favorites'
import { constantRoutes, constantRoutesByFilesystem } from './routes'
import type { Iframe } from '#/global'

const { isLoading } = useNProgress()

const router = createRouter({
  history: createWebHashHistory(),
  routes: useSettingsStore(pinia).settings.app.routeBaseOn === 'filesystem' ? constantRoutesByFilesystem : constantRoutes as RouteRecordRaw[],
})

router.beforeEach(async (to, from, next) => {
  if (to.path === '/login') {
    next()
    return
  }
  const settingsStore = useSettingsStore()
  const userStore = useUserStore()
  const routeStore = useRouteStore()
  const menuStore = useMenuStore()
  const tabbarStore = useTabbarStore()
  const iframeStore = useIframeStore()
  const favoritesStore = useFavoritesStore()
  ikStore.local.setItem('menuid', to?.meta?.id || '')
  settingsStore.settings.app.enableProgress && (isLoading.value = true)
  // 如果带有token，则直接登录
  if (to.query.token) {
    userStore.autoLogin(<string>to.query.token, to)
    return
  }

  // 是否已登录
  if (userStore.isLogin) {
    // 是否已根据权限动态生成并注册路由
    if (routeStore.isGenerate) {
      // 生成 iframe 列表
      if (!iframeStore.isGenerate) {
        const iframeList: Iframe.recordRaw[] = []
        router.getRoutes().forEach((item) => {
          if (item.meta.iframe && !item.meta.link) {
            iframeList.push({
              path: item.path,
              src: item.meta.iframe,
              isOpen: false,
              isLoading: true,
            })
          }
        })
        iframeStore.generateList(iframeList)
      }
      // 导航栏如果不是 single 模式，则需要根据 path 定位主导航的选中状态
      settingsStore.settings.menu.menuMode !== EMenuModel.侧边栏 && menuStore.setActived(to.path)
      // 如果已登录状态下，进入登录页会强制跳转到主页
      if (to.name === 'login') {
        next({
          path: settingsStore.settings.home.fullPath,
          replace: true,
        })
      }
      // 如果未开启主页，但进入的是主页，则会进入第一个固定标签页或者侧边栏导航第一个模块
      else if (!settingsStore.settings.home.enable && to.fullPath === settingsStore.settings.home.fullPath) {
        const firstPin = tabbarStore.list.find(v => v.isPin)
        if (settingsStore.settings.tabbar.enable && firstPin) {
          next({
            path: firstPin.fullPath,
            replace: true,
          })
        }
        else if (menuStore.sidebarMenus.length > 0) {
          next({
            path: menuStore.sidebarMenusFirstDeepestPath,
            replace: true,
          })
        }
        // 如果第一个固定标签页和侧边栏导航第一个模块均无法命中，则还是进入主页
        else {
          next()
        }
      }
      // 正常访问页面
      else {
        next()
      }
    }
    else {
      // 获取用户偏好设置
      // settingsStore.settings.userPreferences.enable && await userStore.getPreferences()
      // 复原固定标签页
      settingsStore.settings.tabbar.enable && await tabbarStore.recoveryStorage()
      // 复原收藏夹
      settingsStore.settings.toolbar.favorites && await favoritesStore.recoveryStorage()
      await routeStore.generateRoutesAtBack()
      // 注册并记录路由数据
      // 记录的数据会在登出时会使用到，不使用 router.removeRoute 是考虑配置的路由可能不一定有设置 name ，则通过调用 router.addRoute() 返回的回调进行删除
      const removeRoutes: (() => void)[] = []
      routeStore.flatRoutes.forEach((route: any) => {
        if (!/^(https?:|mailto:|tel:)/.test(route.path)) {
          if (route.path ) {
            routeStore.flatSystemRoutes[0].children?.push(route)
          }
          else {
            removeRoutes.push(router.addRoute(route as RouteRecordRaw))
          }
        }
      })
      routeStore.flatSystemRoutes.forEach((route) => {
        removeRoutes.push(router.addRoute(route as RouteRecordRaw))
      })
      routeStore.setCurrentRemoveRoutes(removeRoutes)
      // 动态路由生成并注册后，重新进入当前路由
      next({
        path: to.path,
        query: to.query,
        replace: true,
      })
    }
  }
  else {
    if (!to?.meta?.whiteList) {
      next({
        name: 'login',
        query: {
          redirect: to.fullPath !== settingsStore.settings.home.fullPath ? to.fullPath : undefined,
        },
      })
    }
    else {
      next()
    }
  }
})

router.afterEach((to, from) => {
  const settingsStore = useSettingsStore()
  const keepAliveStore = useKeepAliveStore()
  const iframeStore = useIframeStore()
  const menuStore = useMenuStore()

  if (to.meta?.isFirstLevel) {
    settingsStore.updateSingleMenu(true)
  } else {
    settingsStore.updateSingleMenu(false)
  }

  // menuStore.setActiveMenu(to.path)
  // menuStore.setActived(to.meta.parentId)

  settingsStore.settings.app.enableProgress && (isLoading.value = false)
  // 设置页面 title
  if (settingsStore.settings.app.routeBaseOn !== 'filesystem') {
    settingsStore.setTitle(to.meta.breadcrumbNeste?.at(-1)?.title ?? to.meta.title)
  }
  else {
    settingsStore.setTitle(to.meta.title)
  }
  if (to.fullPath !== from.fullPath) {
    /**
     * 处理普通页面的缓存
     */
    // 判断当前页面是否开启缓存，如果开启，则将当前页面的 name 信息存入 keep-alive 全局状态
    if (to.meta.cache && !to.meta.iframe) {
      const componentName = to.matched.at(-1)?.components?.default.name
      if (componentName) {
        keepAliveStore.add(componentName)
      }
      else {
        console.warn('该页面组件未设置组件名，会导致缓存失效，请检查')
      }
    }
    // 判断离开页面是否开启缓存，如果开启，则根据缓存规则判断是否需要清空 keep-alive 全局状态里离开页面的 name 信息
    if (from.meta.cache && !from.meta.iframe) {
      const componentName = from.matched.at(-1)?.components?.default.name
      if (componentName) {
      // 通过 meta.cache 判断针对哪些页面进行缓存
        switch (typeof from.meta.cache) {
          case 'string':
            if (from.meta.cache !== to.name) {
              keepAliveStore.remove(componentName)
            }
            break
          case 'object':
            if (!from.meta.cache.includes(to.name as string)) {
              keepAliveStore.remove(componentName)
            }
            break
        }
        // 通过 meta.noCache 判断针对哪些页面不需要进行缓存
        if (from.meta.noCache) {
          switch (typeof from.meta.noCache) {
            case 'string':
              if (from.meta.noCache === to.name) {
                keepAliveStore.remove(componentName)
              }
              break
            case 'object':
              if (from.meta.noCache.includes(to.name as string)) {
                keepAliveStore.remove(componentName)
              }
              break
          }
        }
        // 如果进入的是 reload 页面，则也将离开页面的缓存清空
        if (to.name === 'reload') {
          keepAliveStore.remove(componentName)
        }
      }
    }
    /**
     * 处理 iframe 页面的缓存
     */
    if (to.meta.iframe) {
      iframeStore.open(to.fullPath)
    }
    if (from.meta.iframe) {
      if (from.meta.cache) {
        switch (typeof from.meta.cache) {
          case 'string':
            if (from.meta.cache !== to.name) {
              iframeStore.close(from.fullPath)
            }
            break
          case 'object':
            if (!from.meta.cache.includes(to.name as string)) {
              iframeStore.close(from.fullPath)
            }
            break
        }
        if (from.meta.noCache) {
          switch (typeof from.meta.noCache) {
            case 'string':
              if (from.meta.noCache === to.name) {
                iframeStore.close(from.fullPath)
              }
              break
            case 'object':
              if (from.meta.noCache.includes(to.name as string)) {
                iframeStore.close(from.fullPath)
              }
              break
          }
        }
        if (to.name === 'reload') {
          iframeStore.close(from.fullPath)
        }
      }
      else {
        iframeStore.close(from.fullPath)
      }
    }
  }
  document.documentElement.scrollTop = 0
})

export default router