vue 根據(jù)菜單自動生成路由（動態(tài)配置前端路由）

在需要權限控制的頁面您没，往往存在根據(jù)用戶來顯示菜單的情況茎刚，單獨根據(jù)用戶類型判斷顯然不是很好毙芜，如果后面用戶類型發(fā)生變化，項目修改維護可能就會比較麻煩窒朋，所以比較好的做法是根據(jù)后端返回的菜單動態(tài)生成頁面路由搀罢，以達到完全權限控制的目的，并且若權限發(fā)生變化侥猩，僅需該配置數(shù)據(jù)即可

1.創(chuàng)建項目

首先用vue-cli3創(chuàng)建好項目

2.新建文件

創(chuàng)建好項目后榔至，新建我們需要的文件。結構如圖

在這里插入圖片描述

下載相關依賴包：element-ui（菜單樣式用）和 axios（獲取菜單用）

npm i element-ui axios --save

3.到main.js中

import Vue from 'vue'
import App from './App.vue'
import router from './router'
import elementUi from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'
Vue.use(elementUi)

Vue.config.productionTip = false

new Vue({
  router,
  render: h => h(App)
}).$mount('#app')

4.先把菜單組件寫好欺劳，到menu.vue中

這里使用element-ui的el-menu組件

<template>
  <div class="menulist-inner">
    <el-menu
            default-active="/project"
            :default-openeds="openedMenu"
            background-color="rgba(44,55,71,1)"
            text-color="#A7BAC6"
            active-text-color="#FFFFFF"
            @select="select"
            unique-opened
            @open="open">
      <el-submenu :index="menu.path" v-for="(menu,index) in menus" :key="index">
        <template #title>
          <div class="menuTitlBox">
            <div class="rowBtween menuTitle">
              <div class="rowStart">
                <div class="iconBox" style="margin-right:10px;">
                  <i v-if="/icon/.test(menu.icon)" class="iconfont" :class="menu.icon" style="
                  color:#A7BAC6;font-size:16px;"></i>
                  <img v-else :src="menu.icon" width="18"/>
                </div>
                <span class="font16" :class="{whiteText:(!menu.children || !menu.children.length) && new RegExp(menu.path).test($route.path)}">{{menu.label}}</span>
              </div>
            </div>
            <div class="firstMenuBk" v-if="(!menu.children || !menu.children.length) && new RegExp(menu.path).test($route.path)"></div>
          </div>
        </template>
        <div class="menuItemBox rowEnd"
             v-for="(cMenu,cIndex) in menu.children"
             :key="cIndex"
             :class="{activeMenu:RegExp(cMenu.path).test($route.path)}"
             @click="select(cMenu)"
        >
          <span class="rowStart font14">{{cMenu.label}}</span>
        </div>
      </el-submenu>
    </el-menu>
  </div>
</template>

<script>
    import {mapState}from 'vuex'
    export default {
        name: "Menu",
        data() {
            return{
                menuMinHeight:0,//
                openedMenu:[],//展開的菜單

            }
        },
        computed:{
            ...mapState(['menus'])
        },
        created(){
            let pathArr=this.$route.path.split('/')
            this.openedMenu=[`/${pathArr[1]}`]
        },
        async mounted() {

        },
        methods: {
            //中菜單
            select(cMenu){
                // console.log(cMenu)
                let {routeName}=cMenu
                this.$router.push({
                    name:routeName
                })
            },
            //菜單展開
            open(index,indexPath){
                // console.log(indexPath)
                this.openedMenu=indexPath
                let menu=this.menus.filter(item=>item.path===index)
                // console.log(menu)
                let routeMenuInfo={}
                let time=0
                if(!menu[0] || !menu[0].children || !menu[0].children.length){
                    routeMenuInfo=menu[0]
                }else{
                    routeMenuInfo=menu[0].children[0]
                    time=500
                }
                let {path,}=routeMenuInfo
                // console.log(path)
                setTimeout(()=>{
                    this.$router.push(path)
                },time)
            },

        }
    }
</script>
<style lang="scss" scoped>
  .menulist-inner{
    min-height:calc(100vh - 50px);
    .menuItemBox{
      height:36px;
      &:hover{
        background:rgba(62,70,120,.4);
        &>span{
          color: #fff;
        }
      }
      span{
        color:#ffffff;
        flex-wrap:nowrap;
        width:150px;
        cursor:pointer;
      }
    }
    .activeMenu{
      background:rgba(62,70,120,1);
    }
  }
  .menuTitlBox{
    .menuTitle{
      position: relative;
      z-index: 10;
    }
    .firstMenuBk{
      position: absolute;
      left:0;
      top:50%;
      width:200px;
      height:56px;
      background:#3e4678;
      -webkit-transform: translateY(-50%);
      -moz-transform: translateY(-50%);
      -ms-transform: translateY(-50%);
      -o-transform: translateY(-50%);
      transform: translateY(-50%);
    }
    .whiteText{
      color:#ffffff;
    }
  }

