本教程操作環境:windows7系統、vue3版,DELL G3電腦。
axios是什么
(相關資料圖)
axios 是一個輕量的 HTTP客戶端
基于 XMLHttpRequest 服務來執行 HTTP 請求,支持豐富的配置,支持 Promise,支持瀏覽器端和 Node.js 端。自Vue2.0起,尤大宣布取消對 vue-resource 的官方推薦,轉而推薦 axios。現在 axios 已經成為大部分 Vue 開發者的首選
為什么要封裝
axios 的 API 很友好,你完全可以很輕松地在項目中直接使用。
不過隨著項目規模增大,如果每發起一次HTTP請求,就要把這些比如設置超時時間、設置請求頭、根據項目環境判斷使用哪個請求地址、錯誤處理等等操作,都需要寫一遍
這種重復勞動不僅浪費時間,而且讓代碼變得冗余不堪,難以維護。為了提高我們的代碼質量,我們應該在項目中二次封裝一下 axios 再使用
舉個例子:
axios("http://localhost:3000/data", { // 配置代碼 method: "GET", timeout: 1000, withCredentials: true, headers: { "Content-Type": "application/json", Authorization: "xxx", }, transformRequest: [function (data, headers) { return data; }], // 其他請求配置...}).then((data) => { // todo: 真正業務邏輯代碼 console.log(data);}, (err) => { // 錯誤處理代碼 if (err.response.status === 401) { // handle authorization error } if (err.response.status === 403) { // handle server forbidden error } // 其他錯誤處理..... console.log(err);});
如果每個頁面都發送類似的請求,都要寫一堆的配置與錯誤處理,就顯得過于繁瑣了
這時候我們就需要對axios進行二次封裝,讓使用更為便利
如何封裝
封裝的同時,你需要和 后端協商好一些約定,請求頭,狀態碼,請求超時時間.......
設置接口請求前綴:根據開發、測試、生產環境的不同,前綴需要加以區分
請求頭 : 來實現一些具體的業務,必須攜帶一些參數才可以請求(例如:會員業務)
狀態碼: 根據接口返回的不同status , 來執行不同的業務,這塊需要和后端約定好
請求方法:根據get、post等方法進行一個再次封裝,使用起來更為方便
請求攔截器: 根據請求的請求頭設定,來決定哪些請求可以訪問
響應攔截器: 這塊就是根據 后端`返回來的狀態碼判定執行不同業務
設置接口請求前綴
利用node環境變量來作判斷,用來區分開發、測試、生產環境
if (process.env.NODE_ENV === "development") { axios.defaults.baseURL = "http://dev.xxx.com"} else if (process.env.NODE_ENV === "production") { axios.defaults.baseURL = "http://prod.xxx.com"}
在本地調試的時候,還需要在vue.config.js文件中配置devServer實現代理轉發,從而實現跨域
devServer: { proxy: { "/proxyApi": { target: "http://dev.xxx.com", changeOrigin: true, pathRewrite: { "/proxyApi": "" } } } }
設置請求頭與超時時間
大部分情況下,請求頭都是固定的,只有少部分情況下,會需要一些特殊的請求頭,這里將普適性的請求頭作為基礎配置。當需要特殊請求頭時,將特殊請求頭作為參數傳入,覆蓋基礎配置
const service = axios.create({ ... timeout: 30000, // 請求 30s 超時 headers: { get: { "Content-Type": "application/x-www-form-urlencoded;charset=utf-8" // 在開發中,一般還需要單點登錄或者其他功能的通用請求頭,可以一并配置進來 }, post: { "Content-Type": "application/json;charset=utf-8" // 在開發中,一般還需要單點登錄或者其他功能的通用請求頭,可以一并配置進來 } },})
封裝請求方法
先引入封裝好的方法,在要調用的接口重新封裝成一個方法暴露出去
// get 請求export function httpGet({ url, params = {}}) { return new Promise((resolve, reject) => { axios.get(url, { params }).then((res) => { resolve(res.data) }).catch(err => { reject(err) }) })}// post// post請求export function httpPost({ url, data = {}, params = {}}) { return new Promise((resolve, reject) => { axios({ url, method: "post", transformRequest: [function (data) { let ret = "" for (let it in data) { ret += encodeURIComponent(it) + "=" + encodeURIComponent(data[it]) + "&" } return ret }], // 發送的數據 data, // url參數 params }).then(res => { resolve(res.data) }) })}
把封裝的方法放在一個api.js文件中
import { httpGet, httpPost } from "./http"export const getorglist = (params = {}) => httpGet({ url: "apps/api/org/list", params })
頁面中就能直接調用
// .vueimport { getorglist } from "@/assets/js/api"getorglist({ id: 200 }).then(res => { console.log(res)})
這樣可以把api統一管理起來,以后維護修改只需要在api.js文件操作即可
請求攔截器
請求攔截器可以在每個請求里加上token,做了統一處理后維護起來也方便
// 請求攔截器axios.interceptors.request.use( config => { // 每次發送請求之前判斷是否存在token // 如果存在,則統一在http請求的header都加上token,這樣后臺根據token判斷你的登錄情況,此處token一般是用戶完成登錄后儲存到localstorage里的 token && (config.headers.Authorization = token) return config }, error => { return Promise.error(error) })
響應攔截器
響應攔截器可以在接收到響應后先做一層操作,如根據狀態碼判斷登錄狀態、授權
// 響應攔截器axios.interceptors.response.use(response => { // 如果返回的狀態碼為200,說明接口請求成功,可以正常拿到數據 // 否則的話拋出錯誤 if (response.status === 200) { if (response.data.code === 511) { // 未授權調取授權接口 } else if (response.data.code === 510) { // 未登錄跳轉登錄頁 } else { return Promise.resolve(response) } } else { return Promise.reject(response) }}, error => { // 我們可以在這里對異常狀態作統一處理 if (error.response.status) { // 處理請求失敗的情況 // 對不同返回碼對相應處理 return Promise.reject(error.response) }})
小結
封裝是編程中很有意義的手段,簡單的axios封裝,就可以讓我們可以領略到它的魅力
封裝 axios 沒有一個絕對的標準,只要你的封裝可以滿足你的項目需求,并且用起來方便,那就是一個好的封裝方案
以上就是vue封裝axios有什么用的詳細內容,更多請關注php中文網其它相關文章!
關鍵詞: axios