axios封装

该代码实现了一个基于axios的HTTP请求库,根据环境变量动态配置请求的基础URL,包括代理和生产环境的域名。同时,它包含请求和响应拦截器,处理请求头、超时以及HTTP状态码。此外,定义了post和get函数,支持不同数据返回级别。

fetch.ts

import axios from 'axios';
import type { AxiosInstance, AxiosRequestConfig } from 'axios';

const {
	NODE_ENV, // 环境变量
	REACT_APP_ENV // 环境标识
} = process.env;

// 是否为 mock 环境
const IS_MOCK = REACT_APP_ENV === 'mock';

// 是否为生产模式
const IS_PROD = NODE_ENV === 'production';

// 根据地址栏 path 确定请求二级 path
const pathname = window.location.pathname.split('/')[3] || '/';

const DEFAULT_SYMBOL = pathname === '/' ? 'device' : pathname;

// 开发环境: 代理标识
const PROXY_SYMBOL = IS_MOCK ? REACT_APP_ENV : `${DEFAULT_SYMBOL}-api`;

// 生产环境: 正式域名
const HOST_URL = process.env[`REACT_APP_HOST_${DEFAULT_SYMBOL.toUpperCase()}`];

// 基础URL
const baseurl = IS_PROD ? HOST_URL : PROXY_SYMBOL;

const dio: AxiosInstance = axios.create({
	// 设置baseUr地址,如果通过proxy跨域可直接填写base地址
	baseURL: baseurl,

	// 定义统一的请求头部
	headers: {
		'Content-Type': 'application/json'
	},

	// 配置请求超时时间
	timeout: 10000,
	// http 状态码判断
	validateStatus(status: number) {
		switch (status) {
			case 404:
				console.error('失去页面页');
				break;
			case 500:
				console.error('服务错误页');
				break;
			default:
				console.log('http码正常');
				break;
		}
		return status < 500;
	}
});
// 请求拦截
dio.interceptors.request.use(
	(config: AxiosRequestConfig) => {
		if (config.headers) {
			const header = config.headers;
			// header['Authorization'] = sessionStorage.getItem('Authorization');
		}
		return config;
	},
	error => {
		console.error('request interceptors', error);
	}
);

// 响应拦截
dio.interceptors.response.use(
	response => {
		// if ('headers' in response) sessionStorage.setItem('Authorization', response.headers.Authorization as string);
		return response;
	},
	error => Promise.reject(error)
);

export default dio;

dio.ts

import { AxiosRequestConfig, AxiosResponse } from 'axios';
import axios from './fetch';

type TDatalevel = 'data' | 'serve' | 'axios';
type RServe<T> = Promise<BaseResponse<T>>;
type RAxios<T> = Promise<AxiosResponse<BaseResponse<T>>>;
interface BaseResponse<T> {
	code: number;
	message: string;
	success: boolean;
	data: T;
}

function post<D, T>(url: string, data: D, datalevel?: 'data', config?: AxiosRequestConfig<D>): Promise<T>;
function post<D, T>(url: string, data: D, datalevel?: 'serve', config?: AxiosRequestConfig<D>): RServe<T>;
function post<D, T>(url: string, data: D, datalevel?: 'axios', config?: AxiosRequestConfig<D>): RAxios<T>;
function post<D, T>(url: string, data: D, datalevel: TDatalevel = 'data', config?: AxiosRequestConfig<D>) {
	return axios.post<D, AxiosResponse<BaseResponse<T>>>(url, data, config).then(res => {
		if (!res.data.success) throw res.data as BaseResponse<T>;
		switch (datalevel) {
			case 'data':
				return res.data.data;
			case 'serve':
				return res.data;
			case 'axios':
				return res;
		}
	});
}

function get<D, T>(url: string, config?: AxiosRequestConfig<D>, datalevel?: 'data'): Promise<T>;
function get<D, T>(url: string, config?: AxiosRequestConfig<D>, datalevel?: 'serve'): RServe<T>;
function get<D, T>(url: string, config?: AxiosRequestConfig<D>, datalevel?: 'axios'): RAxios<T>;
function get<D, T>(url: string, config?: AxiosRequestConfig<D>, datalevel: TDatalevel = 'data') {
	return axios.get<D, AxiosResponse<BaseResponse<T>>>(url, config).then(res => {
		if (!res.data.success) throw res.data as BaseResponse<T>;
		switch (datalevel) {
			case 'data':
				return res.data.data;
			case 'serve':
				return res.data;
			case 'axios':
				return res;
		}
	});
}

export { post, get };

type.ts

