Vue + Element UI 實現權限管理系統前端篇（三）：工具模塊封裝

時間 2020-06-29

標籤 vue element 實現權限管理系統前端工具模塊封裝欄目軟件設計简体版

原文原文鏈接

封裝 axios 模塊

封裝背景

使用axios發起一個請求是比較簡單的事情，可是axios沒有進行封裝複用，項目愈來愈大，會引發愈來愈多的代碼冗餘，讓代碼變得愈來愈難維護。因此咱們在這裏先對 axios 進行二次封裝，使項目中各個組件可以複用請求，讓代碼變得更容易維護。前端

封裝要點

統一 url 配置
統一 api 請求
request (請求) 攔截器，例如：帶上token等，設置請求頭
response (響應) 攔截器，例如：統一錯誤處理，頁面重定向等
根據須要，結合 Vuex 作全局的 loading 動畫，或者錯誤處理
將 axios 封裝成 Vue 插件使用

文件結構

在 src 目錄下，新建一個 http 文件夾，用來存放 http 交互 api 代碼。vue

config.js：axios 默認配置，包含基礎路徑等信息。
axios.js：二次封裝 axios 模塊，包含攔截器等信息。
interface.js ：請求接口彙總模塊，聚合模塊 API。
index.js：將 axios 封裝成插件，按插件方式引入。ios

config.js

export default {
  method: 'get',
  // 基礎url前綴
  baseURL: 'http://localhost:8080/',
  // 請求頭信息
  headers: {
    'Content-Type': 'application/json;charset=UTF-8'
  },
  // 參數
  data: {},
  // 設置超時時間
  timeout: 10000,
  // 攜帶憑證
  withCredentials: true,
  // 返回數據類型
  responseType: 'json'
}

axios.js

import axios from 'axios';
import config from './config';
import qs from 'qs';
import Cookies from "js-cookie";
import router from '@/router'

// 使用vuex作全局loading時使用
// import store from '@/store'

export default function $axios(options) {
  return new Promise((resolve, reject) => {
    const instance = axios.create({
      baseURL: config.baseURL,
      headers: {},
      transformResponse: [function (data) {
      }]
    })

    // request 攔截器
    instance.interceptors.request.use(
      config => {
        let token = Cookies.get('token')
        // 1. 請求開始的時候能夠結合 vuex 開啓全屏 loading 動畫
        // console.log(store.state.loading)
        // console.log('準備發送請求...')
        // 2. 帶上token
        if (token) {
          config.headers.accessToken = token
        } else {
          // 重定向到登陸頁面
          router.push('/login')
        }
        // 3. 根據請求方法，序列化傳來的參數，根據後端需求是否序列化
        if (config.method === 'post') {
          if (config.data.__proto__ === FormData.prototype
            || config.url.endsWith('path')
            || config.url.endsWith('mark')
            || config.url.endsWith('patchs')
          ) {

          } else {
            config.data = qs.stringify(config.data)
          }
        }
        return config
      },

      error => {
        // 請求錯誤時
        console.log('request:', error)
        // 1. 判斷請求超時
        if (error.code === 'ECONNABORTED' && error.message.indexOf('timeout') !== -1) {
          console.log('timeout請求超時')
          // return service.request(originalRequest);// 再重複請求一次
        }
        // 2. 須要重定向到錯誤頁面
        const errorInfo = error.response
        console.log(errorInfo)
        if (errorInfo) {
          error = errorInfo.data  // 頁面那邊catch的時候就能拿到詳細的錯誤信息,看最下邊的Promise.reject
          const errorStatus = errorInfo.status; // 404 403 500 ...
          router.push({
            path: `/error/${errorStatus}`
          })
        }
        return Promise.reject(error) // 在調用的那邊能夠拿到(catch)你想返回的錯誤信息
      }
    )

    // response 攔截器
    instance.interceptors.response.use(
      response => {
        let data;
        // IE9時response.data是undefined，所以須要使用response.request.responseText(Stringify後的字符串)
        if (response.data == undefined) {
          data = JSON.parse(response.request.responseText)
        } else {
          data = response.data
        }

        // 根據返回的code值來作不一樣的處理
        switch (data.rc) {
          case 1:
            console.log(data.desc)
            break;
          case 0:
            store.commit('changeState')
            // console.log('登陸成功')
          default:
        }
        // 若不是正確的返回code，且已經登陸，就拋出錯誤
        // const err = new Error(data.desc)
        // err.data = data
        // err.response = response
        // throw err

        return data
      },
      err => {
        if (err && err.response) {
          switch (err.response.status) {
            case 400:
              err.message = '請求錯誤'
              break
            case 401:
              err.message = '未受權，請登陸'
              break
            case 403:
              err.message = '拒絕訪問'
              break
            case 404:
              err.message = `請求地址出錯: ${err.response.config.url}`
              break
            case 408:
              err.message = '請求超時'
              break
            case 500:
              err.message = '服務器內部錯誤'
              break
            case 501:
              err.message = '服務未實現'
              break
            case 502:
              err.message = '網關錯誤'
              break
            case 503:
              err.message = '服務不可用'
              break
            case 504:
              err.message = '網關超時'
              break
            case 505:
              err.message = 'HTTP版本不受支持'
              break
            default:
          }
        }
        console.error(err)
        return Promise.reject(err) // 返回接口返回的錯誤信息
      }
    )

    // 請求處理
    instance(options).then(res => {
      resolve(res)
      return false
    }).catch(error => {
      reject(error)
    })
  })
}

