vue-element-admin 动态路由（权限管控）

利用vue-admin-template进行二次开发,只记录了路由权限的设置

第一次使用该框架做细分化的权限分配,有些地方有问题还望大佬指导下,后端返回给我的是数组,需要里面对象的"permissionName"的值,路由这边是由前端写上根据后端返回的来的name值进行做判断渲染

后端返回我的数据结构

1.在api/user.js 修改权限对应后端接口的url,便可正常访问到后端接口数据

2.基础路由router/index.js中constantRoutes里面通用部分,asyncRoutes里面权限部分

{
    path: '/',
    component: Layout,
    redirect: '/account',
    name: 'account',  //通过name来判断权限
    meta: { title: 'XXX', icon: 'XXX'  },
    children: [
      {
        path: '/account/admin',
        name: 'admin',
        component: () => import('@/views'),
        meta: { title: 'XXX' },
        hidden: false
      }}

3.路由权限的获取store/modules/user.js，在登录之后，通过DongtRouter这个接口，获取到后端传来的列表，并保存（commit）在vuex中

import { login, DongtRouter, getInfo } from '@/api/user'
import { getToken, setToken, removeToken } from '@/utils/auth'
import router, { resetRouter } from '@/router'

const state = {
  token: getToken(),
  name: '',
  avatar: '',
  roles: [] //新增
}

const mutations = {
  SET_TOKEN: (state, token) => {
    state.token = token
  },
  SET_NAME: (state, nickname) => {
    state.nickname = nickname
  },
  SET_AVATAR: (state, avatar) => {
    state.avatar = avatar
  },
  //新增
  SET_ROLES: (state, roles) => {
    state.roles = roles
  }
}

const actions = {
  //登录验证
  login({ commit }, userInfo) {
    const { account, password } = userInfo
    return new Promise((resolve, reject) => {
      login({ account: account.trim(), password: password }).then(response => {
        const { data } = response
        commit('SET_TOKEN', data.accessToken)
        setToken(data.accessToken)
        resolve()
      }).catch(error => {
        reject(error)
      })
    })
  },

  // get user info
  getInfo({ commit, state }) {
    return new Promise((resolve, reject) => {
      getInfo(state.token).then(response => {
        const { data } = response

        if (!data) {
          reject('Verification failed, please Login again.')
        }
        const { nickname, avatar } = data
        commit('SET_NAME', nickname)
        commit('SET_AVATAR', avatar)
        resolve(data)
      }).catch(error => {
        reject(error)
      })
    })
  },
//因为接口没有基本信息在一起,单独写了一个方法来循环后端返回的数组取到里面的name值   //新增
  DongtRouter({ commit, state }) {
    return new Promise((resolve, reject) => {
      DongtRouter().then(response => {
        const { list } = response.data
        if (!list) {
          reject('验证失败，请重新登录')
        }
        const arr = []
        for (let i = 0; i < list.length; i++) {
          const arrOne = list[i];
          arr.push(arrOne.permissionName)
        }
        const roles = arr
        // debugger
        // roles must be a non-empty array
        if (!roles || roles.length <= 0) {
          reject('DongtRouter:角色必须是非空数组!')
        }
        // debugger
        commit('SET_ROLES', roles)
        resolve(roles)
      }).catch(error => {
        reject(error)
      })
    })
  },


   // user logout
   logout({ commit, state }) {
    return new Promise((resolve, reject) => {
      removeToken()
      resetRouter()
      resolve()
    })
  },

  // remove token
  resetToken({ commit }) {
    return new Promise(resolve => {
      commit('SET_TOKEN', '')
      commit('SET_ROLES', [])
      removeToken()
      resolve()
    })
  },

  // dynamically modify permissions
  async changeRoles({ commit, dispatch }, role) {
    const token = role + '-token'
    commit('SET_TOKEN', token)
    setToken(token)

    const roles = await dispatch('DongtRouter')
    resetRouter()
    // generate accessible routes map based on roles
    const accessRoutes = await dispatch('permission/generateRoutes', roles, { root: true })
    // dynamically add accessible routes
    router.addRoutes(accessRoutes)

    // reset visited views and cached views
    dispatch('tagsView/delAllViews', null, { root: true })
  }
}

export default {
  namespaced: true,
  state,
  mutations,
  actions
}

然后需要设置对外获取途径store/getters.js

const getters = {
  sidebar: state => state.app.sidebar,
  device: state => state.app.device,
  token: state => state.user.token,
  avatar: state => state.user.avatar,
  name: state => state.user.name,
  roles: state => state.user.roles,//新增
}
export default getters

4.动态生成权限路由（核心）
根据环境配置导入组件,在vue中，将菜单路径作为参数，实现路由地址的注入
在 src/router 文件夹下，建立两个文件，各只需添加一行代码, 定义导入方法，此时设置@/，那么在后端传来的路由数据中就需要标明/views这个目前项目中放置组件的目录结构

src/router/_import_development.js

// 开发环境导入组件
module.exports = file => require('@/' + file + '.vue').default // vue-loader at least v13.0.0+

src/router/_import_production.js

// 生产环境导入组件
module.exports = file => () => import('@/' + file + '.vue')

5.动态菜单配置文件permission.js

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

//这里把上面的文件引入进来
import Layout from '@/layout'
const _import = require('./router/_import_' + process.env.NODE_ENV + '.js') // 获取组件的方法

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() // hack: https://github.com/PanJiaChen/vue-element-admin/pull/2939
    } else {
      // determine whether the user has obtained his permission roles through getInfo
      const hasRoles = store.getters.roles && store.getters.roles.length > 0
      if (hasRoles) {
        next()
      } else {
        try {
          await store.dispatch('user/getInfo')
          //这里是获取后端我处理好的name值
          const roles = await store.dispatch('user/DongtRouter')
    
          if (!roles || roles.length <= 0) {
            reject("getInfo: roles must be a non-null array!");
          }
          global.antRouter = []
          // generate accessible routes map based on roles基于角色生成可访问路由图
          const accessRoutes = await store.dispatch('permission/generateRoutes', roles)
          // 调用 router.addRoutes 动态添加路由
          router.addRoutes(accessRoutes)
          //accessRoutes
          global.antRouter = accessRoutes
          // 使用 replace 访问路由，不会在 history 中留下记录
          next({ ...to, replace: true })
        } catch (error) {
          // 移除 Token 数据
          await store.dispatch('user/resetToken')
          // 显示提示错误
          Message.error(error || 'Has Error')
          // 重定向到 login 页面
          next(`/login?redirect=${to.path}`)
          // 停止进度条
          NProgress.done()
        }
      }
    }
  } else {
    /* 不存在 token*/
    // 判断访问的 URL 是否在白名单中
    if (whiteList.indexOf(to.path) !== -1) {
      // in the free login whitelist, go directly
      next()
    } else {
      // 如果访问的 URL 不在白名单中，则直接重定向到登录页面，并将访问的 URL 添加到 redirect 参数中
      next(`/login?redirect=${to.path}`)
      NProgress.done()
    }
  }
})

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

