vue許可權路由實現方式總結

若邪發表於2018-07-28
Vue路由

使用全域性路由守衛

實現

前端定義好路由，並且在路由上標記相應的許可權資訊

const routerMap = [
  {
    path: '/permission',
    component: Layout,
    redirect: '/permission/index',
    alwaysShow: true, // will always show the root menu
    meta: {
      title: 'permission',
      icon: 'lock',
      roles: ['admin', 'editor'] // you can set roles in root nav
    },
    children: [{
      path: 'page',
      component: () => import('@/views/permission/page'),
      name: 'pagePermission',
      meta: {
        title: 'pagePermission',
        roles: ['admin'] // or you can only set roles in sub nav
      }
    }, {
      path: 'directive',
      component: () => import('@/views/permission/directive'),
      name: 'directivePermission',
      meta: {
        title: 'directivePermission'
        // if do not set roles, means: this page does not require permission
      }
    }]
  }]
複製程式碼

全域性路由守衛每次都判斷使用者是否已經登入，沒有登入則跳到登入頁。已經登入(已經取得後臺返回的使用者的許可權資訊(角色之類的))，則判斷當前要跳轉的路由，使用者是否有許可權訪問(根據路由名稱到全部路由裡找到對應的路由，判斷使用者是否具備路由上標註的許可權資訊(比如上面的roles: ['admin', 'editor']))。沒有許可權則跳到事先定義好的介面(403,404之類的)。

這種方式，選單可以直接用路由生成(使用者沒有許可權的選單也會顯示，點選跳轉的時候才做許可權判斷)，也可以在使用者登入後根據使用者許可權把路由過濾一遍生成選單(選單需要儲存在vuex裡)。

目前iview-admin還是用的這種方式

缺點

  • 載入所有的路由，如果路由很多，而使用者並不是所有的路由都有許可權訪問，對效能會有影響。

  • 全域性路由守衛裡，每次路由跳轉都要做許可權判斷。

  • 選單資訊寫死在前端，要改個顯示文字或許可權資訊，需要重新編譯

  • 選單跟路由耦合在一起，定義路由的時候還有新增選單顯示標題，圖示之類的資訊，而且路由不一定作為選單顯示，還要多加欄位進行標識

登入頁與主應用分離

針對前一種實現方式的缺點，可以將登入頁與主應用放到不同的頁面(不在同一個vue應用例項裡)。

實現

登入成功後，進行頁面跳轉(真正的頁面跳轉，不是路由跳轉)，並將使用者許可權傳遞到主應用所在頁面，主應用初始化之前，根據使用者許可權篩選路由，篩選後的路由作為vue的例項化引數，而不是像前一種方式所有的路由都傳遞進去，也不需要在全域性路由守衛裡做許可權判斷了。

缺點

  • 需要做頁面跳轉，不是純粹的單頁應用
  • 選單資訊寫死在前端，要改個顯示文字或許可權資訊，需要重新編譯
  • 選單跟路由耦合在一起，定義路由的時候還有新增選單顯示標題，圖示之類的資訊，而且路由不一定作為選單顯示，還要多加欄位進行標識

使用addRoutes動態掛載路由

addRoutes允許在應用初始化之後，動態的掛載路由。有了這個新姿勢，就不用像前一種方式那樣要在應用初始化之要對路由進行篩選。

實現

應用初始化的時候先掛載不需要許可權控制的路由，比如登入頁，404等錯誤頁。

有個問題，addRoutes應該何時呼叫，在哪裡呼叫

登入後，獲取使用者的許可權資訊，然後篩選有許可權訪問的路由，再呼叫addRoutes新增路由。這個方法是可行的。但是不可能每次進入應用都需要登入，使用者重新整理瀏覽器又要登陸一次。

所以addRoutes還是要在全域性路由守衛裡進行呼叫

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' // getToken from cookie

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

