首页 > 其他分享 >axios+ts 使用类class的二次封装(全面封装)

axios+ts 使用类class的二次封装(全面封装)

时间:2023-01-25 21:55:24浏览次数:51  
标签:axios 封装 data object ts return error import config

import axios, { AxiosInstance, AxiosError, AxiosRequestConfig, AxiosResponse } from "axios";
import { showFullScreenLoading, tryHideFullScreenLoading } from "@/config/serviceLoading";
import { ResultData } from "@/api/interface";
import { ResultEnum } from "@/enums/httpEnum";
import { checkStatus } from "./helper/checkStatus";
import { ElMessage } from "element-plus";
import { GlobalStore } from "@/store";
import { LOGIN_URL } from "@/config/config";
import router from "@/routers";

/**
 * pinia 错误使用说明示例
 * https://github.com/vuejs/pinia/discussions/971
 * https://github.com/vuejs/pinia/discussions/664#discussioncomment-1329898
 * https://pinia.vuejs.org/core-concepts/outside-component-usage.html#single-page-applications
 */

const config = {
	// 默认地址请求地址,可在 .env 开头文件中修改,这里无需断言,vite-env.d.ts里已经作了判断
	baseURL: import.meta.env.VITE_API_URL,
	// 设置超时时间(10s)
	timeout: ResultEnum.TIMEOUT as number,
	// 跨域时候允许携带凭证
	withCredentials: true
};

class RequestHttp {
	service: AxiosInstance;
	public constructor(config: AxiosRequestConfig) {
		// 实例化axios
		this.service = axios.create(config);

		/**
		 * @description 请求拦截器
		 * 客户端发送请求 -> [请求拦截器] -> 服务器
		 * token校验(JWT) : 接受服务器返回的token,存储到vuex/pinia/本地储存当中
		 */
		this.service.interceptors.request.use(
			(config: AxiosRequestConfig) => {
				const globalStore = GlobalStore();
				// * 如果当前请求不需要显示 loading,在 api 服务中通过指定的第三个参数: { headers: { noLoading: true } }来控制不显示loading,参见loginApi
				config.headers!.noLoading || showFullScreenLoading();
				const token: string = globalStore.token;
				return { ...config, headers: { ...config.headers, "x-access-token": token } };
			},
			(error: AxiosError) => {
				return Promise.reject(error);
			}
		);

		/**
		 * @description 响应拦截器
		 *  服务器换返回信息 -> [拦截统一处理] -> 客户端JS获取到信息
		 */
		this.service.interceptors.response.use(
			(response: AxiosResponse) => {
				const { data } = response;
				const globalStore = GlobalStore();
				// * 在请求结束后,并关闭请求 loading
				tryHideFullScreenLoading();
				// * 登陆失效(code == 401)
				if (data.code == ResultEnum.OVERDUE) {
					ElMessage.error(data.msg);
					globalStore.setToken("");
					router.replace(LOGIN_URL);
					return Promise.reject(data);
				}
				// * 全局错误信息拦截(防止下载文件得时候返回数据流,没有code,直接报错)
				if (data.code && data.code !== ResultEnum.SUCCESS) {
					ElMessage.error(data.msg);
					return Promise.reject(data);
				}
				// * 成功请求(在页面上除非特殊情况,否则不用处理失败逻辑)
				return data;
			},
			async (error: AxiosError) => {
				const { response } = error;
				tryHideFullScreenLoading();
				// 请求超时单独判断,因为请求超时没有 response
				if (error.message.indexOf("timeout") !== -1) ElMessage.error("请求超时!请您稍后重试");
				// 根据响应的错误状态码,做不同的处理
				if (response) checkStatus(response.status);
				// 服务器结果都没有返回(可能服务器错误可能客户端断网),断网处理:可以跳转到断网页面
				if (!window.navigator.onLine) router.replace("/500");
				return Promise.reject(error);
			}
		);
	}

	// * 常用请求方法封装
	get<T>(url: string, params?: object, _object = {}): Promise<ResultData<T>> {
		return this.service.get(url, { params, ..._object });
	}
	post<T>(url: string, params?: object, _object = {}): Promise<ResultData<T>> {
		return this.service.post(url, params, _object);
	}
	put<T>(url: string, params?: object, _object = {}): Promise<ResultData<T>> {
		return this.service.put(url, params, _object);
	}
	delete<T>(url: string, params?: any, _object = {}): Promise<ResultData<T>> {
		return this.service.delete(url, { params, ..._object });
	}
}

export default new RequestHttp(config);

标签:axios,封装,data,object,ts,return,error,import,config
From: https://www.cnblogs.com/wanglei1900/p/17067343.html

相关文章

  • Jetson Xavier NX 试玩 (一)
    JetsonXavierNX试玩(一)环境搭建0前言NVIDIA家的Jetson系列是业内嵌入式边缘计算机的代表作,体积小,功能强是其最主要的优点。学院入手了一款JestonXavierNX,本意......
  • 对象流——ObjectInputStream和ObjectOutputStream
    >看一个需求将intnum=100这个int数据保存到文件中,注意不是100数字,而是int100,并且能够从文件中直接恢复int100将Dogdog=newDog(“小黄”,3)这个dog对象保存到文......
  • jetson nano yolov5
    ​​Yolov5学习笔记(2)——部署在jetsonnano上​​​​tensorrtx​​3.利用TRT加速部署模型3.1下载tensorrtx的源码很高兴你能来到这里,到这里已经完成了一半,是不是觉得很......
  • jetson nano包安装
    https://github.com/Angzz/DeformableV2/blob/master/docs/install/install-jetson.md​​nano上安装anaconda​​nanoinstallskleran​​​nanoinstallpytorch​​w......
  • BufferedOutputStream
    BufferedOutputStreamBufferedOutputStream是字节流,实现缓冲的输出流,可以将多个字节写入底层输出流中,而不必对每次字节写入调用底层系统应用实例完成音乐/图片的拷贝......
  • TS:菜单数组转树形,支持多级(递归)
    方法一import{menus}from'./menus.ts'functionlistToTree(list:any=[],options={},data=null){const{rootWhere,childsWhere,addChilds}=Obj......
  • 在React中,怎么用tailwind css(就叫顺丰吧 :D 。。。)封装Button组件
    我的目的想用tailwindcss来快速封装Button组件,而不是从更大型的UI库导入一个Button组件(那样就太大材小用)。几个工具从这抄的样式在学习怎么形成规范化的组件额,仅......
  • CInternetSession::OpenURL
    PSSIDNumber:172551ArticleLastModifiedon3/7/2005Theinformationinthisarticleappliesto:TheMicrosoftFoundationClasses(MFC),whenusedwith:Micr......
  • hdu:Simpsons’ Hidden Talents(kmp)
    ProblemDescriptionHomer:Marge,Ijustfiguredoutawaytodiscoversomeofthetalentsweweren’tawarewehad.Marge:Yeah,whatisit?Homer:Takemefor......
  • tss
    代码随想录|Day6-2|LC01两数之和、242.有效的字母异位词1.两数之和解法1,利用HashMap(map.get(Key))实现数的存储和输出classSolution{publicint[]two......