</style>
<style>
  .el-submenu{
    position: relative;
  }
  .el-menu{
    border:none !important;
  }
  .el-submenu__icon-arrow{
    width:0;
    height:0;
    color:transparent;
  }
  .el-submenu__icon-arrow:before{
    content:'' !important;
  }
  .el-submenu__icon-arrow:before{
    content:'' !important;
  }
  .el-submenu__title{
    background:rgba(44,55,71,1) !important;
    margin-bottom:5px;
    height:46px !important;
    line-height: 46px !important;
  }

  .el-menu.el-menu--inline{
    background-color: rgba(0,0,0,.2) !important;
  }

  .menulist-inner .menuItemBox.rowEnd span{
    color: #A7BAC6;
  }
  .menulist-inner .menuItemBox.rowEnd.activeMenu span{
    color: #fff;
  }
</style>

5.注冊全局組件

將menu組件注冊為全局組件唧取，方便需要的地方直接引入
到global-components.js文件中

/*
 全局組件引入注冊
  */

import Menu from "../global-components/menu" //菜單

export default {
    install(Vue) {
        Vue.component('Menu',Menu)
    }
};

6.到router文件夾寫好路由模塊

6.1 base-router.js中寫好我們需要的固定的路由

/**
 * 頁面上固定路由
 */
import Layout from '../views/layout/layout'
import Login from '../views/login/login'
import Loading from '../views/loading/loading'
const routes = [
    {
        path: '/',
        redirect: '/loading',
    },
    {
        path: '/layout',
        component:Layout,
        redirect: '/loading',
    },
    {
        path: '/login',
        name: 'Login',
        component: Login
    },
    {
        path: '/loading',
        name: 'Loading',
        component: Loading
    },
]
export default routes

6.2 lm-router.js中寫動態(tài)配置路由的方法


import {setUserRoutesData} from "../utils/global-methods";

const RouterPlugin = function() {
    this.$router = null
    this.$store = null
}
RouterPlugin.install = function(router, store) {
    this.$router = router
    this.$store = store
    this.$router.$lmRouter = {
        // 全局配置
        safe: this,
        // 動態(tài)路由
        formatRoutes:function (routes) {
            let routers=setUserRoutesData(routes)
            this.safe.$router.addRoutes(routers)
            return routers
        }
    }
}
export default RouterPlugin

6.3 index.js中寫路由入口

import Vue from 'vue'
import VueRouter from 'vue-router'
import baseRoutes from './base-router'
import store from '../store'
import LmRouter from './lm-router'


Vue.use(VueRouter)

const createRouter = () => {
    return new VueRouter({
        scrollBehavior (to, from, savedPosition) {
            if (savedPosition) {
                return savedPosition
            } else {
                return {
                    x: 0,
                    y: to.meta.savedPosition || 0
                }
            }
        },
        routes: [...baseRoutes],
        mode:'history',//
    })
}
let router = createRouter()
/**
resetRouter函數(shù)用于重置路由，每一次動態(tài)配置路由之前要先重置路由
**/
export function resetRouter() {
    const newRouter = createRouter()
    router.matcher = newRouter.matcher // reset router
    LmRouter.install(router, store)
}
/**
當用戶刷新頁面時划提，路由數(shù)據(jù)會丟失枫弟，如果已經(jīng)登錄，需要重新渲染路由鹏往。渲染的路由數(shù)據(jù)在登錄時存在瀏覽器本地
**/
if(sessionStorage.getItem('hasLogin')){
    let sessionMenus=localStorage.getItem('menus')
    sessionMenus=sessionMenus ? JSON.parse(sessionMenus) : []
    let sessionRoutes=localStorage.getItem('userRoutes')
    LmRouter.install(router, store)
    sessionRoutes=sessionRoutes ? JSON.parse(sessionRoutes) : []
    router.$lmRouter.formatRoutes(sessionRoutes, true)
    store.dispatch('setUserRoutes',sessionRoutes)
    store.dispatch('setMenus',sessionMenus)
}

router.beforeEach((to, from, next) => {
    let hasLogin = sessionStorage.getItem('hasLogin')
    // console.log(to, from)
    if(to.name===from.name){
        return
    }
    console.log(hasLogin)
    if(to.name==='Login'){
        sessionStorage.clear()
        localStorage.clear()
        store.state.userRoutes=[]
        store.state.menus=[]
        next({replace:true})
        resetRouter()
        return
    }
    if (!hasLogin) {
        next({path: '/login',replace:true})
        return
    }
    next()

})
/**
 * 解決element-ui點擊同一個菜單報錯
 * @type {VueRouter.push|*}
 */
const originalPush = VueRouter.prototype.push
VueRouter.prototype.push = function push(location) {
    return originalPush.call(this, location).catch(err => err)
}
export default router

7.容器頁和加載頁