// permission judge function
function hasPermission(roles, permissionRoles) {
  if (roles.indexOf('admin') >= 0) return true // admin permission passed directly
  if (!permissionRoles) return true
  return roles.some(role => permissionRoles.indexOf(role) >= 0)
}

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

router.beforeEach((to, from, next) => {
  NProgress.start() // start progress bar
  if (getToken()) { // determine if there has token
    /* has token*/
    if (to.path === '/login') {
      next({ path: '/' })
      NProgress.done() // if current page is dashboard will not trigger	afterEach hook, so manually handle it
    } else {
      if (store.getters.roles.length === 0) { // 判斷當前使用者是否已拉取完user_info資訊
        store.dispatch('GetUserInfo').then(res => { // 拉取user_info
          const roles = res.data.roles // note: roles must be a array! such as: ['editor','develop']
          store.dispatch('GenerateRoutes', { roles }).then(() => { // 根據roles許可權生成可訪問的路由表
            router.addRoutes(store.getters.addRouters) // 動態新增可訪問路由表
            next({ ...to, replace: true }) // hack方法 確保addRoutes已完成 ,set the replace: true so the navigation will not leave a history record
          })
        }).catch((err) => {
          store.dispatch('FedLogOut').then(() => {
            Message.error(err || 'Verification failed, please login again')
            next({ path: '/' })
          })
        })
      } else {
        // 沒有動態改變許可權的需求可直接next() 刪除下方許可權判斷 ↓
        if (hasPermission(store.getters.roles, to.meta.roles)) {
          next()//
        } else {
          next({ path: '/401', replace: true, query: { noGoBack: true }})
        }
        // 可刪 ↑
      }
    }
  } else {
    /* has no token*/
    if (whiteList.indexOf(to.path) !== -1) { // 在免登入白名單，直接進入
      next()
    } else {
      next('/login') // 否則全部重定向到登入頁
      NProgress.done() // if current page is login will not trigger afterEach hook, so manually handle it
    }
  }
})

router.afterEach(() => {
  NProgress.done() // finish progress bar
})
複製程式碼

關鍵的程式碼如下