interface.js

import axios from './axios'

/* 
 * 將全部接口統一塊兒來便於維護
 * 若是項目很大能夠將 url 獨立成文件，接口分紅不一樣的模塊
 */

// 單獨導出
export const login = () => {
    return axios({
        url: '/login',
        method: 'get'
    })
}

export const getUser = () => {
    return axios({
        url: '/user',
        method: 'get'
    })
}

export const getMenu = data => {
    return axios({
        url: '/menu',
        method: 'post',
        data
    })
}

// 默認所有導出
export default {
    login,
    getUser,
    getMenu
}

index.js

// 導入全部接口
import apis from './interface'

const install = Vue => {
    if (install.installed)
        return;

    install.installed = true;

    Object.defineProperties(Vue.prototype, {
        // 注意，此處掛載在 Vue 原型的 $api 對象上
        $api: {
            get() {
                return apis
            }
        }
    })
}

export default install

安裝 js-cookie

上面 axios.js 中，會用到 Cookie 獲取 token，因此須要把相關依賴安裝一下。git

執行如下命令，安裝依賴包。vuex

yarn add js-cookie

代碼實例

1.引入插件

在 main.js 中以 vue 插件的形式引入 axios，這樣在其餘地方就可經過 this.$api 調用相關的接口了。json

2.編寫接口

在 interface.js 中添加 login 接口。axios

3.調用接口

在登陸界面 Login.vue 中，添加一個登陸按鈕，點擊處理函數經過 axios 調用 login 接口返回數據。後端

成功返回以後，將 token 放入 Cookie 並跳轉到主頁。api

<template>
  <div class="page">
    <h2>Login Page</h2>
    <el-button type="primary" @click="login()">登陸</el-button>
  </div>
</template>

<script>
  import mock from '@/mock/mock.js';
  import Cookies from "js-cookie";
  import router from '@/router'
  export default {
    name: 'Login',
    methods: {
      login() {
        this.$api.login().then(function(res) {
　　　　　　　alert(res.data.token)
            Cookies.set('token', res.data.token) // 放置token到Cookie 
            router.push('/')  // 登陸成功，跳轉到主頁
          }).catch(function(res) {
            alert(res);
          });
          
      }
    }
  }
</script>

4.mock 接口

在 mock.js 中添加 login 接口進行攔截，返回一個 token。瀏覽器

啓動測試

瀏覽器訪問：http://localhost:8080/#/login，顯示登陸界面。

點擊登陸按鈕，首先彈出框，顯示返回的 token 信息。

點擊肯定關掉彈出框後，跳轉到主頁。點擊用戶、菜單按鈕，接口調用正常。

封裝 mock 模塊

爲了統一能夠統一管理和集中控制數據模擬接口，咱們對 mock 模塊進行了封裝，能夠方便的定製模擬接口的統一開關和個體開關。

文件結構

在 mock 目錄下新建一個 index.js ，建立 modules 目錄並在裏面建立三個模塊 *.js 文件。

index.js：模擬接口模塊聚合文件

login.js：登陸相關的接口模擬

user.js：用戶相關的接口模擬

menu.js：菜單相關的接口模擬

index.js

import Mock from 'mockjs'
import * as login from './modules/login'
import * as user from './modules/user'
import * as menu from './modules/menu'

// 1. 開啓/關閉[業務模塊]攔截, 經過調用fnCreate方法[isOpen參數]設置.
// 2. 開啓/關閉[業務模塊中某個請求]攔截, 經過函數返回對象中的[isOpen屬性]設置.
fnCreate(login, true)
fnCreate(user, true)
fnCreate(menu, true)

/**
 * 建立mock模擬數據
 * @param {*} mod 模塊
 * @param {*} isOpen 是否開啓?
 */
function fnCreate (mod, isOpen = true) {
  if (isOpen) {
    for (var key in mod) {
      ((res) => {
        if (res.isOpen !== false) {
          Mock.mock(new RegExp(res.url), res.type, (opts) => {
            opts['data'] = opts.body ? JSON.parse(opts.body) : null
            delete opts.body
            console.log('\n')
            console.log('%cmock攔截, 請求: ', 'color:blue', opts)
            console.log('%cmock攔截, 響應: ', 'color:blue', res.data)
            return res.data
          })
        }
      })(mod[key]() || {})
    }
  }
}

login.js

// 登陸接口
export function login () {
  return {
    // isOpen: false,
    url: 'http://localhost:8080/login',
    type: 'get',
    data: {
      'msg': 'success',
      'code': 0,
      'data': {
        'token': '4344323121398'
        // 其餘數據
      }
    }
  }
}

user.js

// 獲取用戶信息
export function getUser () {
  return {
    // isOpen: false,
    url: 'http://localhost:8080/user',
    type: 'get',
    data: {
      'msg': 'success',
      'code': 0,
      'data': {
        'id': '@increment', 
        'name': '@name', // 隨機生成姓名
        'email': '@email', // 隨機生成姓名
        'age|10-20': 12
        // 其餘數據
      }
    }
  }
}

menu.js

// 獲取菜單信息
export function getMenu () {
  return {
    // isOpen: false,
    url: 'http://localhost:8080/menu',
    type: 'get',
    data: {
      'msg': 'success',
      'code': 0,
      'data': {
        'id': '@increment', 
        'name': 'menu', // 隨機生成姓名
        'order|10-20': 12
        // 其餘數據
      }
    }
  }
}