Vue項(xiàng)目中封裝axios的方法
一、axios是什么
axios
是一個(gè)輕量的 HTTP
客戶端
基于 XMLHttpRequest
服務(wù)來執(zhí)行 HTTP
請(qǐng)求,支持豐富的配置,支持 Promise
,支持瀏覽器端和 Node.js
端。自Vue
2.0起,尤大宣布取消對(duì) vue-resource
的官方推薦,轉(zhuǎn)而推薦 axios
?,F(xiàn)在 axios
已經(jīng)成為大部分 Vue
開發(fā)者的首選
特性
- 從瀏覽器中創(chuàng)建
XMLHttpRequests
- 從
node.js
創(chuàng)建http
請(qǐng)求 - 支持
Promise
API - 攔截請(qǐng)求和響應(yīng)
- 轉(zhuǎn)換請(qǐng)求數(shù)據(jù)和響應(yīng)數(shù)據(jù)
- 取消請(qǐng)求
- 自動(dòng)轉(zhuǎn)換
JSON
數(shù)據(jù) - 客戶端支持防御
XSRF
基本使用
安裝
// 項(xiàng)目中安裝 npm install axios --S // cdn 引入 <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
導(dǎo)入
import axios from 'axios'
發(fā)送請(qǐng)求
axios({ url:'xxx', // 設(shè)置請(qǐng)求的地址 method:"GET", // 設(shè)置請(qǐng)求方法 params:{ // get請(qǐng)求使用params進(jìn)行參數(shù)憑借,如果是post請(qǐng)求用data type: '', page: 1 } }).then(res => { // res為后端返回的數(shù)據(jù) console.log(res); })
并發(fā)請(qǐng)求axios.all([])
function getUserAccount() { return axios.get('/user/12345'); } function getUserPermissions() { return axios.get('/user/12345/permissions'); } axios.all([getUserAccount(), getUserPermissions()]) .then(axios.spread(function (res1, res2) { // res1第一個(gè)請(qǐng)求的返回的內(nèi)容,res2第二個(gè)請(qǐng)求返回的內(nèi)容 // 兩個(gè)請(qǐng)求都執(zhí)行完成才會(huì)執(zhí)行 }));
二、為什么要封裝
axios
的 API 很友好,你完全可以很輕松地在項(xiàng)目中直接使用。
不過隨著項(xiàng)目規(guī)模增大,如果每發(fā)起一次HTTP
請(qǐng)求,就要把這些比如設(shè)置超時(shí)時(shí)間、設(shè)置請(qǐng)求頭、根據(jù)項(xiàng)目環(huán)境判斷使用哪個(gè)請(qǐng)求地址、錯(cuò)誤處理等等操作,都需要寫一遍
這種重復(fù)勞動(dòng)不僅浪費(fèi)時(shí)間,而且讓代碼變得冗余不堪,難以維護(hù)。為了提高我們的代碼質(zhì)量,我們應(yīng)該在項(xiàng)目中二次封裝一下 axios
再使用
舉個(gè)例子:
axios('http://localhost:3000/data', { // 配置代碼 method: 'GET', timeout: 1000, withCredentials: true, headers: { 'Content-Type': 'application/json', Authorization: 'xxx', }, transformRequest: [function (data, headers) { return data; }], // 其他請(qǐng)求配置... }) .then((data) => { // todo: 真正業(yè)務(wù)邏輯代碼 console.log(data); }, (err) => { // 錯(cuò)誤處理代碼 if (err.response.status === 401) { // handle authorization error } if (err.response.status === 403) { // handle server forbidden error } // 其他錯(cuò)誤處理..... console.log(err); });
如果每個(gè)頁面都發(fā)送類似的請(qǐng)求,都要寫一堆的配置與錯(cuò)誤處理,就顯得過于繁瑣了
這時(shí)候我們就需要對(duì)axios
進(jìn)行二次封裝,讓使用更為便利
三、如何封裝
封裝的同時(shí),你需要和 后端協(xié)商好一些約定,請(qǐng)求頭,狀態(tài)碼,請(qǐng)求超時(shí)時(shí)間.......
設(shè)置接口請(qǐng)求前綴:根據(jù)開發(fā)、測(cè)試、生產(chǎn)環(huán)境的不同,前綴需要加以區(qū)分
請(qǐng)求頭 : 來實(shí)現(xiàn)一些具體的業(yè)務(wù),必須攜帶一些參數(shù)才可以請(qǐng)求(例如:會(huì)員業(yè)務(wù))
狀態(tài)碼: 根據(jù)接口返回的不同status
, 來執(zhí)行不同的業(yè)務(wù),這塊需要和后端約定好
請(qǐng)求方法:根據(jù)get
、post
等方法進(jìn)行一個(gè)再次封裝,使用起來更為方便
請(qǐng)求攔截器: 根據(jù)請(qǐng)求的請(qǐng)求頭設(shè)定,來決定哪些請(qǐng)求可以訪問
響應(yīng)攔截器: 這塊就是根據(jù) 后端`返回來的狀態(tài)碼判定執(zhí)行不同業(yè)務(wù)
設(shè)置接口請(qǐng)求前綴
利用node
環(huán)境變量來作判斷,用來區(qū)分開發(fā)、測(cè)試、生產(chǎn)環(huán)境
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' }
在本地調(diào)試的時(shí)候,還需要在vue.config.js
文件中配置devServer
實(shí)現(xiàn)代理轉(zhuǎn)發(fā),從而實(shí)現(xiàn)跨域
devServer: { proxy: { '/proxyApi': { target: 'http://dev.xxx.com', changeOrigin: true, pathRewrite: { '/proxyApi': '' } } } }
設(shè)置請(qǐng)求頭與超時(shí)時(shí)間
大部分情況下,請(qǐng)求頭都是固定的,只有少部分情況下,會(huì)需要一些特殊的請(qǐng)求頭,這里將普適性的請(qǐng)求頭作為基礎(chǔ)配置。當(dāng)需要特殊請(qǐng)求頭時(shí),將特殊請(qǐng)求頭作為參數(shù)傳入,覆蓋基礎(chǔ)配置
const service = axios.create({ ... timeout: 30000, // 請(qǐng)求 30s 超時(shí) headers: { get: { 'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8' // 在開發(fā)中,一般還需要單點(diǎn)登錄或者其他功能的通用請(qǐng)求頭,可以一并配置進(jìn)來 }, post: { 'Content-Type': 'application/json;charset=utf-8' // 在開發(fā)中,一般還需要單點(diǎn)登錄或者其他功能的通用請(qǐng)求頭,可以一并配置進(jìn)來 } }, })
封裝請(qǐng)求方法
先引入封裝好的方法,在要調(diào)用的接口重新封裝成一個(gè)方法暴露出去
// get 請(qǐng)求 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請(qǐng)求 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 }], // 發(fā)送的數(shù)據(jù) data, // ?url參數(shù) params ? }).then(res => { resolve(res.data) }) }) }
把封裝的方法放在一個(gè)api.js
文件中
import { httpGet, httpPost } from './http' export const getorglist = (params = {}) => httpGet({ url: 'apps/api/org/list', params })
頁面中就能直接調(diào)用
// .vue import { getorglist } from '@/assets/js/api' ? getorglist({ id: 200 }).then(res => { console.log(res) })
這樣可以把api
統(tǒng)一管理起來,以后維護(hù)修改只需要在api.js
文件操作即可
請(qǐng)求攔截器
請(qǐng)求攔截器可以在每個(gè)請(qǐng)求里加上token,做了統(tǒng)一處理后維護(hù)起來也方便
// 請(qǐng)求攔截器 axios.interceptors.request.use( config => { // 每次發(fā)送請(qǐng)求之前判斷是否存在token // 如果存在,則統(tǒng)一在http請(qǐng)求的header都加上token,這樣后臺(tái)根據(jù)token判斷你的登錄情況,此處token一般是用戶完成登錄后儲(chǔ)存到localstorage里的 token && (config.headers.Authorization = token) return config }, error => { return Promise.error(error) })
響應(yīng)攔截器
響應(yīng)攔截器可以在接收到響應(yīng)后先做一層操作,如根據(jù)狀態(tài)碼判斷登錄狀態(tài)、授權(quán)
// 響應(yīng)攔截器 axios.interceptors.response.use(response => { // 如果返回的狀態(tài)碼為200,說明接口請(qǐng)求成功,可以正常拿到數(shù)據(jù) // 否則的話拋出錯(cuò)誤 if (response.status === 200) { if (response.data.code === 511) { // 未授權(quán)調(diào)取授權(quán)接口 } else if (response.data.code === 510) { // 未登錄跳轉(zhuǎn)登錄頁 } else { return Promise.resolve(response) } } else { return Promise.reject(response) } }, error => { // 我們可以在這里對(duì)異常狀態(tài)作統(tǒng)一處理 if (error.response.status) { // 處理請(qǐng)求失敗的情況 // 對(duì)不同返回碼對(duì)相應(yīng)處理 return Promise.reject(error.response) } })
小結(jié)
- 封裝是編程中很有意義的手段,簡(jiǎn)單的
axios
封裝,就可以讓我們可以領(lǐng)略到它的魅力 - 封裝
axios
沒有一個(gè)絕對(duì)的標(biāo)準(zhǔn),只要你的封裝可以滿足你的項(xiàng)目需求,并且用起來方便,那就是一個(gè)好的封裝方案
參考文獻(xiàn)
到此這篇關(guān)于Vue項(xiàng)目中封裝axios的方法的文章就介紹到這了,更多相關(guān)vue封裝axios內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
uniapp組件uni-file-picker中對(duì)上傳的圖片進(jìn)行壓縮至1兆以內(nèi)(推薦)
我在做uniapp項(xiàng)目時(shí),用的uni-file-picker組件,這是我做的一個(gè)項(xiàng)目實(shí)例,主要是將圖片通過接口傳至后臺(tái)服務(wù)器,本文給大家分享uniapp組件uni-file-picker中對(duì)上傳的圖片進(jìn)行壓縮再上傳,感興趣的朋友跟隨小編一起看看吧2022-11-11vue template中slot-scope/scope的使用方法
今天小編就為大家分享一篇vue template中slot-scope/scope的使用方法,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-09-09淺談vue實(shí)現(xiàn)數(shù)據(jù)監(jiān)聽的函數(shù) Object.defineProperty
本篇文章主要介紹了淺談vue實(shí)現(xiàn)數(shù)據(jù)監(jiān)聽的函數(shù) Object.defineProperty,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-06-06vue-cli對(duì)element-ui組件進(jìn)行二次封裝的實(shí)戰(zhàn)記錄
組件類似于需要多個(gè)地方用到的方法,在Vue中組件就是一種復(fù)用(經(jīng)常使用)一個(gè)功能的手段,下面這篇文章主要給大家介紹了關(guān)于Vue?element?ui二次封裝的相關(guān)資料,需要的朋友可以參考下2022-06-06vue如何從后臺(tái)獲取數(shù)據(jù)生成動(dòng)態(tài)菜單列表
這篇文章主要介紹了vue如何從后臺(tái)獲取數(shù)據(jù)生成動(dòng)態(tài)菜單列表,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-04-04