基于axios請求封裝的vue應用實例代碼
更新時間：2021年05月06日 15:27:02 作者：知青先生
這篇文章主要給大家介紹了基于axios請求封裝的vue應用的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
什么是axios？
Axios 是一個基于 promise 的 HTTP 庫，可以用在瀏覽器和 node.js 中。
特性：
- 從瀏覽器中創(chuàng)建 XMLHttpRequests
- 從 node.js 創(chuàng)建 http 請求
- 支持 Promise API
- 攔截請求和響應
- 轉換請求數(shù)據(jù)和響應數(shù)據(jù)
- 取消請求
- 自動轉換 JSON 數(shù)據(jù)
- 客戶端支持防御 XSRF
Promises
axios 依賴原生的 ES6 Promise 實現(xiàn)而被支持. 如果你的環(huán)境不支持 ES6 Promise，你可以使用 polyfill.
axios的請求類型？
安裝好node的一套環(huán)境：
一下三種引用方式:
npm install axios -先在node中安裝axios，api封裝中引入axios即可
bower install axios --npm中安裝 bower，在bower中引入axios包
bower：
Bower可以管理包含HTML，CSS，JavaScript，字體甚至圖像文件的組件。Bower不會串聯(lián)或縮小代碼或執(zhí)行其他任何操作-只會安裝所需的正確版本的軟件包及其依賴項。
直接vue中引入js文件
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
axios封裝默認的自定義配置
const instance = axios.create({
{
// `url` 是用于請求的服務器 URL
url: '/user',
// `method` 是創(chuàng)建請求時使用的方法
method: 'get', // default
// `baseURL` 將自動加在 `url` 前面，除非 `url` 是一個絕對 URL。
// 它可以通過設置一個 `baseURL` 便于為 axios 實例的方法傳遞相對 URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允許在向服務器發(fā)送前，修改請求數(shù)據(jù)
// 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個請求方法
// 后面數(shù)組中的函數(shù)必須返回一個字符串，或 ArrayBuffer，或 Stream
transformRequest: [function (data, headers) {
// 對 data 進行任意轉換處理
return data;
}],
// `transformResponse` 在傳遞給 then/catch 前，允許修改響應數(shù)據(jù)
transformResponse: [function (data) {
// 對 data 進行任意轉換處理
return data;
}],
// `headers` 是即將被發(fā)送的自定義請求頭
headers: {'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即將與請求一起發(fā)送的 URL 參數(shù)
// 必須是一個無格式對象(plain object)或 URLSearchParams 對象
params: {
ID: 12345
},
// `paramsSerializer` 是一個負責 `params` 序列化的函數(shù)
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function(params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
},
// `data` 是作為請求主體被發(fā)送的數(shù)據(jù)
// 只適用于這些請求方法 'PUT', 'POST', 和 'PATCH'
// 在沒有設置 `transformRequest` 時，必須是以下類型之一：
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 瀏覽器專屬：FormData, File, Blob
// - Node 專屬： Stream
data: {
firstName: 'Fred'
},
// `timeout` 指定請求超時的毫秒數(shù)(0 表示無超時時間)
// 如果請求話費了超過 `timeout` 的時間，請求將被中斷
timeout: 1000,
// `withCredentials` 表示跨域請求時是否需要使用憑證
withCredentials: false, // default
// `adapter` 允許自定義處理請求，以使測試更輕松
// 返回一個 promise 并應用一個有效的響應 (查閱 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示應該使用 HTTP 基礎驗證，并提供憑據(jù)
// 這將設置一個 `Authorization` 頭，覆寫掉現(xiàn)有的任意使用 `headers` 設置的自定義 `Authorization`頭
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服務器響應的數(shù)據(jù)類型，可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json', // default
// `responseEncoding` indicates encoding to use for decoding responses
// Note: Ignored for `responseType` of 'stream' or client-side requests
responseEncoding: 'utf8', // default
// `xsrfCookieName` 是用作 xsrf token 的值的cookie的名稱
xsrfCookieName: 'XSRF-TOKEN', // default
// `xsrfHeaderName` is the name of the http header that carries the xsrf token value
xsrfHeaderName: 'X-XSRF-TOKEN', // default
// `onUploadProgress` 允許為上傳處理進度事件
onUploadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
// `onDownloadProgress` 允許為下載處理進度事件
onDownloadProgress: function (progressEvent) {
// 對原生進度事件的處理
},
// `maxContentLength` 定義允許的響應內容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定義對于給定的HTTP 響應狀態(tài)碼是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者設置為 `null` 或 `undefined`)，promise 將被 resolve; 否則，promise 將被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
// `maxRedirects` 定義在 node.js 中 follow 的最大重定向數(shù)目
// 如果設置為0，將不會 follow 任何重定向
maxRedirects: 5, // default
// `socketPath` defines a UNIX Socket to be used in node.js.
// e.g. '/var/run/docker.sock' to send requests to the docker daemon.
// Only either `socketPath` or `proxy` can be specified.
// If both are specified, `socketPath` is used.
socketPath: null, // default
// `httpAgent` 和 `httpsAgent` 分別在 node.js 中用于定義在執(zhí)行 http 和 https 時使用的自定義代理。允許像這樣配置選項：
// `keepAlive` 默認沒有啟用
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
// 'proxy' 定義代理服務器的主機名稱和端口
// `auth` 表示 HTTP 基礎驗證應當用于連接代理，并提供憑據(jù)
// 這將會設置一個 `Proxy-Authorization` 頭，覆寫掉已有的通過使用 `header` 設置的自定義 `Proxy-Authorization` 頭。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// `cancelToken` 指定用于取消請求的 cancel token
// （查看后面的 Cancellation 這節(jié)了解更多）
cancelToken: new CancelToken(function (cancel) {
})
}
}).then(function(response){
// `data` 由服務器提供的響應
data: {},
// `status` 來自服務器響應的 HTTP 狀態(tài)碼
status: 200,
// `statusText` 來自服務器響應的 HTTP 狀態(tài)信息
statusText: 'OK',
// `headers` 服務器響應的頭
headers: {},
// `config` 是為請求提供的配置信息
config: {},
// 'request'
// `request` is the request that generated this response
// It is the last ClientRequest instance in node.js (in redirects)
// and an XMLHttpRequest instance the browser
request: {}
});
配置的加載優(yōu)先級
高到低順序：
第一步：配置默認值
在請求中設置的配置項
instance.get('/longRequest', {
timeout: 5000
});
第二部：全局的 axios 默認值
在api文件中設置的配置項
instance.defaults.timeout = 2500;
第三步：自定義實例默認值
在創(chuàng)建axios實例中設置的配置項
var instance = axios.create();
攔截器
// 添加請求攔截器
axios.interceptors.request.use(function (config) {
// 在發(fā)送請求之前做些什么
return config;
}, function (error) {
// 對請求錯誤做些什么
return Promise.reject(error);
});
// 添加響應攔截器
axios.interceptors.response.use(function (response) {
// 對響應數(shù)據(jù)做點什么
return response;
}, function (error) {
switch (err.response.status) {
case 400:
err.message = '錯誤請求';
break;
case 401:
err.message = '未授權，請重新登錄';
break;
case 403:
err.message = '拒絕訪問';
break;
case 404:
err.message = '請求錯誤,未找到該資源';
break;
case 405:
err.message = '請求方法未允許';
break;
case 408:
err.message = '請求超時';
break;
case 415:
err.message = '服務器無法處理請求附帶的媒體格式';
break;
case 500:
err.message = '服務器出錯';
break;
case 501:
err.message = '網絡未實現(xiàn)';
break;
case 502:
err.message = '網絡錯誤';
break;
case 503:
err.message = '服務不可用';
break;
case 504:
err.message = '網絡超時';
break;
case 505:
err.message = 'http版本不支持該請求';
break;
default:
err.message = `連接錯誤${err.response.status}`;
}
} else {
err.message = '連接到服務器失敗';
}
return Promise.resolve(err.response);
});
import Vue from ‘vue';
import axios from ‘axios';
get請求
axios.get({
method:'get',
url:'xxxx',
reponseType:'',//相應類型
parems:{//入參
}
}).then(function(response){
....
})
post請求
axios({
method: 'post',
url: '/user/12345',
data: {
firstName: 'Fred',
lastName: 'Flintstone'
}
}).then(function(res){
});
delete請求
axios({
method: 'delete',
url: '/user/12345',
//入參一：掛載到請求后面
parmes：{
}
//入參二：掛載到請求體內
data{
}
}).then(function(res){
});
put請求：更新整個對象資源
axios({
method: 'put',
url: '/user/12345',
data{
}
}).then(function(res){
});
patch請求：更新對象的局部資源
axios({
method: 'patch',
url: '/user/12345',
data{
}
}).then(function(res){
});
提供封裝后的另一種寫法：
axios.get(url[, config])
axios.delete(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])
并發(fā)請求
axios.all(iterable)
axios.spread(callback)
function getUserAccount() {
return axios.get('/user/12345');
}
function getUserPermissions() {
return axios.get('/user/12345/permissions');
}
//請求數(shù)組
axios.all([getUserAccount(), getUserPermissions()])
.then(axios.spread(function (acct, perms) {//對應請求的響應體
// 兩個請求現(xiàn)在都執(zhí)行完成
}));
axios與ajax的區(qū)別？
axios：
從 node.js 創(chuàng)建 http 請求
支持 Promise API
客戶端支持防止CSRF
提供了一些并發(fā)請求的接口（重要，方便了很多的操作）
ajax：
3.JQuery整個項目太大，單純使用ajax卻要引入整個JQuery非常的不合理（采取個性化打包的方案又不能享受CDN服務）
axios怎樣自定義封裝？
1、建立接口請求封裝、響應、攔截、認證、等基礎配置文件 index.js
引入靜態(tài)資源
import axios from 'axios';
import qs from 'qs';
import apiMap from './apiMap';
設置全局默認參數(shù)
axios.defaults.withCredentials = false;
axios.defaults.headers.post['Content-Type'] = 'application/json;charset=UTF-8';
設置請求默認參數(shù)
const instance = axios.create({
baseURL: process.env.API_ROOT,
timeout: 15 * 1000,
auth: {
...
},
headers: {
'Content-Type': 'application/json;charset=utf-8',
'X-Requested-With': 'XMLHttpRequest',
},
},
);
設置請求攔截：
instance.interceptors.request.use(function (config) {
...
})
設置相應攔截：
// 響應攔截器即異常處理
instance.interceptors.response.use(response =>
response
, (err) => {
if (err && err.response) {
switch (err.response.status) {
case 400:
err.message = '錯誤請求';
break;
case 401:
err.message = '未授權，請重新登錄';
break;
case 403:
err.message = '拒絕訪問';
break;
case 404:
err.message = '請求錯誤,未找到該資源';
break;
case 405:
err.message = '請求方法未允許';
break;
case 408:
err.message = '請求超時';
break;
case 415:
err.message = '服務器無法處理請求附帶的媒體格式';
break;
case 500:
err.message = '服務器出錯';
break;
case 501:
err.message = '網絡未實現(xiàn)';
break;
case 502:
err.message = '網絡錯誤';
break;
case 503:
err.message = '服務不可用';
break;
case 504:
err.message = '網絡超時';
break;
case 505:
err.message = 'http版本不支持該請求';
break;
default:
err.message = `連接錯誤${err.response.status}`;
}
} else {
err.message = '連接到服務器失敗';
}
return Promise.resolve(err.response);
});
封裝接口請求：
let api={
/**
* get 方法封裝
* @param url
* @param params
* @returns {Promise}
*/
get (url, params = {}) {
return new Promise((resolve, reject) => {
instance.get(apiMap[url],params).then(res => {
resolve(res.data)
}).catch(err => {
reject(err)
})
})
},
/**
* post
* @param url
* @param params
* @returns {Promise}
*/
post (url, params = {}) {
return new Promise((resolve, reject) => {
instance.post(apiMap[url], params)
.then(res => {
resolve(res.data)
}, err => {
reject(err)
})
})
},
/**
* delete 方法封裝
* @param url
* @param params
* @returns {Promise}
*/
delete (url, params = {}) {
return new Promise((resolve, reject) => {
instance.delete(apiMap[url] ,params).then(res => {
resolve(res.data)
}).catch(err => {
reject(err)
})
})
},
/**
* put 方法封裝
* @param url
* @param params
* @returns {Promise}
*/
put (url, params = {}) {
return new Promise((resolve, reject) => {
instance.put(apiMap[url], params).then(res => {
resolve(res.data)
}).catch(err => {
reject(err)
})
})
},
/**
* patch 方法封裝
* @param url
* @param params
* @returns {Promise}
*/
patch (url, params = {}) {
return new Promise((resolve, reject) => {
instance.patch(apiMap[url], params).then(res => {
resolve(res.data)
}).catch(err => {
reject(err)
})
})
}
}
export default api;
2、創(chuàng)建一個key-vlue形式的接口文件，方便接口請求管理 apiMap.js
export default {
// 主題列表
key: 'path'
};
3、將index文件引入vue入口文件中
引入vue資源 import Vue from 'vue' 引入viewui插件 import ViewUI from 'view-design'; 引入viewuicss文件 import 'view-design/dist/styles/iview.css'; 導入文件|默認不需要加文件后綴 import Api from '/index'; 全局綁定|$ 為實例屬性設置作用域 Vue.prototype.$api = Api;
全局參數(shù)配置：
創(chuàng)建配置文件index.js：
import Vue from 'vue';
import Vuex from 'vuex';
import State from './state';
Vue.use(Vuex);
const store = new Vuex.Store(State);
export default store;
創(chuàng)建全局參數(shù)詳細文件state.js
export default {
state: { //這里放全局參數(shù)
test: 0
},
mutations:{ //設置值
test(state,value)=>state.test=value;
},
getters:{//返回值
test: state =>state.test;
}
};
調用方式：
var data = this.$store.getter.test;
var data = this.$store.commit('test',數(shù)據(jù));
Vue.use(Vuex);
判斷vue是否已經注冊過vuex插件；
將vuexInit函數(shù)混入到vue的beforeCreate生命周期中;
實例化vue時，會在vue每個實例上添加s t o r e 屬 性 ， 并 將 v u e x 的 實 例 綁 定 到 store屬性，并將vuex的實例綁定
到store屬性，并將vuex的實例綁定到store屬性上。
總結
到此這篇關于基于axios請求封裝的vue應用的文章就介紹到這了,更多相關axios請求封裝內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了vue數(shù)據(jù)變化但頁面刷新問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-04-04
這篇文章主要為大家詳細介紹了Vue.js的Class與樣式綁定,具有一定的參考價值，感興趣的小伙伴們可以參考一下2016-09-09
vue3中storeToRefs讓store中的結構出來的數(shù)據(jù)也能變成響應式(推薦)
這篇文章主要介紹了vue3中storeToRefs讓store中的結構出來的數(shù)據(jù)也能變成響應式,本文通過實例代碼給大家介紹的分需要的朋友可以參考下2024-09-09
這篇文章主要為大家介紹了Vue響應式原理及雙向數(shù)據(jù)綁定的示例分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-07-07
這篇文章主要介紹了Vue3.0在組件外使用VueI18n的情況，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
這篇文章主要介紹了vue（2.x，3.0）配置跨域代理，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-11-11
<keep-alive> 是一個抽象組件,它自身不會渲染一個DOM元素,也不會出現(xiàn)在組件的父組件鏈中,下面這篇文章主要給大家介紹了關于vue3利用keepAlive緩存頁面的相關資料,需要的朋友可以參考下2022-11-11
這篇文章主要給大家介紹了關于Element-UI中el-table如何合并相同單元格的相關資料,el-table的組件的可以合并單元格,文中通過示例代碼介紹的非常詳細,需要的朋友可以參考下2023-08-08
今天小編就為大家分享一篇vue 解決循環(huán)引用組件報錯的問題，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-09-09
這篇文章主要介紹了vue解決刷新頁面時會出現(xiàn)變量閃爍的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-01-01