//导入permission/generateRoutes//调用的permission/generateRoutes需要在store/index.js导入模块
//store/index.js
import Vue from 'vue'
import Vuex from 'vuex'
import getters from './getters'
import app from './modules/app'
import settings from './modules/settings'
import user from './modules/user'
import permission from './modules/permission'//新增模块

Vue.use(Vuex)

const store = new Vuex.Store({
  modules: {
    app,
    settings,
    user,
    permission//新增
  },
  getters
})

export default store

6.因为这边是根据name值来判断路由显示与否,所以要到store/modules/permission.js里面把“hasPermission”函数里面的判断进行修改

import { asyncRoutes, constantRoutes } from '@/router'

/**
 * Use meta.role to determine if the current user has permission
 * @param roles
 * @param route
 */
function hasPermission(roles, route) {
//修改这里判断name
  if (route.name && route) {
    return roles.some(role => route.name.includes(role))
  } else {
    return true
  }
}

/**
 * Filter asynchronous routing tables by recursion
 * @param routes asyncRoutes
 * @param roles
 */
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
}

const state = {
  routes: [],
  addRoutes: []
}

const mutations = {
  SET_ROUTES: (state, routes) => {
    state.addRoutes = routes
    state.routes = constantRoutes.concat(routes)
  }
}

const actions = {
  generateRoutes({ commit }, roles) {
    return new Promise(resolve => {
      let accessedRoutes
      //这里注释了判断直接让它进入了下个函数
      // if (roles.includes(roles)) {
      //   accessedRoutes = asyncRoutes || []
      // } else {
      accessedRoutes = filterAsyncRoutes(asyncRoutes, roles)
      // }
      commit('SET_ROUTES', accessedRoutes)
      resolve(accessedRoutes)
    })
  }
}

export default {
  namespaced: true,
  state,
  mutations,
  actions
}

7.最后一步合并路由侧边栏渲染,把路由合并进行for循环渲染

<template>
  <div :class="{'has-logo':showLogo}">
    <logo v-if="showLogo" :collapse="isCollapse" />
    <el-scrollbar wrap-class="scrollbar-wrapper">
      <el-menu
        :default-active="activeMenu"
        :collapse="isCollapse"
        :background-color="variables.menuBg"
        :text-color="variables.menuText"
        :unique-opened="false"
        :active-text-color="variables.menuActiveText"
        :collapse-transition="false"
        mode="vertical"
      >
        <sidebar-item v-for="route in routes" :key="route.path" :item="route" :base-path="route.path" />
      </el-menu>
    </el-scrollbar>
  </div>
</template>

<script>
import { mapGetters } from 'vuex'
import Logo from './Logo'
import SidebarItem from './SidebarItem'
import variables from '@/styles/variables.scss'

export default {
  components: { SidebarItem, Logo },
  computed: {
    ...mapGetters([
      'sidebar'
    ]),
    routes() {
      // return this.$router.options.routes
      return this.$router.options.routes.concat(global.antRouter) // 最后渲染时，基础路由和动态路由合并
    },
    activeMenu() {
      const route = this.$route
      const { meta, path } = route
      // 如果这个方法点击子页面无法让它的主页面导航高亮
      if (meta.activeMenu) {
        return meta.activeMenu
      }
      return path
      //就可以采用下面这个方法
       return this.$route.meta.GuidePath? this.$route.meta.JumpPath : this.$route.path;
    },
    showLogo() {
      return this.$store.state.settings.sidebarLogo
    },
    variables() {
      return variables
    },
    isCollapse() {
      return !this.sidebar.opened
    }
  }
}
</script>