Vue CLI項目中 axios 的封裝及使用詳解

時間 2021-08-13

標籤 javascript css html vue java webpack ios web npm element-ui 欄目軟件設計简体版

原文原文鏈接

在作 vue 中大型項目的時候，官方推薦使用 axios，可是原生的 axios 可能對項目的適配不友好，因此在工程開始的時候來封裝一下axios，保持全項目數據處理的統一性。
此文主要講在vue-cil項目中如何封裝axios，封裝請求，封裝公共的api，頁面如何調用請求。javascript

若是你能看到這篇文章，鑑於有不少小白可能會參考我這篇文章來進行前期配置，特說明下正式配置路線：css

獲取到項目及後臺接口，首先作的是配置全局代理；
全局封裝 axios – request.js；
過濾 axios 請求方式，控制路徑及參數的格式封裝 http.js；
封裝 api；
頁面調用；

1. 前期配置

下載 axios，並在 main.js 中導入axios；html

npm i axios -S

//main.js
import axios from "axios";

2. 配置 config 文件中的代理地址

在項目config目錄下的修改 index.js文件，這裏是主要書寫配置多個後臺接口。關於代理可能出現的問題，能夠查看個人另外一篇文檔 Vue-Cli 代理本地 proxytable 報錯解析vue

Vue-cli2 舊版本的代理配置 —— config/index.jsjava

dev: {
    // Paths
    assetsSubDirectory: 'static',
    assetsPublicPath: '/',
    // 後端請求地址代理，配置後testIp再以後的頁面調用時就直接指代 http://197.82.15.15:8088
    proxyTable: {
      '/testIp': {
        target: 'http://197.82.15.15:8088',
        changeOrigin: true,
        pathRewrite: { 
          '^/testIp': ''
        }
      },
      '/elseIp': {
        target: 'http://182.83.19.15:8080',
        changeOrigin: true,
        pathRewrite: { 
          '^/esleIp': ''
        }
      },
    },

    // Various Dev Server settings
    host: 'localhost', // can be overwritten by process.env.HOST
    port: 8080, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined
    autoOpenBrowser: false,
    errorOverlay: true,
    notifyOnErrors: true,
    poll: false, // https://webpack.js.org/configuration/dev-server/#devserver-watchoptions-


    /** * Source Maps */

    // https://webpack.js.org/configuration/devtool/#development
    devtool: 'cheap-module-eval-source-map',

    // If you have problems debugging vue-files in devtools,
    // set this to false - it *may* help
    // https://vue-loader.vuejs.org/en/options.html#cachebusting
    cacheBusting: true,

    cssSourceMap: true
  },

Vue-cli3+ 新版本的代理配置 — vue.config.js 文件webpack

devServer: {
  overlay: { // 讓瀏覽器 overlay 同時顯示警告和錯誤
    warnings: true,
    errors: true
  },
  host: "localhost",
  port: 8080, // 端口號
  https: false, // https:{type:Boolean}
  open: false, // 配置後自動啓動瀏覽器
  hotOnly: true, // 熱更新
  // proxy: 'http://localhost:8080' // 配置跨域處理,只有一個代理
  proxy: { // 配置多個代理
    "/testIp": {
      target: "http://197.0.0.1:8088",
      changeOrigin: true,
      ws: true, // websocket支持
      secure: false,
      pathRewrite: {
        "^/testIp": "/"
      }
    },
    "/elseIp": {
      target: "http://197.0.0.2:8088",
      changeOrigin: true,
      //ws: true, // websocket支持
      secure: false,
      pathRewrite: {
        "^/elseIp": "/"
      }
    },
  }
}

其中 vue.config.js 詳細參考我另外一篇博客：全面解析 vuecil3/vuecil4 的 vue.config.js 等經常使用配置ios

若是有多後臺，就可在 api 文件夾下另外新建一個 elseApi.js ，書寫當前 ip 下的接口請求。
方法同上，只是 let resquest = 「/elseIp/request/」調用的時候把端口更改一下。web

3. 封裝 axios 實例 —— request.js

在項目 src 目錄下新建 utils 文件夾，而後在其中新建 request.js 文件，這個文件是主要書寫 axios 的封裝過程。npm