if (store.getters.roles.length === 0) { // 判斷當前使用者是否已拉取完user_info資訊
        store.dispatch('GetUserInfo').then(res => { // 拉取user_info
          const roles = res.data.roles // note: roles must be a array! such as: ['editor','develop']
          store.dispatch('GenerateRoutes', { roles }).then(() => { // 根據roles許可權生成可訪問的路由表
            router.addRoutes(store.getters.addRouters) // 動態新增可訪問路由表
            next({ ...to, replace: true }) // hack方法 確保addRoutes已完成 ,set the replace: true so the navigation will not leave a history record
          })
        }).catch((err) => {
          store.dispatch('FedLogOut').then(() => {
            Message.error(err || 'Verification failed, please login again')
            next({ path: '/' })
          })
        })
複製程式碼

上面的程式碼就是vue-element-admin的實現

缺點

  • 全域性路由守衛裡，每次路由跳轉都要做判斷
  • 選單資訊寫死在前端，要改個顯示文字或許可權資訊，需要重新編譯
  • 選單跟路由耦合在一起，定義路由的時候還有新增選單顯示標題，圖示之類的資訊，而且路由不一定作為選單顯示，還要多加欄位進行標識

選單與路由分離，選單由後端返回

選單的顯示標題，圖片等需要隨時更改，要對選單做管理功能。

後端直接根據使用者許可權返回可訪問的選單。

實現

前端定義路由資訊(標準的路由定義，不需要加其他標記欄位)。

{
    name: "login",
    path: "/login",
    component: () => import("@/pages/Login.vue")
}
複製程式碼

name欄位都不為空，需要根據此欄位與後端返回選單做關聯。

做選單管理功能的時候，一定要有個欄位與前端的路由的name欄位對應上(也可以是其他欄位，只要選單能找到對應的路由或者路由能找到對應的選單就行)，並且做唯一性校驗。選單上還需要定義許可權欄位，可以是一個或多個。其他資訊，比如顯示標題，圖示，排序，鎖定之類的，可以根據實際需求進行設計。

vue許可權路由實現方式總結

還是在全域性路由守衛裡做判斷

function hasPermission(router, accessMenu) {
  if (whiteList.indexOf(router.path) !== -1) {
    return true;
  }
  let menu = Util.getMenuByName(router.name, accessMenu);
  if (menu.name) {
    return true;
  }
  return false;

}

Router.beforeEach(async (to, from, next) => {
  if (getToken()) {
    let userInfo = store.state.user.userInfo;
    if (!userInfo.name) {
      try {
        await store.dispatch("GetUserInfo")
        await store.dispatch('updateAccessMenu')
        if (to.path === '/login') {
          next({ name: 'home_index' })
        } else {
          //Util.toDefaultPage([...routers], to.name, router, next);
          next({ ...to, replace: true })//選單許可權更新完成,重新進一次當前路由
        }
      }  
      catch (e) {
        if (whiteList.indexOf(to.path) !== -1) { // 在免登入白名單，直接進入
          next()
        } else {
          next('/login')
        }
      }
    } else {
      if (to.path === '/login') {
        next({ name: 'home_index' })
      } else {
        if (hasPermission(to, store.getters.accessMenu)) {
          Util.toDefaultPage(store.getters.accessMenu,to, routes, next);
        } else {
          next({ path: '/403',replace:true })
        }
      }
    }
  } else {
    if (whiteList.indexOf(to.path) !== -1) { // 在免登入白名單，直接進入
      next()
    } else {
      next('/login')
    }
  }
  let menu = Util.getMenuByName(to.name, store.getters.accessMenu);
  Util.title(menu.title);
});

Router.afterEach((to) => {
  window.scrollTo(0, 0);
});

複製程式碼

上面程式碼是vue-quasar-admin的實現。因為沒有使用addRoutes,每次路由跳轉的時候都要判斷許可權，這裡的判斷也很簡單，因為選單的name與路由的name是一一對應的,而後端返回的選單就已經是經過許可權過濾的，所以如果根據路由name找不到對應的選單，就表示使用者有沒許可權訪問。

如果路由很多，可以在應用初始化的時候，只掛載不需要許可權控制的路由。取得後端返回的選單後，根據選單與路由的對應關係，篩選出可訪問的路由，通過addRoutes動態掛載。

缺點

  • 選單需要與路由做一一對應，前端新增了新功能，需要通過選單管理功能新增新的選單，如果選單配置的不對會導致應用不能正常使用
  • 全域性路由守衛裡，每次路由跳轉都要做判斷

選單與路由完全由後端返回

選單由後端返回是可行的，但是路由由後端返回呢？看一下路由的定義

{
    name: "login",
    path: "/login",
    component: () => import("@/pages/Login.vue")
}
複製程式碼

後端如果直接返回

{
    "name": "login",
    "path": "/login",
    "component": "() => import('@/pages/Login.vue')"
}
複製程式碼

這是什麼鬼，明顯不行。() => import('@/pages/Login.vue')這程式碼如果沒出現在前端，webpack不會對Login.vue進行編譯打包

實現

前端統一定義路由元件，比如

const Home = () => import("../pages/Home.vue");
const UserInfo = () => import("../pages/UserInfo.vue");
export default {
  home: Home,
  userInfo: UserInfo
};
複製程式碼

將路由元件定義為這種key-value的結構。

後端返回格式

[
      {
        name: "home",
        path: "/",
        component: "home"
      },
      {
        name: "home",
        path: "/userinfo",
        component: "userInfo"
      }
]
複製程式碼

在將後端返回路由通過addRoutes動態掛載之間，需要將資料處理一下，將component欄位換為真正的元件。

至於選單與路由是否還要分離，怎麼對應，可以根據實際需求進行處理。

如果有巢狀路由，後端功能設計的時候，要注意新增相應的欄位。前端拿到資料也要做相應的處理。

缺點

  • 全域性路由守衛裡，每次路由跳轉都要做判斷
  • 前後端的配合要求更高

不使用全域性路由守衛

前面幾種方式，除了登入頁與主應用分離,每次路由跳轉，都在全域性路由守衛裡做了判斷。

實現

應用初始化的時候只掛載不需要許可權控制的路由

const constRouterMap = [
  {
    name: "login",
    path: "/login",
    component: () => import("@/pages/Login.vue")
  },
  {
    path: "/404",
    component: () => import("@/pages/Page404.vue")
  },
  {
    path: "/init",
    component: () => import("@/pages/Init.vue")
  },
  {
    path: "*",
    redirect: "/404"
  }
];
export default constRouterMap;
複製程式碼
import Vue from "vue";
import Router from "vue-router";
import ConstantRouterMap from "./routers";

Vue.use(Router);

export default new Router({
  // mode: 'history', // require service support
  scrollBehavior: () => ({ y: 0 }),
  routes: ConstantRouterMap
});
複製程式碼

登入成功後跳到/路由

submitForm(formName) {
      let _this=this;
      this.$refs[formName].validate(valid => {
        if (valid) {
          _this.$store.dispatch("loginByUserName",{
            name:_this.ruleForm2.name,
            pass:_this.ruleForm2.pass
          }).then(()=>{
            _this.$router.push({
              path:'/'
            })
          })
        } else {
          
          return false;
        }
      });
    }
複製程式碼

因為當前沒有/路由，會跳到/404

<template>
  <h1>404</h1>
</template>
<script>
export default {
  name:'page404',
  mounted(){
    if(!this.$store.state.isLogin){
      this.$router.replace({ path: '/login' });
      return;
    }
    if(!this.$store.state.initedApp){
       this.$router.replace({ path: '/init' });
       return
    }
  }
}
</script>
複製程式碼

404元件裡判斷已經登入，接著判斷應用是否已經初始化(使用者許可權資訊，可訪問選單，路由等是否已經從後端取得)。沒有初始化則跳轉到/init路由

<template>
  <div></div>
</template>
<script>
import { getAccessMenuList } from "../mock/menus";
import components from "../router/routerComponents.js";
export default {
  async mounted() {
    if (!this.$store.state.isLogin) {
      this.$router.push({ path: "/login" });
      return;
    }
    if (!this.$store.state.initedApp) {
      const loading = this.$loading({
        lock: true,
        text: "初始化中",
        spinner: "el-icon-loading",
        background: "rgba(0, 0, 0, 0.7)"
      });
      let menus = await getAccessMenuList(); //模擬從後端獲取
      var routers = [...menus];
      for (let router of routers) {
        let component = components[router.component];
        router.component = component;
      }
      this.$router.addRoutes(routers);
      this.$store.dispatch("setAccessMenuList", menus).then(() => {
        loading.close();
        this.$router.replace({
          path: "/"
        });
      });
      return;
    } else {
      this.$router.replace({
        path: "/"
      });
    }
  }
};
</script>

複製程式碼

init元件裡判斷應用是否已經初始化(避免初始化後，直接從位址列輸入地址再次進入當前元件)。

如果已經初始化，跳轉/路由(如果後端返回的路由裡沒有定義次路由，則會跳轉404)。

沒有初始化，則呼叫遠端介面獲取選單和路由等，然後處理後端返回的路由，將component賦值為真正 的元件，接著呼叫addRoutes掛載新路由，最後跳轉/路由即可。選單的處理也是在此處，看實際 需求。

實現例子

缺點

  • 在404頁面做了判斷，感覺比較怪異
  • 多引入了一個init頁面元件

總結

比較推薦後面兩種實現方式。

相關文章