在做vue中大型專案的時候，官方推薦使用axios，但是原生的axios可能對專案的適配不友好，所以，在工程開始的來封裝一下axios，保持全專案資料處理的統一性。此文主要講在vue-cil專案中如何封裝axios，封裝請求，封裝公共的api，頁面如何呼叫請求。
如果你能看到這篇文章，鑑於有很多小白可能會參考我這篇文章來進行前期設定，特說明下正式設定路線：
- 拿到專案及後臺介面，首先做的是設定全域性代理及第二點；
- 全域性封裝axios及第三點request.js；
- 過濾axios請求方式，控制路徑及引數的格式及第四點http.js；
- 正式封裝api及第五點api.js；
- 頁面呼叫；
新建vue專案，下載axios，並在main.js中匯入axios
npm i axios -S
//main.js
import axios from "axios";
在專案config目錄下的修改 index.js檔案，這裡是主要書寫設定多個後臺介面。關於代理可能出現的問題，可以檢視我的另一篇檔案VueCil代理本地proxytable報錯的解析；
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
},
關於多代理設定：
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詳細參考我另一篇部落格：vue專案升級(01)：全面解析vuecil3/vuecil4的vue.config.js等常用設定
如果有多後臺，就可以在api資料夾下另外新建一個elseApi.js ，書寫當前ip下的介面請求。方法同上，只是 let resquest = "/elseIp/request/" 呼叫的時候把埠更改一下。
在專案src目錄下新建utils資料夾，然後在其中新建 request.js檔案，這個檔案是主要書寫axios的封裝過程。
/**** 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，這裡設定了3s的超時時間
timeout: 3 * 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
特殊說明：
鑑於有很多朋友問關於資料轉換這塊的問題，特在頁面中單獨回覆一下！
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格式傳送到伺服器（表單預設的提交資料的格式），你可以根據實際情況去設定自己需要的；
以上
我已經舉了很清晰的例子，寫程式碼的過程是自己動腦去搭建工程的，希望能看到我文章的各位，善於搜尋，善於思考，善於總結；
當然我很喜歡幫大家解決問題，但是相關的基礎問題，還是建議自己去學習掌握。
在專案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
在專案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地址不一樣這種情況。
以上 關於設定環境 和介面 基本搭建完畢，下面看一下呼叫：
方法一：用到哪個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))
}
}
以上就詳細介紹了，在vue-cil專案中 如何封裝axios，封裝請求，封裝公共的api，設定多個介面，頁面如何呼叫請求等問題，都是親測有用的~ 但是這種封裝方法的話，更適合大中型專案，設定比較合理，如果是自己小專案，就直接用axios就完事了。。。
補充：關於代理的設定及若出現設定代理報錯404的問題，可以參考我的文章：代理的設定來解決；
如果本文對你有幫助的話，請不要忘記給我點贊打call哦~o(￣▽￣)ｄo
有其他問題留言 over~