Spring Security (三):與Vue.js整合

ywbjja發表於2019-01-14

本篇內容較長,先看下效果:


然後側邊欄的路由其實根據我們後臺獲取到的:(這個資料結構比較簡單,在這裡只是演示)

{
"code"200,
"msg""",
"data": {
    "id""1",
    "username""admin",
    "roles": [
        {
            "id"1,
            "describe"null,
            "rolename""ROLE_ADMIN",
            "permissions"null
        }
    ],
    "menus": [
        {
            "per_id"1101,
            "per_paerent_id"0,
            "per_name""許可權管理",
            "per_resource""auth",
            "children": [
                {
                    "per_id"1102,
                    "per_paerent_id"1101,
                    "per_name""角色管理",
                    "per_resource""role",
                    "children"null
                },
                {
                    "per_id"1103,
                    "per_paerent_id"1101,
                    "per_name""資源管理",
                    "per_resource""per",
                    "children"null
                }
            ]
        }
      ]
    }
}
複製程式碼

由於本人是個後端小辣雞,前端對我來說簡直就是地獄…就使用了GitHub上的輪子試著改了一下。感謝@PanJiaChen 的專案,我就使用了其中的模板來做的,如果有什麼不完美的希望指出。

主要步驟

在前後端分離專案中我們前端只需要對資料進行渲染就ok了。目前後端已經可以成功給我們返回了使用者資訊,前端實現許可權體系的主要思路是

  1. 首先就是查詢使用者具有的許可權資源資訊,然後我們前端根據這個資訊,然後從所有的路由頁面中動態的載入使用者具有的路由頁面。並且在沒有訪問許可權的時候提示無許可權。
  2. 由於Vue2.2.0以後新增了router.addRoutes,我們就可以通過這個來新增使用者的路由即可~
  3. 本專案側邊欄和路由是一個檔案,所以我們要按照一定的規則去設定路由。具體方法見:vue-element-admin

使用者資訊

首先修改login介面:src\api\login.js修改為Spring Boot的介面。

import request from '@/utils/request'
/**
 * 登入操作
 * @param {使用者名稱} username
 * @param {密碼} password
 */

