Vue3 + Axios + Ant Design Vue 請求封裝詳解教程(含 Token 鑒權、加密、下載)
一、完整源碼(請先閱讀)
import { message, Modal } from 'ant-design-vue';
import axios from 'axios';
import { localRead } from '/@/utils/local-util';
import { useUserStore } from '/@/store/modules/system/user';
import { decryptData, encryptData } from './encrypt';
import { DATA_TYPE_ENUM } from '../constants/common-const';
import _ from 'lodash';
import LocalStorageKeyConst from '/@/constants/local-storage-key-const.js';// token的消息頭
const TOKEN_HEADER = 'Authorization';// 創建axios對象
const smartAxios = axios.create({baseURL: import.meta.env.VITE_APP_API_URL,
});// 退出系統
function logout() {useUserStore().logout();location.href = '/';
}// ================================= 請求攔截器 =================================smartAxios.interceptors.request.use((config) => {// 在發送請求之前消息頭加入token tokenconst token = localRead(LocalStorageKeyConst.USER_TOKEN);if (token) {config.headers[TOKEN_HEADER] = 'Bearer ' + token;} else {delete config.headers[TOKEN_HEADER];}return config;},(error) => {// 對請求錯誤做些什么return Promise.reject(error);}
);// ================================= 響應攔截器 =================================// 添加響應攔截器
smartAxios.interceptors.response.use((response) => {// 根據content-type ,判斷是否為 json 數據let contentType = response.headers['content-type'] ? response.headers['content-type'] : response.headers['Content-Type'];if (contentType.indexOf('application/json') === -1) {return Promise.resolve(response);}// 如果是json數據if (response.data && response.data instanceof Blob) {return Promise.reject(response.data);}// 如果是加密數據if (response.data.dataType === DATA_TYPE_ENUM.ENCRYPT.value) {response.data.encryptData = response.data.data;let decryptStr = decryptData(response.data.data);if (decryptStr) {response.data.data = JSON.parse(decryptStr);}}const res = response.data;if (res.code && res.code !== 1) {// `token` 過期或者賬號已在別處登錄if (res.code === 30007 || res.code === 30008) {message.destroy();message.error('您沒有登錄,請重新登錄');setTimeout(logout, 300);return Promise.reject(response);}// 等保安全的登錄提醒if (res.code === 30010 || res.code === 30011) {Modal.error({title: '重要提醒',content: res.msg,});return Promise.reject(response);}// 長時間未操作系統,需要重新登錄if (res.code === 30012) {Modal.error({title: '重要提醒',content: res.msg,onOk: logout,});setTimeout(logout, 3000);return Promise.reject(response);}message.destroy();message.error(res.msg);return Promise.reject(response);} else {return Promise.resolve(res);}},(error) => {// 對響應錯誤做點什么if (error.message.indexOf('timeout') !== -1) {message.destroy();message.error('網絡超時');} else if (error.message === 'Network Error') {message.destroy();message.error('網絡連接錯誤');} else if (error.message.indexOf('Request') !== -1) {message.destroy();message.error('網絡發生錯誤');}return Promise.reject(error);}
);// ================================= 對外提供請求方法:通用請求,get, post, 下載download等 =================================/*** get請求*/
export const getRequest = (url, params) => {return request({ url, method: 'get', params });
};/*** 通用請求封裝* @param config*/
export const request = (config) => {return smartAxios.request(config);
};/*** post請求*/
export const postRequest = (url, data) => {return request({data,url,method: 'post',});
};// ================================= 加密 =================================/*** 加密請求參數的post請求*/
export const postEncryptRequest = (url, data) => {return request({data: { encryptData: encryptData(data) },url,method: 'post',});
};// ================================= 下載 =================================export const postDownload = function (url, data) {request({method: 'post',url,data,responseType: 'blob',}).then((data) => {handleDownloadData(data);}).catch((error) => {handleDownloadError(error);});
};/*** 文件下載*/
export const getDownload = function (url, params) {request({method: 'get',url,params,responseType: 'blob',}).then((data) => {handleDownloadData(data);}).catch((error) => {handleDownloadError(error);});
};function handleDownloadError(error) {if (error instanceof Blob) {const fileReader = new FileReader();fileReader.readAsText(error);fileReader.onload = () => {const msg = fileReader.result;const jsonMsg = JSON.parse(msg);message.destroy();message.error(jsonMsg.msg);};} else {message.destroy();message.error('網絡發生錯誤', error);}
}function handleDownloadData(response) {if (!response) {return;}// 獲取返回類型let contentType = _.isUndefined(response.headers['content-type']) ? response.headers['Content-Type'] : response.headers['content-type'];// 構建下載數據let url = window.URL.createObjectURL(new Blob([response.data], { type: contentType }));let link = document.createElement('a');link.style.display = 'none';link.href = url;// 從消息頭獲取文件名let str = _.isUndefined(response.headers['content-disposition'])? response.headers['Content-Disposition'].split(';')[1]: response.headers['content-disposition'].split(';')[1];let filename = _.isUndefined(str.split('fileName=')[1]) ? str.split('filename=')[1] : str.split('fileName=')[1];link.setAttribute('download', decodeURIComponent(filename));// 觸發點擊下載document.body.appendChild(link);link.click();// 下載完釋放document.body.removeChild(link);window.URL.revokeObjectURL(url);
}
二、源碼詳解
1. 依賴與常量
import { message, Modal } from 'ant-design-vue'; // 用于彈出消息和模態框提示
import axios from 'axios'; // axios 請求庫
import { localRead } from '/@/utils/local-util'; // 本地存儲讀取工具
import { useUserStore } from '/@/store/modules/system/user'; // 用戶狀態管理
import { decryptData, encryptData } from './encrypt'; // 加解密函數
import { DATA_TYPE_ENUM } from '../constants/common-const'; // 數據類型常量
import _ from 'lodash'; // 工具庫
import LocalStorageKeyConst from '/@/constants/local-storage-key-const.js'; // 本地存儲key常量const TOKEN_HEADER = 'Authorization'; // 請求頭攜帶token的鍵名
2. 創建 Axios 實例
const smartAxios = axios.create({baseURL: import.meta.env.VITE_APP_API_URL, // 基礎請求地址從環境變量讀取
});
3. 退出登錄
function logout() {useUserStore().logout(); // 調用用戶狀態登出方法location.href = '/'; // 跳轉到登錄頁或首頁
}
4. 請求攔截器
smartAxios.interceptors.request.use((config) => {const token = localRead(LocalStorageKeyConst.USER_TOKEN); // 從本地獲取tokenif (token) {config.headers[TOKEN_HEADER] = 'Bearer ' + token; // 自動添加到請求頭} else {delete config.headers[TOKEN_HEADER]; // 無token則刪除}return config;},(error) => {return Promise.reject(error); // 請求錯誤直接拋出}
);
作用:每個請求發送前自動帶上 token,方便后端身份校驗。
5. 響應攔截器
smartAxios.interceptors.response.use((response) => {// 判斷響應內容是否是 JSONlet contentType = response.headers['content-type'] || response.headers['Content-Type'];if (contentType.indexOf('application/json') === -1) {return Promise.resolve(response); // 非 JSON,直接返回原始響應}// 響應是 Blob 類型異常處理if (response.data && response.data instanceof Blob) {return Promise.reject(response.data);}// 解密處理if (response.data.dataType === DATA_TYPE_ENUM.ENCRYPT.value) {response.data.encryptData = response.data.data;let decryptStr = decryptData(response.data.data);if (decryptStr) {response.data.data = JSON.parse(decryptStr);}}const res = response.data;// 業務異常處理,code !== 1 表示失敗if (res.code && res.code !== 1) {// 令牌失效或賬號異地登錄if (res.code === 30007 || res.code === 30008) {message.destroy();message.error('您沒有登錄,請重新登錄');setTimeout(logout, 300);return Promise.reject(response);}// 安全登錄提醒if (res.code === 30010 || res.code === 30011) {Modal.error({ title: '重要提醒', content: res.msg });return Promise.reject(response);}// 長時間未操作需重新登錄if (res.code === 30012) {Modal.error({ title: '重要提醒', content: res.msg, onOk: logout });setTimeout(logout, 3000);return Promise.reject(response);}message.destroy();message.error(res.msg);return Promise.reject(response);} else {return Promise.resolve(res); // 成功返回業務數據}},(error) => {// 網絡錯誤統一提示if (error.message.includes('timeout')) {message.destroy();message.error('網絡超時');} else if (error.message === 'Network Error') {message.destroy();message.error('網絡連接錯誤');} else if (error.message.includes('Request')) {message.destroy();message.error('網絡發生錯誤');}return Promise.reject(error);}
);
作用:統一處理服務器響應,自動解密、鑒權失效跳轉、提示錯誤信息。
6. 通用請求封裝(GET,POST)
export const getRequest = (url, params) => {return request({ url, method: 'get', params });
};export const postRequest = (url, data) => {return request({ url, method: 'post', data });
};export const request = (config) => {return smartAxios.request(config);
};
統一通過
request
發起請求,方便未來統一處理或擴展。
7. 加密請求
export const postEncryptRequest = (url, data) => {return request({url,method: 'post',data: { encryptData: encryptData(data) }, // 發送加密后的數據});
};
對敏感參數統一加密,保證傳輸安全。
8. 文件下載封裝
export const postDownload = (url, data) => {request({url,method: 'post',data,responseType: 'blob',}).then(handleDownloadData).catch(handleDownloadError);
};export const getDownload = (url, params) => {request({url,method: 'get',params,responseType: 'blob',}).then(handleDownloadData).catch(handleDownloadError);
};
支持 GET/POST 下載,返回二進制流。
9. 下載結果與錯誤處理
function handleDownloadError(error) {if (error instanceof Blob) {const fileReader = new FileReader();fileReader.readAsText(error);fileReader.onload = () => {const msg = fileReader.result;const jsonMsg = JSON.parse(msg);message.destroy();message.error(jsonMsg.msg);};} else {message.destroy();message.error('網絡發生錯誤', error);}
}function handleDownloadData(response) {if (!response) return;let contentType = _.isUndefined(response.headers['content-type']) ? response.headers['Content-Type'] : response.headers['content-type'];let url = window.URL.createObjectURL(new Blob([response.data], { type: contentType }));let link = document.createElement('a');link.style.display = 'none';link.href = url;let str = _.isUndefined(response.headers['content-disposition'])? response.headers['Content-Disposition'].split(';')[1]: response.headers['content-disposition'].split(';')[1];let filename = _.isUndefined(str.split('fileName=')[1]) ? str.split('filename=')[1] : str.split('fileName=')[1];link.setAttribute('download', decodeURIComponent(filename));document.body.appendChild(link);link.click();document.body.removeChild(link);window.URL.revokeObjectURL(url);
}
處理下載文件流,自動從響應頭解析文件名并觸發瀏覽器下載。錯誤時嘗試讀取 Blob 里的錯誤信息并提示。
三、總結
- 封裝 axios 實例方便集中管理基礎地址、攔截器、錯誤處理。
- 請求攔截器自動附帶 token,保證鑒權。
- 響應攔截器統一處理異常、token失效自動登出、數據加密解密。
- 請求方法封裝標準的
getRequest
、postRequest
和加密postEncryptRequest
。 - 文件下載封裝支持流下載及錯誤提示,提升用戶體驗。
- 使用此封裝,業務代碼只需專注調用接口,提升開發效率和代碼規范。