大部分有二級菜單的頁面淡诗，父級頁面通常只需要路由跳轉功能，代碼一致伊履，為了精簡代碼韩容，我們新建通用的路由容器頁面layout.vue，二級菜單路由頁面經(jīng)layout頁面跳轉

為避免用戶在瀏覽器直接輸入唐瀑、粘貼路徑時群凶，或者直接訪問頁面根路徑時找不到路由（因為用戶可能已經(jīng)登錄了，但這是沒有已經(jīng)登錄界面）介褥，我們新建loading.vue座掘，當用戶粘貼路徑，或者訪問根路徑時柔滔，在loading.vue中渲染路由

7.1 layout.vue

<!--Layout-->
<template>
    <div>
        <header class="header">頭部</header>
        <div class="main">
            <div class="aside">
                <Menu/>
            </div>
            <div class="mainRight columnStart">
                <router-view></router-view>
            </div>
        </div>
    </div>
</template>

<script>
    export default {
        name: 'Layout',
    }
</script>

7.2 loading.vue

<!--加載頁面-->
<template>
    <div class="loadingBox">
        <div class="loadingContentbox columnCenter">
            <i class="el-icon-loading gray999"></i>
            <div class="gray999 font16">頁面加載中...</div>
        </div>

    </div>
</template>

<script>

    import {reqUserRoutes} from "../../api/common";
    import {setUserRoutesData,getAndFilterMenus,} from "../../utils/global-methods";

    export default {
        name: 'Loading',
        data() {
            return {}
        },
        computed: {},
        created(){
            let hasLogin = sessionStorage.getItem('hasLogin')
            if(!hasLogin){
                this.$router.replace('/login')
            }else{
                let menus=localStorage.getItem('menus')
                let userRoutes=localStorage.getItem('userRoutes')
                userRoutes=userRoutes ? JSON.parse(userRoutes) : []
                menus=menus ? JSON.parse(menus) : []
                if(!menus.length || !userRoutes.length){
                    this.getMenuRoutes()
                    return
                }
                let userInfo=getUserInfoFromLocalStorage()
                this.$store.dispatch('setUserInfo',userInfo)
                let {permissions=[]}=userInfo
                this.$store.dispatch('setPermissions',permissions)
                this.$router.replace((userRoutes[0] && userRoutes[0].path) ? userRoutes[0].path : '/404')
            }
        },
        methods: {
            //獲取菜單和路由
            async getMenuRoutes(){
                let userRoutes=await reqUserRoutes()
                console.log(userRoutes)
                let menus=getAndFilterMenus(JSON.parse(JSON.stringify(userRoutes)))
                if(!menus.length){
                    this.$router.replace('/login')
                    return
                }
                localStorage.setItem('userRoutes',JSON.stringify(userRoutes))
                localStorage.setItem('menus',JSON.stringify(menus))
                userRoutes=setUserRoutesData([...userRoutes])
                this.$store.dispatch('setUserRoutes',userRoutes)
                this.$store.dispatch('setMenus',menus)
                this.$router.addRoutes([...userRoutes])
                this.$router.replace((userRoutes[0] && userRoutes[0].path) ? userRoutes[0].path : '/404')
            }
        },

    }
</script>

<style scoped lang="scss">
    .loadingBox{
        .loadingContentbox{
            position: absolute;
            left:50%;
            top:50%;
            -webkit-transform: translate(-50%,-50%);
            -moz-transform: translate(-50%,-50%);
            -ms-transform: translate(-50%,-50%);
            -o-transform: translate(-50%,-50%);
            transform: translate(-50%,-50%);
            .el-icon-loading{
                font-size: 40px;
                margin-bottom:10px;
            }
        }
    }
</style>

8.寫篩選菜單和路由的方法

到utils溢陪，global-methods.js中寫菜單篩選和路由數(shù)據(jù)方法
首先我們假設后端返回的數(shù)據(jù)為如下結構（僅列出關鍵字段）

[
  {
    label:'人員管理',
    path:'/person',
    isLeftMenu:1,
    routeName:'Person',
    isContainer:1,
    children:[
     {
        label:'人員列表',
        path:'/person/person-list',
        routeName:'PersonList',
         isLeftMenu:1,
         component:'/person/person-list',
    },
     {
        label:'新增人員',
        path:'/person/person-add',
        routeName:'PersonAdd',
         component:'/person/person-add',
         isLeftMenu:0
     }
    ]
  },
    {
      label:'訂單管理',
      path:'/order',
      isLeftMenu:1,
      routeName:'Order',
       component:'/order/order',
      isContainer:0,
    }
]

其中 label 為菜單顯示標題，path 是路由路徑睛廊，isLeftMenu用于區(qū)分是否為菜單形真，這里isLeftMenu=1表示是菜單，routeName路由名,isContainer用于區(qū)分路由是否經(jīng)過容器組件layout，這里isContainer=1表示使用layout容器,component用于指定組件引入的路徑
根據(jù)上面的數(shù)據(jù)結構咆霜，我們新建好對應得vue文件
結構如下圖：