export function login(username, password{
  return request({
    url'/auth/login',
    method'post',
    data: {
      username,
      password
    }
  })
}
/**
 * 獲取使用者資訊
 * @param {token} token
 */

export function getInfo(token{
  return request({
    url'/getUserInfo',
    method'get',
    params: { token }
  })
}

export function logout({
  return request({
    url'user/logout',
    method'post'
  })
}
複製程式碼

修改dev.env.js為本地介面

'use strict'
const merge = require('webpack-merge')
const prodEnv = require('./prod.env')

module.exports = merge(prodEnv, {
  NODE_ENV'"development"',
  BASE_API'"http://localhost:8086"',
})
複製程式碼

修改axios配置檔案

import axios from 'axios'
import { Message, MessageBox } from 'element-ui'
import store from '../store'
import { getToken } from '@/utils/auth'

// 建立axios例項
const service = axios.create({
  baseURL: process.env.BASE_API, // api 的 base_url
  timeout: 5000 // 請求超時時間
})

// request攔截器
service.interceptors.request.use(
  config => {
if (store.getters.token) {
    // 這裡修改為'jwtHeader'
  config.headers['jwtHeader'] = getToken() // 讓每個請求攜帶自定義token 請根據實際情況自行修改
}
return config
  },
  error => {
    // Do something with request error
    console.log(error) // for debug
    Promise.reject(error)
  }
)

// response 攔截器
service.interceptors.response.use(
  response => {
/**
 * code為非200是拋錯 可結合自己業務進行修改
 */

const res = response.data
if (res.code !== 200) {
  Message({
    message: res.message,
    type'error',
    duration5 * 1000
  })

  // 50008:非法的token; 50012:其他客戶端登入了;  50014:Token 過期了;
  if (res.code === 500 || res.code === 500 || res.code === 500) {
    MessageBox.confirm(
      '你已被登出,可以取消繼續留在該頁面,或者重新登入',
      '確定登出',
      {
        confirmButtonText'重新登入',
        cancelButtonText'取消',
        type'warning'
      }
    ).then(() => {
      store.dispatch('FedLogOut').then(() => {
        location.reload() // 為了重新例項化vue-router物件 避免bug
      })
    })
  }
  return Promise.reject('error')
else {
  return response.data
}
  },
  error => {
    console.log('err' + error) // for debug
    Message({
      message: error.message,
      type'error',
      duration5 * 1000
    })
    return Promise.reject(error)
  }
)

export default service
複製程式碼

以上都是最基本的連線配置。

路由配置

src\router\index.js

import Vue from 'vue'
import Router from 'vue-router'

// in development-env not use lazy-loading, because lazy-loading too many pages will cause webpack hot update too slow. so only in production use lazy-loading;
// detail: https://panjiachen.github.io/vue-element-admin-site/#/lazy-loading

Vue.use(Router)

/* Layout */
import Layout from '../views/layout/Layout'

/**
* hidden: true                   if `hidden:true` will not show in the sidebar(default is false)
* alwaysShow: true               if set true, will always show the root menu, whatever its child routes length
*                                if not set alwaysShow, only more than one route under the children
*                                it will becomes nested mode, otherwise not show the root menu
* redirect: noredirect           if `redirect:noredirect` will no redirect in the breadcrumb
* name:'router-name'             the name is used by <keep-alive> (must set!!!)
* meta : {
    title: 'title'               the name show in submenu and breadcrumb (recommend set)
    icon: 'svg-name'             the icon show in the sidebar
    breadcrumb: false            if false, the item will hidden in breadcrumb(default is true)
  }
**/


// 所有許可權通用路由表
// 這裡就是一些公共介面如,錯誤提示頁面,登入頁面是不需要許可權的就可以在這個裡面配置

export const constantRouterMap = [
  {
    path'/login',
    name'Login',
    component() =>
      import('@/views/login/index'),
    hiddentrue
  },

  {
    path'/',
    component: Layout,
    redirect'/dashboard',
    name'Dashboard',
    hiddentrue,
    children: [{
      path'dashboard',
      component() =>
        import('@/views/dashboard/index')
    }, {
      path'userinfo',
      name'UserInfo',
      component() =>
        import('@/views/dashboard/userinfo')
    }]
  },
  {
    path'*',
    redirect'/404',
    hiddentrue
  }
]

export default new Router({
  // mode: 'history', //後端支援可開
  scrollBehavior: () => ({ y0 }),
  routes: constantRouterMap
})
// 非同步掛載的路由
// 動態需要根據許可權載入的路由表(這裡的路由時用來動態載入的,通俗點講就是需要許可權控制的路由都在這個裡面配置)
export const asyncRouterMap = [
  {
    path'/auth',
    component: Layout,
    name'auth',
    meta: {
      resources'auth',
      title'許可權管理'
    },
    children: [
      {
        path'per',
        component() => import('@/views/pre/perm/index'),
        name'per',
        meta: {
          resources'per'
        }
      },
      {
        path'user',
        component() => import('@/views/pre/user/index'),
        name'user',
        meta: {
          resources'user'
        }
      },
      {
        path'role',
        component() => import('@/views/pre/role/index'),
        name'role',
        meta: {
          resources'role'
        }
      }
    ]
  }
]
複製程式碼

然後你需要根據import的指令去新增相應的Vue檔案。

許可權控制

其實也就是拿著後臺獲取到的路由,然後和上面配置的路由進行判斷,如果符合就加到使用者的真實路由中。
1、首先修改src\store\modules\user.js

import { login, logout, getInfo } from '@/api/login'
import { getToken, setToken, removeToken } from '@/utils/auth'

const user = {
  state: {
    token: getToken(),
    username'',
    user: {},
    roles: [], // 使用者角色列表
    menus: [] // 選單列表
  },

  mutations: {
    SET_TOKEN(state, token) => {
      state.token = token
    },
    SET_INFO(state, user) => {
      state.username = user.username
      state.user = user
    },
    SET_MENUS(state, menus) => {
      state.menus = menus
    },
    SET_ROLES(state, roles) => {
      state.roles = roles
    }
  },

  actions: {
    // 登入
    Login({ commit }, userInfo) {
      const username = userInfo.username.trim()
      return new Promise((resolve, reject) => {
        login(username, userInfo.password).then(res => {
          const data = res.data
          setToken(data)
          commit('SET_TOKEN', data)
          resolve()
        }).catch(error => {
          reject(error)
        })
      })
    },

    // 獲取使用者資訊
    GetInfo({ commit, state }) {
      return new Promise((resolve, reject) => {
        getInfo(state.token).then(response => {
          const data = response.data
          if (data.roles && data.roles.length > 0) { // 驗證返回的roles是否是一個非空陣列
            commit('SET_ROLES', data.roles)
          } else {
            reject('getInfo: roles must be a non-null array !')
          }
          commit('SET_MENUS', data.menus)
          commit('SET_INFO', data)
          resolve(response)
        }).catch(error => {
          reject(error)
        })
      })
    },

    // 登出
    LogOut({ commit, state }) {
      return new Promise((resolve, reject) => {
        logout(state.token).then(() => {
          commit('SET_TOKEN''')
          commit('SET_ROLES', [])
          commit('SET_INFO''')
          removeToken()
          resolve()
        }).catch(error => {
          reject(error)
        })
      })
    },

    // 前端 登出
    FedLogOut({ commit }) {
      return new Promise(resolve => {
        commit('SET_TOKEN''')
        removeToken()
        resolve()
      })
    }
  }
}

export default user
複製程式碼

這裡使用了Vuex進行狀態管理,重點關注下actions中的LoginGetInfo方法,Login則是登入之後獲取到token然後把token儲存,然後GetInfo就是拿著token去請求介面獲取使用者角色、許可權資源資訊了。

建立一個新檔案 src\store\modules\permission.js

2、這個檔案的作用就是處理路由,把從後臺獲取的路由和我們配置的asyncRouterMap進行匹配,然後就返回使用者當前真實的路由了…也就是幾個forEach然後把公共的和當前使用者的路由addRouters就搞定了。

// store/permission.js
import { asyncRouterMap, constantRouterMap } from '@/router'

/**
 *
 * @param  {Array} userRouter 後臺介面請求的路由
 * @param  {Array} allRouter  前端配置好的所有動態路由的集合
 * @return {Array} userRealRouters 過濾後的路由
 */


export function userCurrentRouter(userRouter = [], allRouter = []{
  var userRealRouters = []
  allRouter.forEach((router, index) => {
    userRouter.forEach((item, index) => {
      // 拿使用者的路由和配置路由進行匹配判斷
      if (item.per_resource === router.meta.resources) {
        // 對路由下的子路由進行判斷,遞迴新增
        if (item.children && item.children.length > 0) {
          router.children = userCurrentRouter(item.children, router.children)
        }
        // 這裡是設定側邊欄的顯示title還可以顯示圖示(沒做)
        router.meta.title = item.per_name
        userRealRouters.push(router)
      }
    })
  })
  return userRealRouters
}
const permission = {
  state: {
    routers: constantRouterMap,
    apiRouters: [] // 後臺介面獲取得到的路由(per_resource)
  },
  mutations: {
    SET_ROUTERS(state, routers) => {
      state.apiRouters = routers
      state.routers = constantRouterMap.concat(routers)
    }
  },
  actions: {
    GenerateRoutes({ commit }, data) {
      return new Promise(resolve => {
        commit('SET_ROUTERS', userCurrentRouter(data, asyncRouterMap))
        resolve()
      })
    }
  }
}

export default permission
複製程式碼

重點關注下userCurrentRouterGenerateRoutes,第一個是匹配路由,第二個是把公共的路由和真實路由匹配到一起。最主要的是理解Vuex的意義。
3、此外修改一下src\store\getters.js檔案

const getters = {
  sidebarstate => state.app.sidebar,
  tokenstate => state.user.token,
  usernamestate => state.user.username,
  rolesstate => state.user.roles,
  userstate => state.user.user,
  menusstate => state.user.menus,
  menustate => state.permission.routers,
  apiRoutersstate => state.permission.apiRouters
}
export default getters
複製程式碼

其實也就是你想要哪些資訊,然後在裡面定義好,然後我們就可以全域性從Vuex中拿了,是不是很方便!
4、修改src\store\index.js

import Vue from 'vue'
import Vuex from 'vuex'
import app from './modules/app'
import user from './modules/user'
import permission from './modules/permission'
import getters from './getters'

Vue.use(Vuex)

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

export default store
複製程式碼

5、然後重要的一步來了,src\permission.js

import router from './router'
import store from './store'
import NProgress from 'nprogress' // Progress 進度條
import 'nprogress/nprogress.css'// Progress 進度條樣式
import { Message } from 'element-ui'
import { getToken } from '@/utils/auth' // 驗權

const whiteList = ['/login'// 不重定向白名單
router.beforeEach((to, from, next) => {
  NProgress.start()
  if (getToken()) {
    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('GetInfo').then(res => {
          // 生成可訪問的路由表
          store.dispatch('GenerateRoutes', store.getters.menus).then(r => {
            // 動態新增可訪問路由表
            router.addRoutes(store.getters.apiRouters)
            next({ ...to, replacetrue }) // 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()
      }
    }
  } else {
    if (whiteList.indexOf(to.path) !== -1) {
      next()
    } else {
      next(`/login?redirect=${to.path}`// 否則全部重定向到登入頁
      NProgress.done()
    }
  }
})

router.afterEach(() => {
  NProgress.done() // 結束Progress
})
複製程式碼

這個就是判斷是否正確的拿到路由資訊然後會給我們生成路由。
6、修改src\views\layout\components\Sidebar\index.vue

<template>
  <el-scrollbar wrap-class="scrollbar-wrapper">


    <el-menu
      :show-timeout="200"
      :default-active="$route.path"
      :collapse="isCollapse"
      mode="vertical"
      background-color="#304156"
      text-color="#bfcbd9"
      active-text-color="#409EFF"
    >

      <sidebar-item v-for="route in menu" :key="route.path" :item="route" :base-path="route.path"/>
    </el-menu>
  </el-scrollbar>
</template>

<script>
import { mapGetters } from 'vuex'
import SidebarItem from './SidebarItem'

export default {
  components: {
    SidebarItem
  },
  computed: {
    ...mapGetters([
      'menu',
      'sidebar'
    ]),
    isCollapse() {
      return !this.sidebar.opened
    }
  }
}
</script>
複製程式碼

v-for指令放到sideBar中去,目前為止基本動態的路由選單已經可以生成了。如果有什麼問題,請聯絡我指正…感謝…程式碼已經同步到GitHub

Getting started

# clone the project
git clone https://github.com/ywbjja/Vue_templete.git

# install dependency
npm install

# develop
npm run dev
複製程式碼

相關文章