vue全局路由守卫

1,050 阅读2分钟
import router from './router'
import store from './store'
import { Message } from 'element-ui'
import NProgress from 'nprogress' // progress bar
import 'nprogress/nprogress.css' // progress bar style
import { getToken } from '@/utils/auth' // get token from cookie
import getPageTitle from '@/utils/get-page-title'

NProgress.configure({ showSpinner: false }) // NProgress Configuration

const whiteList = ['/login'] // no redirect whitelist

router.beforeEach(async(to, from, next) => {
  // start progress bar
  NProgress.start()

  // set page title
  document.title = getPageTitle(to.meta.title)

  // determine whether the user has logged in
  const hasToken = getToken()

  if (hasToken) {
    if (to.path === '/login') {
      // if is logged in, redirect to the home page
      next({ path: '/' })
      NProgress.done()
    } else {
      const hasGetUserInfo = store.getters.name
      if (hasGetUserInfo) {
        next()
      } else {
        try {
          // get user info
          await store.dispatch('user/getInfo')

          next()
        } catch (error) {
          // remove token and go to login page to re-login
          await store.dispatch('user/resetToken')
          Message.error(error || 'Has Error')
          next(`/login?redirect=${to.path}`)
          NProgress.done()
        }
      }
    }
  } else {
    /* has no token*/

    if (whiteList.indexOf(to.path) !== -1) {
      // in the free login whitelist, go directly
      next()
    } else {
      // other pages that do not have permission to access are redirected to the login page.
      next(`/login?redirect=${to.path}`)
      NProgress.done()
    }
  }
})

router.afterEach(() => {
  // finish progress bar
  NProgress.done()
})

文件详细解释

导入模块

import router from './router'
import store from './store'
import { Message } from 'element-ui'
import NProgress from 'nprogress' // progress bar
import 'nprogress/nprogress.css' // progress bar style
import { getToken } from '@/utils/auth' // get token from cookie
import getPageTitle from '@/utils/get-page-title'
  • router:Vue Router 实例,用于管理路由。

  • store:Vuex Store 实例,用于管理全局状态。

  • Message:Element UI 的消息组件,用于显示消息通知。

  • NProgress:进度条库,用于显示页面加载进度条。

  • getToken:从 cookies 中获取 token 的工具函数。

  • getPageTitle:获取页面标题的工具函数。

配置 NProgress

NProgress.configure({ showSpinner: false }) // NProgress Configuration
  • 配置 NProgress 不显示加载微调器。

定义白名单

const whiteList = ['/login'] // no redirect whitelist
  • 定义无需重定向的白名单,包含登录页面 /login

全局前置守卫

router.beforeEach(async (to, from, next) => {
  // start progress bar
  NProgress.start()

  // set page title
  document.title = getPageTitle(to.meta.title)

  // determine whether the user has logged in
  const hasToken = getToken()

  if (hasToken) {
    if (to.path === '/login') {
      // if is logged in, redirect to the home page
      next({ path: '/' })
      NProgress.done()
    } else {
      const hasGetUserInfo = store.getters.name
      if (hasGetUserInfo) {
        next()
      } else {
        try {
          // get user info
          await store.dispatch('user/getInfo')
          next()
        } catch (error) {
          // remove token and go to login page to re-login
          await store.dispatch('user/resetToken')
          Message.error(error || 'Has Error')
          next(`/login?redirect=${to.path}`)
          NProgress.done()
        }
      }
    }
  } else {
    /* has no token*/

    if (whiteList.indexOf(to.path) !== -1) {
      // in the free login whitelist, go directly
      next()
    } else {
      // other pages that do not have permission to access are redirected to the login page.
      next(`/login?redirect=${to.path}`)
      NProgress.done()
    }
  }
})
  • NProgress.start():开始显示进度条。

  • document.title = getPageTitle(to.meta.title):设置页面标题。

  • const hasToken = getToken():检查是否有 token。

有 token 的情况

  • 如果有 token:

    • 如果访问登录页面,重定向到首页。

    • 检查用户信息是否已获取(通过 store.getters.name 判断)。

    • 如果用户信息已获取,直接跳转到目标页面。

    • 如果用户信息未获取,调用 store.dispatch('user/getInfo') 获取用户信息。

      • 获取成功,跳转到目标页面。

      • 获取失败,重置 token,并重定向到登录页面。

无 token 的情况

  • 如果没有 token:

    • 检查目标路由是否在白名单中,如果在白名单中,直接跳转。

    • 如果不在白名单中,重定向到登录页面,并传递重定向路径。

全局后置钩子

router.afterEach(() => {
  // finish progress bar
  NProgress.done()
})
  • 在每次路由切换完成后,结束进度条显示。