Vue實現動態路由

這是我參與更文挑戰的第1天，活動詳情查看：更文挑戰css

一般咱們在vue項目中都是前端配置好路由的，但在一些項目中咱們可能會遇到權限控制，這樣咱們就涉及到動態路由的設置了。前端

動態路由設置通常有兩種：

(1)、簡單的角色路由設置： 好比只涉及到管理員和普通用戶的權限。一般直接在前端進行簡單的角色權限設置vue

(2)、複雜的路由權限設置： 好比OA系統、多種角色的權限配置。一般須要後端返回路由列表，前端渲染使用vue-router

一、簡單的角色路由設置

（1）配置項目路由權限後端

// router.js
import Vue from 'vue'
import Router from 'vue-router'
import Layout from '@/layout'
Vue.use(Router)
let asyncRoutes = [
    {
        path: '/permission',
        component: Layout,
        redirect: '/permission/page',
        alwaysShow: true, 
        name: 'Permission',
        meta: {
            title: 'Permission',
            roles: ['admin', 'editor'] // 普通的用戶角色
        },
        children: [
            {
                path: 'page',
                component: () => import('@/views/permission/page'),
                name: 'PagePermission',
                meta: {
                    title: 'Page',
                    roles: ['editor']  //  editor角色的用戶才能訪問該頁面
                }
            },
            {
                path: 'role',
                component: () => import('@/views/permission/role'),
                name: 'RolePermission',
                meta: {
                    title: 'Role',
                    roles: ['admin']    //  admin角色的用戶才能訪問該頁面
                }
            }
        ]
    },
 
]
let router = new Router({
    mode: 'history',
    scrollBehavior: () => ({ y: 0 }),
    routes: asyncRoutes
})
export default router
複製代碼

（2）新建一個公共的asyncRouter.js文件

// asyncRouter.js
//判斷當前角色是否有訪問權限
function hasPermission(roles, route) {
  if (route.meta && route.meta.roles) {
    return roles.some(role => route.meta.roles.includes(role))
  } else {
    return true
  }
}
// 遞歸過濾異步路由表，篩選角色權限路由
export function filterAsyncRoutes(routes, roles) {
  const res = [];
  routes.forEach(route => {
    const tmp = { ...route }
    if (hasPermission(roles, tmp)) {
      if (tmp.children) {
        tmp.children = filterAsyncRoutes(tmp.children, roles)
      }
      res.push(tmp)
    }
  })

  return res
}
複製代碼

（3）建立路由守衛：建立公共的permission.js文件，設置路由守衛

import router from './router'
import store from './store'
import NProgress from 'nprogress' // 進度條插件
import 'nprogress/nprogress.css' // 進度條樣式
import { getToken } from '@/utils/auth' 
import { filterAsyncRoutes } from '@/utils/asyncRouter.js'

NProgress.configure({ showSpinner: false }) // 進度條配置

const whiteList = ['/login'] 

router.beforeEach(async (to, from, next) => {
    // 進度條開始
    NProgress.start()
     // 獲取路由 meta 中的title，並設置給頁面標題
    document.title = to.meta.title
    // 獲取用戶登陸的token
    const hasToken = getToken()
    // 判斷當前用戶是否登陸
    if (hasToken) {
        if (to.path === '/login') {
            next({ path: '/' })
            NProgress.done()
        } else {
            // 從store中獲取用戶角色
            const hasRoles = store.getters.roles && store.getters.roles.length > 0  
            if (hasRoles) {
                next()
            } else {
                try {
                    // 獲取用戶角色
                    const roles = await store.state.roles
                    // 經過用戶角色，獲取到角色路由表
                    const accessRoutes = filterAsyncRoutes(await store.state.routers,roles)
                    // 動態添加路由到router內
                    router.addRoutes(accessRoutes)
                    next({ ...to, replace: true })
                } catch (error) {
                    // 清除用戶登陸信息後，回跳到登陸頁去
                    next(`/login?redirect=${to.path}`)
                    NProgress.done()
                }
            }
        }
    } else {
        // 用戶未登陸
        if (whiteList.indexOf(to.path) !== -1) {
            // 須要跳轉的路由是不是whiteList中的路由，如果，則直接條狀
            next()
        } else {
            // 須要跳轉的路由不是whiteList中的路由，直接跳轉到登陸頁
            next(`/login?redirect=${to.path}`)
            // 結束精度條
            NProgress.done()
        }
    }
})

router.afterEach(() => {
    // 結束精度條
    NProgress.done()
})
複製代碼

（4）在main.js中引入permission.js文件

（5）在login登陸的時候將roles存儲到store中

二、複雜的路由權限設置（後端動態返回路由數據）

（1）配置項目路由文件，該文件中沒有路由，或者存在一部分公共路由，即沒有權限的路由數組

import Vue from 'vue'
import Router from 'vue-router'
import Layout from '@/layout';
Vue.use(Router)
// 配置項目中沒有涉及權限的公共路由
export const constantRoutes = [
    {
        path: '/login',
        component: () => import('@/views/login'),
        hidden: true
    },
    {
        path: '/404',
        component: () => import('@/views/404'),
        hidden: true
    },
]