/**** request.js ****/
// 導入axios
import axios from 'axios'
// 使用element-ui Message作消息提醒
import { Message} from 'element-ui';
//1. 建立新的axios實例，
const service = axios.create({
  // 公共接口--這裏注意後面會講
  baseURL: process.env.BASE_API,
  // 超時時間 單位是ms，這裏設置了20s的超時時間
  timeout: 20 * 1000
})
// 2.請求攔截器
service.interceptors.request.use(config => {
  //發請求前作的一些處理，數據轉化，配置請求頭，設置token,設置loading等，根據需求去添加
   config.data = JSON.stringify(config.data); //數據轉化,也可使用qs轉換
   config.headers = {
     'Content-Type':'application/x-www-form-urlencoded' //配置請求頭
   }
   //注意使用token的時候須要引入cookie方法或者用本地localStorage等方法，推薦js-cookie
   const token = getCookie('名稱');//這裏取token以前，你確定須要先拿到token,存一下
   if(token){
      config.params = {'token':token} //若是要求攜帶在參數中
      config.headers.token= token; //若是要求攜帶在請求頭中
    }
  return config
}, error => {
  Promise.reject(error)
})

// 3.響應攔截器
service.interceptors.response.use(response => {
  //接收到響應數據併成功後的一些共有的處理，關閉loading等 
  return response
}, error => {
   /***** 接收到異常響應的處理開始 *****/
  if (error && error.response) {
    // 1.公共錯誤處理
    // 2.根據響應碼具體處理
    switch (error.response.status) {
      case 400:
        error.message = '錯誤請求'
        break;
      case 401:
        error.message = '未受權，請從新登陸'
        break;
      case 403:
        error.message = '拒絕訪問'
        break;
      case 404:
        error.message = '請求錯誤,未找到該資源'
        window.location.href = "/NotFound"
        break;
      case 405:
        error.message = '請求方法未容許'
        break;
      case 408:
        error.message = '請求超時'
        break;
      case 500:
        error.message = '服務器端出錯'
        break;
      case 501:
        error.message = '網絡未實現'
        break;
      case 502:
        error.message = '網絡錯誤'
        break;
      case 503:
        error.message = '服務不可用'
        break;
      case 504:
        error.message = '網絡超時'
        break;
      case 505:
        error.message = 'http版本不支持該請求'
        break;
      default:
        error.message = `鏈接錯誤${error.response.status}`
    }
  } else {
    // 超時處理
    if (JSON.stringify(error).includes('timeout')) {
      Message.error('服務器響應超時，請刷新當前頁')
    }
    error.message = '鏈接服務器失敗'
  }

  Message.error(error.message)
  /***** 處理結束 *****/
  //若是不須要錯誤處理，以上的處理過程均可省略
  return Promise.resolve(error.response)
})
//4.導入文件
export default service

特殊說明：element-ui

鑑於有不少朋友問關於數據轉換這塊的問題，特在頁面中單獨回覆一下！

config.data = JSON.stringify(config.data);
config.headers = { 'Content-Type':'application/x-www-form-urlencoded'  }
const token = getCookie('名稱')
if(token){ 
  config.params = {'token':token} ; 
  config.headers.token= token; 
}

上述的代碼都是請求的配置項，非必須，也是分狀況的，data/headers /params 這種自己的參數都有多種，和後臺溝通，須要什麼就配什麼！
config.data = JSON.stringify(config.data); 爲何不用 qs.stringify，由於個人後臺想要的只是json類型的傳參，
而qs轉換會轉換成爲鍵值對拼接的字符串形式。固然大家後臺須要傳遞字符串類型參數，那就換成qs或者其餘格式方式。
const token = getCookie('名稱') 這是 token 的取值，在取以前你確定須要發請求拿到 token，而後 setCookie 存起來，
而名稱就是你存的 token 的名稱，每一個人的不同；
config.headers = { 'Content-Type':'application/x-www-form-urlencoded' } 請求頭內容的配置也是不一樣的，
application/x-www-form-urlencoded ：form表單數據被編碼爲key/value格式發送到服務器（表單默認的提交數據的格式），
你能夠根據實際狀況去配置本身須要的；

