基于axios請(qǐng)求封裝的vue應(yīng)用實(shí)例代碼
更新時(shí)間：2021年05月06日 15:27:02 作者：知青先生
這篇文章主要給大家介紹了基于axios請(qǐng)求封裝的vue應(yīng)用的相關(guān)資料，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
什么是axios？
Axios 是一個(gè)基于 promise 的 HTTP 庫(kù)，可以用在瀏覽器和 node.js 中。
特性：
- 從瀏覽器中創(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
Promises
axios 依賴原生的 ES6 Promise 實(shí)現(xiàn)而被支持. 如果你的環(huán)境不支持 ES6 Promise，你可以使用 polyfill.
axios的請(qǐng)求類型？
安裝好node的一套環(huán)境：
一下三種引用方式:
npm install axios -先在node中安裝axios，api封裝中引入axios即可
bower install axios --npm中安裝 bower，在bower中引入axios包
bower：
Bower可以管理包含HTML，CSS，JavaScript，字體甚至圖像文件的組件。Bower不會(huì)串聯(lián)或縮小代碼或執(zhí)行其他任何操作-只會(huì)安裝所需的正確版本的軟件包及其依賴項(xiàng)。
直接vue中引入js文件
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
axios封裝默認(rèn)的自定義配置
const instance = axios.create({
{
// `url` 是用于請(qǐng)求的服務(wù)器 URL
url: '/user',
// `method` 是創(chuàng)建請(qǐng)求時(shí)使用的方法
method: 'get', // default
// `baseURL` 將自動(dòng)加在 `url` 前面，除非 `url` 是一個(gè)絕對(duì) URL。
// 它可以通過設(shè)置一個(gè) `baseURL` 便于為 axios 實(shí)例的方法傳遞相對(duì) URL
baseURL: 'https://some-domain.com/api/',
// `transformRequest` 允許在向服務(wù)器發(fā)送前，修改請(qǐng)求數(shù)據(jù)
// 只能用在 'PUT', 'POST' 和 'PATCH' 這幾個(gè)請(qǐng)求方法
// 后面數(shù)組中的函數(shù)必須返回一個(gè)字符串，或 ArrayBuffer，或 Stream
transformRequest: [function (data, headers) {
// 對(duì) data 進(jìn)行任意轉(zhuǎn)換處理
return data;
}],
// `transformResponse` 在傳遞給 then/catch 前，允許修改響應(yīng)數(shù)據(jù)
transformResponse: [function (data) {
// 對(duì) data 進(jìn)行任意轉(zhuǎn)換處理
return data;
}],
// `headers` 是即將被發(fā)送的自定義請(qǐng)求頭
headers: {'X-Requested-With': 'XMLHttpRequest'},
// `params` 是即將與請(qǐng)求一起發(fā)送的 URL 參數(shù)
// 必須是一個(gè)無格式對(duì)象(plain object)或 URLSearchParams 對(duì)象
params: {
ID: 12345
},
// `paramsSerializer` 是一個(gè)負(fù)責(zé) `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` 是作為請(qǐng)求主體被發(fā)送的數(shù)據(jù)
// 只適用于這些請(qǐng)求方法 'PUT', 'POST', 和 'PATCH'
// 在沒有設(shè)置 `transformRequest` 時(shí)，必須是以下類型之一：
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - 瀏覽器專屬：FormData, File, Blob
// - Node 專屬： Stream
data: {
firstName: 'Fred'
},
// `timeout` 指定請(qǐng)求超時(shí)的毫秒數(shù)(0 表示無超時(shí)時(shí)間)
// 如果請(qǐng)求話費(fèi)了超過 `timeout` 的時(shí)間，請(qǐng)求將被中斷
timeout: 1000,
// `withCredentials` 表示跨域請(qǐng)求時(shí)是否需要使用憑證
withCredentials: false, // default
// `adapter` 允許自定義處理請(qǐng)求，以使測(cè)試更輕松
// 返回一個(gè) promise 并應(yīng)用一個(gè)有效的響應(yīng) (查閱 [response docs](#response-api)).
adapter: function (config) {
/* ... */
},
// `auth` 表示應(yīng)該使用 HTTP 基礎(chǔ)驗(yàn)證，并提供憑據(jù)
// 這將設(shè)置一個(gè) `Authorization` 頭，覆寫掉現(xiàn)有的任意使用 `headers` 設(shè)置的自定義 `Authorization`頭
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
// `responseType` 表示服務(wù)器響應(yīng)的數(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` 允許為上傳處理進(jìn)度事件
onUploadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
// `onDownloadProgress` 允許為下載處理進(jìn)度事件
onDownloadProgress: function (progressEvent) {
// 對(duì)原生進(jìn)度事件的處理
},
// `maxContentLength` 定義允許的響應(yīng)內(nèi)容的最大尺寸
maxContentLength: 2000,
// `validateStatus` 定義對(duì)于給定的HTTP 響應(yīng)狀態(tài)碼是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者設(shè)置為 `null` 或 `undefined`)，promise 將被 resolve; 否則，promise 將被 rejecte
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
// `maxRedirects` 定義在 node.js 中 follow 的最大重定向數(shù)目
// 如果設(shè)置為0，將不會(huì) 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 時(shí)使用的自定義代理。允許像這樣配置選項(xiàng)：
// `keepAlive` 默認(rèn)沒有啟用
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
// 'proxy' 定義代理服務(wù)器的主機(jī)名稱和端口
// `auth` 表示 HTTP 基礎(chǔ)驗(yàn)證應(yīng)當(dāng)用于連接代理，并提供憑據(jù)
// 這將會(huì)設(shè)置一個(gè) `Proxy-Authorization` 頭，覆寫掉已有的通過使用 `header` 設(shè)置的自定義 `Proxy-Authorization` 頭。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: {
username: 'mikeymike',
password: 'rapunz3l'
}
},
// `cancelToken` 指定用于取消請(qǐng)求的 cancel token
// （查看后面的 Cancellation 這節(jié)了解更多）
cancelToken: new CancelToken(function (cancel) {
})
}
}).then(function(response){
// `data` 由服務(wù)器提供的響應(yīng)
data: {},
// `status` 來自服務(wù)器響應(yīng)的 HTTP 狀態(tài)碼
status: 200,
// `statusText` 來自服務(wù)器響應(yīng)的 HTTP 狀態(tài)信息
statusText: 'OK',
// `headers` 服務(wù)器響應(yīng)的頭
headers: {},
// `config` 是為請(qǐng)求提供的配置信息
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)先級(jí)
高到低順序：
第一步：配置默認(rèn)值
在請(qǐng)求中設(shè)置的配置項(xiàng)
instance.get('/longRequest', {
timeout: 5000
});
第二部：全局的 axios 默認(rèn)值
在api文件中設(shè)置的配置項(xiàng)
instance.defaults.timeout = 2500;
第三步：自定義實(shí)例默認(rèn)值
在創(chuàng)建axios實(shí)例中設(shè)置的配置項(xiàng)
var instance = axios.create();
攔截器
// 添加請(qǐng)求攔截器
axios.interceptors.request.use(function (config) {
// 在發(fā)送請(qǐng)求之前做些什么
return config;
}, function (error) {
// 對(duì)請(qǐng)求錯(cuò)誤做些什么
return Promise.reject(error);
});
// 添加響應(yīng)攔截器
axios.interceptors.response.use(function (response) {
// 對(duì)響應(yīng)數(shù)據(jù)做點(diǎn)什么
return response;
}, function (error) {
switch (err.response.status) {
case 400:
err.message = '錯(cuò)誤請(qǐng)求';
break;
case 401:
err.message = '未授權(quán)，請(qǐng)重新登錄';
break;
case 403:
err.message = '拒絕訪問';
break;
case 404:
err.message = '請(qǐng)求錯(cuò)誤,未找到該資源';
break;
case 405:
err.message = '請(qǐng)求方法未允許';
break;
case 408:
err.message = '請(qǐng)求超時(shí)';
break;
case 415:
err.message = '服務(wù)器無法處理請(qǐng)求附帶的媒體格式';
break;
case 500:
err.message = '服務(wù)器出錯(cuò)';
break;
case 501:
err.message = '網(wǎng)絡(luò)未實(shí)現(xiàn)';
break;
case 502:
err.message = '網(wǎng)絡(luò)錯(cuò)誤';
break;
case 503:
err.message = '服務(wù)不可用';
break;
case 504:
err.message = '網(wǎng)絡(luò)超時(shí)';
break;
case 505:
err.message = 'http版本不支持該請(qǐng)求';
break;
default:
err.message = `連接錯(cuò)誤${err.response.status}`;
}
} else {
err.message = '連接到服務(wù)器失敗';
}
return Promise.resolve(err.response);
});
import Vue from ‘vue';
import axios from ‘a(chǎn)xios';
get請(qǐng)求
axios.get({
method:'get',
url:'xxxx',
reponseType:'',//相應(yīng)類型
parems:{//入?yún)?
}
}).then(function(response){
....
})
post請(qǐng)求
axios({
method: 'post',
url: '/user/12345',
data: {
firstName: 'Fred',
lastName: 'Flintstone'
}
}).then(function(res){
});
delete請(qǐng)求
axios({
method: 'delete',
url: '/user/12345',
//入?yún)⒁唬簰燧d到請(qǐng)求后面
parmes：{
}
//入?yún)⒍簰燧d到請(qǐng)求體內(nèi)
data{
}
}).then(function(res){
});
put請(qǐng)求：更新整個(gè)對(duì)象資源
axios({
method: 'put',
url: '/user/12345',
data{
}
}).then(function(res){
});
patch請(qǐng)求：更新對(duì)象的局部資源
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ā)請(qǐng)求
axios.all(iterable)
axios.spread(callback)
function getUserAccount() {
return axios.get('/user/12345');
}
function getUserPermissions() {
return axios.get('/user/12345/permissions');
}
//請(qǐng)求數(shù)組
axios.all([getUserAccount(), getUserPermissions()])
.then(axios.spread(function (acct, perms) {//對(duì)應(yīng)請(qǐng)求的響應(yīng)體
// 兩個(gè)請(qǐng)求現(xiàn)在都執(zhí)行完成
}));
axios與ajax的區(qū)別？
axios：
從 node.js 創(chuàng)建 http 請(qǐng)求
支持 Promise API
客戶端支持防止CSRF
提供了一些并發(fā)請(qǐng)求的接口（重要，方便了很多的操作）
ajax：
3.JQuery整個(gè)項(xiàng)目太大，單純使用ajax卻要引入整個(gè)JQuery非常的不合理（采取個(gè)性化打包的方案又不能享受CDN服務(wù)）
axios怎樣自定義封裝？
1、建立接口請(qǐng)求封裝、響應(yīng)、攔截、認(rèn)證、等基礎(chǔ)配置文件 index.js
引入靜態(tài)資源
import axios from 'axios';
import qs from 'qs';
import apiMap from './apiMap';
設(shè)置全局默認(rèn)參數(shù)
axios.defaults.withCredentials = false;
axios.defaults.headers.post['Content-Type'] = 'application/json;charset=UTF-8';
設(shè)置請(qǐng)求默認(rèn)參數(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',
},
},
);
設(shè)置請(qǐng)求攔截：
instance.interceptors.request.use(function (config) {
...
})
設(shè)置相應(yīng)攔截：
// 響應(yīng)攔截器即異常處理
instance.interceptors.response.use(response =>
response
, (err) => {
if (err && err.response) {
switch (err.response.status) {
case 400:
err.message = '錯(cuò)誤請(qǐng)求';
break;
case 401:
err.message = '未授權(quán)，請(qǐng)重新登錄';
break;
case 403:
err.message = '拒絕訪問';
break;
case 404:
err.message = '請(qǐng)求錯(cuò)誤,未找到該資源';
break;
case 405:
err.message = '請(qǐng)求方法未允許';
break;
case 408:
err.message = '請(qǐng)求超時(shí)';
break;
case 415:
err.message = '服務(wù)器無法處理請(qǐng)求附帶的媒體格式';
break;
case 500:
err.message = '服務(wù)器出錯(cuò)';
break;
case 501:
err.message = '網(wǎng)絡(luò)未實(shí)現(xiàn)';
break;
case 502:
err.message = '網(wǎng)絡(luò)錯(cuò)誤';
break;
case 503:
err.message = '服務(wù)不可用';
break;
case 504:
err.message = '網(wǎng)絡(luò)超時(shí)';
break;
case 505:
err.message = 'http版本不支持該請(qǐng)求';
break;
default:
err.message = `連接錯(cuò)誤${err.response.status}`;
}
} else {
err.message = '連接到服務(wù)器失敗';
}
return Promise.resolve(err.response);
});
封裝接口請(qǐng)求：
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)建一個(gè)key-vlue形式的接口文件，方便接口請(qǐng)求管理 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'; 導(dǎo)入文件|默認(rèn)不需要加文件后綴 import Api from '/index'; 全局綁定|$ 為實(shí)例屬性設(shè)置作用域 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ù)詳細(xì)文件state.js
export default {
state: { //這里放全局參數(shù)
test: 0
},
mutations:{ //設(shè)置值
test(state,value)=>state.test=value;
},
getters:{//返回值
test: state =>state.test;
}
};
調(diào)用方式：
var data = this.$store.getter.test;
var data = this.$store.commit('test',數(shù)據(jù));
Vue.use(Vuex);
判斷vue是否已經(jīng)注冊(cè)過vuex插件；
將vuexInit函數(shù)混入到vue的beforeCreate生命周期中;
實(shí)例化vue時(shí)，會(huì)在vue每個(gè)實(shí)例上添加s t o r e 屬 性 ， 并 將 v u e x 的 實(shí) 例 綁 定 到 store屬性，并將vuex的實(shí)例綁定
到store屬性，并將vuex的實(shí)例綁定到store屬性上。
總結(jié)
到此這篇關(guān)于基于axios請(qǐng)求封裝的vue應(yīng)用的文章就介紹到這了,更多相關(guān)axios請(qǐng)求封裝內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
您可能感興趣的文章:
相關(guān)文章
使用vue-cli webpack 快速搭建項(xiàng)目的代碼
這篇文章主要介紹了vue-cli webpack 快速搭建項(xiàng)目的教程詳解，本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2018-11-11
vue中的核心就是組件，組件 (Component) 是 Vue.js 最強(qiáng)大的功能之一。組件可以擴(kuò)展 HTML 元素，封裝可重用的代碼，下面通過本文重點(diǎn)給大家介紹vue 創(chuàng)建組件及組件使用方法，感興趣的朋友一起看看吧2017-07-07
vue + any-touch實(shí)現(xiàn)一個(gè)iscroll 實(shí)現(xiàn)拖拽和滑動(dòng)動(dòng)畫效果
這篇文章主要介紹了vue + any-touch實(shí)現(xiàn)一個(gè)iscroll實(shí)現(xiàn)拖拽和滑動(dòng)動(dòng)畫效果，本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-04-04
Vue.js 實(shí)現(xiàn)微信公眾號(hào)菜單編輯器功能(二)
這篇文章主要介紹了Vue.js 實(shí)現(xiàn)微信公眾號(hào)菜單編輯器功能，非常不錯(cuò)，具有一定的參考借鑒價(jià)值，需要的朋友參考下吧2018-05-05
element滾動(dòng)條組件el-scrollbar的使用詳解
本文主要介紹了element滾動(dòng)條組件el-scrollbar的使用詳解，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-04-04
Vue中靈活拖拽的前端神器VueDraggablePlus的用法詳解
這篇文章主要介紹了一款功能強(qiáng)大、靈活易用的前端組件VueDraggablePlus,作為前端工程師,我們經(jīng)常會(huì)遇到需要實(shí)現(xiàn)拖拽功能的場(chǎng)景,而VueDraggablePlus正是為了解決這一痛點(diǎn)而誕生的,讓我們一起來看看它的特點(diǎn)和用法吧2024-03-03
在本文章里小編給大家整理了關(guān)于Vue中this.$nextTick的作用及用法，有需要的朋友們可以跟著學(xué)習(xí)參考下。2020-02-02
vue+vuex+json-seiver實(shí)現(xiàn)數(shù)據(jù)展示+分頁(yè)功能
這篇文章主要介紹了vue+vuex+json-seiver實(shí)現(xiàn)數(shù)據(jù)展示+分頁(yè)功能，非常不錯(cuò)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-04-04
下面小編就為大家分享一篇vue.js中$set與數(shù)組更新方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2018-03-03
詳解基于Vue cli開發(fā)修改外部組件Vant默認(rèn)樣式
這篇文章主要介紹了詳解基于Vue cli開發(fā)修改外部組件Vant默認(rèn)樣式,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-04-04