interface Ilist {
	title: string;
	agree: boolean;
	price: number;
	image: string;
	name: string;
	skuid: string;
	sort: number;
	cccc: number;
}
export interface Ilogin {
	aaa: string[];
	list: Ilist[];
}

index.ts

import { AxiosRequestConfig } from 'axios';
import { get, post } from './dio';
import type { Ilogin } from './type';
/**
 * 登录
 */
export const login = (_?: undefined) => post<unknown, Ilogin>('getTime', _, 'serve');

/**
 * 随机一句名言
 */
export const vote = (param: AxiosRequestConfig<unknown>) => get('sentences', param, 'axios');

### 如何封装 Axios 以简化 HTTP 请求并增强功能 #### 封装的意义 通过封装 Axios,开发者能够在 Vue 或其他前端框架中统一处理 HTTP 请求,从而提升代码的可维护性和可扩展性。这种封装方式允许配置统一的请求头、拦截器以及错误处理逻辑,减少冗余代码的同时也提高了开发效率[^1]。 --- #### 封装的具体实现步骤 ##### 1. 安装 Axios 在项目中引入 Axios 是第一步操作。可以通过 npm 或 yarn 进行安装: ```bash npm install axios ``` 或者使用 Yarn: ```bash yarn add axios ``` --- ##### 2. 创建 Axios 实例 为了便于管理和定制化需求,通常会创建一个独立的 Axios 实例,并在此基础上进行进一步封装。 ```javascript // src/utils/request.js import axios from 'axios'; const service = axios.create({ baseURL: process.env.VUE_APP_BASE_API, // 设置基础 URL 地址 timeout: 5000, // 超时时间 (毫秒) headers: { // 默认请求头 'Content-Type': 'application/json', }, }); export default service; ``` 此部分实现了基本的 Axios 配置,包括 `baseURL` 和超时设置等参数[^3]。 --- ##### 3. 添加请求拦截器 请求拦截器用于在发送请求前对数据或配置进行预处理,例如添加 Token 认证信息或其他公共字段。 ```javascript service.interceptors.request.use( config => { const token = localStorage.getItem('token'); // 假设 Token 存储于本地存储 if (token) { config.headers['Authorization'] = `Bearer ${token}`; // 自动携带认证信息 } return config; }, error => { console.error(error); // 打印错误日志 Promise.reject(error); } ); ``` 这段代码展示了如何动态注入 Token 到请求头部,同时提供了错误捕获机制。 --- ##### 4. 添加响应拦截器 响应拦截器负责对接收到的数据进行初步解析和异常处理,确保返回给业务层的是干净的结果。 ```javascript service.interceptors.response.use( response => { const res = response.data; if (res.code && res.code !== 200) { // 如果服务端返回的状态码不正常,则抛出错误 Message.error(res.message || 'Error'); return Promise.reject(new Error(res.message || 'Request failed')); } else { return res; // 返回成功后的数据体 } }, error => { if (error.response) { switch (error.response.status) { case 401: MessageBox.confirm('登录状态已过期,请重新登录', '提示', { confirmButtonText: '确认', cancelButtonText: '取消', type: 'warning' }).then(() => { window.location.href = '/login'; // 跳转到登录页 }); break; case 403: Message.error('权限不足'); break; case 404: Message.error('资源未找到'); break; default: Message.error(`服务器内部错误(${error.response.status})`); } } else { Message.error('网络连接失败'); } return Promise.reject(error); } ); ``` 这里不仅完成了常规的成功/失败判断,还针对不同类型的 HTTP 错误进行了个性化提示。 --- ##### 5. 封装通用请求方法 为了让调用更加直观简单,可以提供一些便捷的方法来发起 GET、POST 等常见请求类型。 ```javascript export function get(url, params = {}) { return service.get(url, { params }); } export function post(url, data = {}, options = {}) { return service.post(url, data, options); } ``` 这些函数隐藏了底层细节,使得组件中的实际调用变得非常简洁明了[^2]。 --- ##### 6. 使用封装好的 Axios 实例 最后,在任何需要的地方都可以轻松导入并利用这个经过优化过的工具库完成各种 API 的交互工作。 ```javascript import { get, post } from '@/utils/request'; get('/api/user/info').then(response => { console.log('User Info:', response); }); post('/api/login', { username: 'admin', password: 'password' }) .then(response => { console.log('Login Success:', response); }) .catch(err => { console.error('Login Failed:', err); }); ``` 以上例子说明了如何快速集成封装Axios 来执行具体的接口访问任务。 --- #### 总结 通过对 Axios 的全面封装,不仅可以显著降低重复劳动量,还能有效改善项目的整体架构质量。无论是简单的 CRUD 操作还是复杂的跨域通信场景,都能从中受益匪浅[^1]。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Gleason.

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值