分类目录: html5
Vue3+ts封装axios
Post date:
Author: cyy
Number of comments: no comments
1.安装axios
cnpm i axios --save-dev
2.新建request.ts文件:
这里的message我用的是ant-design-vue,你们可以替换成你们使用的UI框架
import axios, {AxiosInstance, AxiosError, AxiosRequestConfig, AxiosResponse} from 'axios'
import {message} from 'ant-design-vue'
import store from "@/store";
const BaseURL = process.env.VUE_APP_BASE_URL;
// 数据返回的接口
// 定义请求响应参数,不含data
interface Result {
code: number;
msg: string
}
// 请求响应参数,包含data
interface ResultData<T = any> extends Result {
data?: T;
}
const URL: string = BaseURL
enum RequestEnums {
TIMEOUT = 20000,
OVERDUE = 600, // 登录失效
FAIL = 999, // 请求失败
SUCCESS = 200, // 请求成功
}
const config = {
// 默认地址
baseURL: URL as string,
// 设置超时时间
timeout: RequestEnums.TIMEOUT as number,
// 跨域时候允许携带凭证
withCredentials: true
}
class RequestHttp {
// 定义成员变量并指定类型
service: AxiosInstance;
public constructor(config: AxiosRequestConfig) {
// 实例化axios
this.service = axios.create(config);
/**
* 请求拦截器
* 客户端发送请求 -> [请求拦截器] -> 服务器
* token校验(JWT) : 接受服务器返回的token,存储到vuex/pinia/本地储存当中
*/
this.service.interceptors.request.use(
(config: AxiosRequestConfig) => {
store.state.loading = true; // 显示加载中
const token = localStorage.getItem('token') || '';
return {
...config,
headers: {
'token': token // 请求头中携带token信息
// 'x-access-token': token, // 请求头中携带token信息
}
}
},
(error: AxiosError) => {
// 请求报错
Promise.reject(error)
}
)
/**
* 响应拦截器
* 服务器换返回信息 -> [拦截统一处理] -> 客户端JS获取到信息
*/
this.service.interceptors.response.use(
(response: AxiosResponse) => {
store.state.loading = false; // 关闭加载中
const {data, config} = response; // 解构
if (data.code === RequestEnums.OVERDUE) {
// 登录信息失效,应跳转到登录页面,并清空本地的token
localStorage.setItem('token', '');
// router.replace({
// path: '/login'
// })
return Promise.reject(data);
}
// 全局错误信息拦截(防止下载文件得时候返回数据流,没有code,直接报错)
if (data.code && data.code !== RequestEnums.SUCCESS) {
message.error(data.message); // 此处也可以使用组件提示报错信息
return Promise.reject(data)
}
return data;
},
(error: AxiosError) => {
store.state.loading = false; // 关闭加载中
const {response} = error;
if (response) {
this.handleCode(response.status)
}
if (!window.navigator.onLine) {
message.error('网络连接失败');
// 可以跳转到错误页面,也可以不做操作
// return router.replace({
// path: '/404'
// });
}
}
)
}
handleCode(code: number):void {
switch(code) {
case 401:
message.error('登录失败,请重新登录');
break;
default:
message.error('请求失败');
break;
}
}
// 常用方法封装
get<T>(url: string, params?: object): Promise<ResultData<T>> {
return this.service.get(url, {params});
}
post<T>(url: string, params?: object): Promise<ResultData<T>> {
return this.service.post(url, params);
}
put<T>(url: string, params?: object): Promise<ResultData<T>> {
return this.service.put(url, params);
}
delete<T>(url: string, params?: object): Promise<ResultData<T>> {
return this.service.delete(url, {params});
}
}
// 导出一个实例对象
export default new RequestHttp(config);
3.编写API接口
import request from '@/utils/request'
// 用户登录
export const postLogin = (params: any) => {
return request.post('/user/login', params);
}
4.项目中使用
import {postLogin} from '@/api/login'
const onLogin = async () => {
const param = {
account: loginForm.acc,
password: loginForm.psd
}
await postLogin(param).then(response => {
const res: any = response.data
// TODO 写你的逻辑
})
}
该封装参考自(侵删):