const createRouter = () => new Router({
    mode: 'history',
    scrollBehavior: () => ({ y: 0 }),
    routes: constantRoutes
})
const router = createRouter()

export function resetRouter() {
    const newRouter = createRouter()
    router.matcher = newRouter.matcher
}

export default router
複製代碼

（2）新建一個公共的asyncRouter.js文件

// 引入路由文件這種的公共路由
import { constantRoutes } from '../router';
// Layout 組件是項目中的主頁面，切換路由時，僅切換Layout中的組件
import Layout from '@/layout';
export function getAsyncRoutes(routes) {
    const res = []
    // 定義路由中須要的自定名
    const keys = ['path', 'name', 'children', 'redirect', 'meta', 'hidden']
    // 遍歷路由數組去重組可用的路由
    routes.forEach(item => {
        const newItem = {};
        if (item.component) {
            // 判斷 item.component 是否等於 'Layout',如果則直接替換成引入的 Layout 組件
            if (item.component === 'Layout') {
                newItem.component = Layout
            } else {
            //  item.component 不等於 'Layout',則說明它是組件路徑地址，所以直接替換成路由引入的方法
                newItem.component = resolve => require([`@/views/${item.component}`],resolve)
                
                // 此處用reqiure比較好，import引入變量會有各類莫名的錯誤
                // newItem.component = (() => import(`@/views/${item.component}`));
            }
        }
        for (const key in item) {
            if (keys.includes(key)) {
                newItem[key] = item[key]
            }
        }
        // 若遍歷的當前路由存在子路由，須要對子路由進行遞歸遍歷
        if (newItem.children && newItem.children.length) {
            newItem.children = getAsyncRoutes(item.children)
        }
        res.push(newItem)
    })
    // 返回處理好且可用的路由數組
    return res
}
複製代碼

（3）建立路由守衛：建立公共的permission.js文件，設置路由守衛

//  進度條引入設置如上面第一種描述同樣
import router from './router'
import store from './store'
import NProgress from 'nprogress' // progress bar
import 'nprogress/nprogress.css' // progress bar style
import { getToken } from '@/utils/auth' // get token from cookie
import { getAsyncRoutes } from '@/utils/asyncRouter'

const whiteList = ['/login'];
router.beforeEach( async (to, from, next) => {
    NProgress.start()
    document.title = to.meta.title;
    // 獲取用戶token，用來判斷當前用戶是否登陸
    const hasToken = getToken()
    if (hasToken) {
        if (to.path === '/login') {
            next({ path: '/' })
            NProgress.done()
        } else {
            //異步獲取store中的路由
            let route = await store.state.addRoutes;
            const hasRouters = route && route.length>0;
            //判斷store中是否有路由，如有，進行下一步
            if ( hasRouters ) {
                next()
            } else {
                //store中沒有路由，則須要獲取獲取異步路由，並進行格式化處理
                try {
                    const accessRoutes = getAsyncRoutes(await store.state.addRoutes );
                    // 動態添加格式化過的路由
                    router.addRoutes(accessRoutes);
                    next({ ...to, replace: true })
                } catch (error) {
                    // Message.error('出錯了')
                    next(`/login?redirect=${to.path}`)
                    NProgress.done()
                }
            }
        }
    } else {
        if (whiteList.indexOf(to.path) !== -1) {
            next()
        } else {
            next(`/login?redirect=${to.path}`)
            NProgress.done()
        }
    }
})

router.afterEach(() => {
    NProgress.done()
})
複製代碼

（4）在main.js中引入permission.js文件

（5）在login登陸的時候將路由信息存儲到store中

//  登陸接口調用後，調用路由接口，後端返回相應用戶的路由res.router，咱們須要存儲到store中，方便其餘地方拿取
this.$store.dispatch("addRoutes", res.router);
複製代碼

到這裏，整個動態路由就能夠走通了，可是頁面跳轉、路由守衛處理是異步的，會存在動態路由添加後跳轉的是空白頁面，這是由於路由在執行next()時，router裏面的數據還不存在，此時，你能夠經過window.location.reload()來刷新路由markdown

後端返回的路由格式：

routerList = [
  {
        "path": "/other",
        "component": "Layout",
        "redirect": "noRedirect",
        "name": "otherPage",
        "meta": {
            "title": "測試",
        },
        "children": [
            {
                "path": "a",
                "component": "file/a",
                "name": "a",
                "meta": { "title": "a頁面", "noCache": "true" }
            },
            {
                "path": "b",
                "component": "file/b",
                "name": "b",
                "meta": { "title": "b頁面", "noCache": "true" }
            },
        ]
    }
]
複製代碼

注意：vue是單頁面應用程序，因此頁面一刷新數據部分數據也會跟着丟失，因此咱們須要將store中的數據存儲到本地，才能保證路由不丟失。關於vue頁面刷新保存頁面狀態，能夠查看 vue如何在頁面刷新時保留狀態信息cookie

人懶，不想配圖，都是本身的博客內容（乾貨），望能幫到你們異步

公衆號：小何成長，佛系更文，都是本身曾經踩過的坑或者是學到的東西async

有興趣的小夥伴歡迎關注我哦，我是：小阿肥。你們一塊兒進步鴨