vue封裝axios可以提高程式碼品質、讓使用更為便利。 axios的API很友好,開發者完全可以很輕鬆地在專案中直接使用;不過隨著專案規模增大,如果每發起一次HTTP請求,需要寫一遍設定超時時間、設定請求頭、錯誤處理等等操作。這種重複勞動不僅浪費時間,而且讓程式碼變得冗餘不堪,難以維護;為了提高我們的程式碼質量,應該在專案中二次封裝一下axios再使用,這樣可以讓使用更為便利。
本教學操作環境: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 })頁面中就能直接呼叫
// .vue import { getorglist } from '@/assets/js/api' getorglist({ id: 200 }).then(res => { console.log(res) })這樣可以把api統一管理起來,以後維護修改只需要在api.js檔案操作即可
請求攔截器
// 请求拦截器 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 沒有一個絕對的標準,只要你的封裝可以滿足你的專案需求,並且用起來方便,那就是一個好的封裝方案
【相關推薦:
vuejs影片教學、web前端開發】
以上是vue封裝axios有什麼用的詳細內容。更多資訊請關注PHP中文網其他相關文章!