我已經舉了很清晰的例子，寫代碼的過程是本身動腦去搭建工程的，但願能看到我文章的各位，善於搜索，善於思考，善於總結；
固然我很喜歡幫你們解決問題，可是相關的基礎問題，仍是建議本身去學習掌握。

4. 封裝請求 —— http.js

在項目 src 目錄下的 utils 文件夾中新建 http.js 文件，這個文件是主要書寫幾種請求的封裝過程。

/**** http.js ****/
// 導入封裝好的axios實例
import request from './request'

const http ={
    /** * methods: 請求 * @param url 請求地址 * @param params 請求參數 */
    get(url,params){
        const config = {
            method: 'get',
            url:url
        }
        if(params) config.params = params
        return request(config)
    },
    post(url,params){
        const config = {
            method: 'post',
            url:url
        }
        if(params) config.data = params
        return request(config)
    },
    put(url,params){
        const config = {
            method: 'put',
            url:url
        }
        if(params) config.params = params
        return request(config)
    },
    delete(url,params){
        const config = {
            method: 'delete',
            url:url
        }
        if(params) config.params = params
        return request(config)
    }
}
// 導出
export default http

5. 正式封裝API，用於發送請求 —— api.js

在項目 src 目錄下新建 api 文件夾，而後在其中新建 api.js 文件，這個文件是主要書寫API的封裝過程。

寫法一：適合分類導出

import http from '../utils/http'
/** * @parms resquest 請求地址 例如：http://197.82.15.15:8088/request/... * @param '/testIp'表明vue-cil中config，index.js中配置的代理 */
let resquest = "/testIp/request/"

// get請求
export function getListAPI(params){
    return http.get(`${resquest}/getList.json`,params)
}
// post請求
export function postFormAPI(params){
    return http.post(`${resquest}/postForm.json`,params)
}
// put 請求
export function putSomeAPI(params){
    return http.put(`${resquest}/putSome.json`,params)
}
// delete 請求
export function deleteListAPI(params){
    return http.delete(`${resquest}/deleteList.json`,params)
}

寫法二：使用所有導出

import http from '../utils/http'
// 
/** * @parms resquest 請求地址 例如：http://197.82.15.15:8088/request/... * @param '/testIp'表明vue-cil中config，index.js中配置的代理 */
let resquest = "/testIp/request/"

// get請求
export default{
 	getListAPI(params){
    	return http.get(`${resquest}/getList.json`,params)
	},
	 postFormAPI(params){
    	return http.post(`${resquest}/postForm.json`,params)
	}
}

注意： 項目中若是後臺請求不是同一個 ip 而是多個 ip 的時候，可在 api 文件夾下創建多個 js 用來調用請求。

咱們看下以前遺留的一個問題：

//建立新的axios實例，
const service = axios.create({
  baseURL: process.env.BASE_API,
  timeout: 3 * 1000
})

以前封裝公共接口的 baseUrl 時候，用了 webpack 中的全局變量 process.env.BASE_API，而不是直接寫死 ip 也是爲了適應多個後臺或者開發的時候的 api 地址和發佈的時候的 api 地址不同這種狀況。Vue CLI中模式和環境變量詳解

6. 如何在 vue 組件中調用

方法一：用到哪一個api 就調用哪一個接口 —— 適用於上文接口分類導出；

import {getListAPI,postFormAPI, putSomeAPI, deleteListAPI} from '@/api/api'

methods: {
  // promise調用 鏈式調用， getList()括號內只接受參數；
  // get不傳參
  getList() {
    getListAPI().then(res => console.log(res)).catch(err => console.log(err))
  },
  // post傳參
  postForm(formData) {
    let data = formData
    postFormAPI(data).then(res => console.log(res)).catch(err => console.log(err))
  },
  // async await同步調用
  async postForm(formData) {
    const postRes = await postFormAPI(formData)
    const putRes = await putSomeAPI({data: 'putTest'})
    const deleteRes = await deleteListAPI(formData.name)
    // 數據處理
    console.log(postRes);
    console.log(putRes);
    console.log(deleteRes);
  },
}

方法二：把 api 所有導入，而後用哪一個調用哪一個api —— 適用於所有導出

import api from '@/api/api'

methods: {
  getList() {
    api.getListAPI(data).then(res => {
      // 數據處理
    }).catch(err => console.log(err))
  }
}