Vue / 系统课时
创建请求实例
创建请求实例
本课把分散在各处的 Axios 配置收拢为一个可复用请求实例。完成后,业务模块只需描述接口路径和参数,接口前缀、超时与默认请求头由统一入口负责,后续添加拦截器和错误处理也有稳定落点。
学习目标
- 使用
axios.create创建项目级请求实例 - 集中配置接口地址、超时时间和默认请求头
- 通过浏览器控制台确认实例配置已生效
明确实例边界
不要直接修改全局 Axios 默认值。独立实例只影响当前管理后台,既能避免第三方模块被意外改写,也方便将来为上传、下载或不同后端创建专用实例。
接口地址优先读取 Vite 环境变量,并提供本地代理前缀作为兜底。超时时间应覆盖大多数普通接口,但不能用无限等待掩盖后端性能问题。
创建并导出请求实例
在 src/utils/request.ts 中创建实例。以下代码适用于 Axios 1.x 和 Vite 驱动的 Vue 3 项目。
ts
import axios from 'axios'
const request = axios.create({
// 生产环境可配置完整网关地址,本地开发通常使用 /api 交给 Vite 代理。
baseURL: import.meta.env.VITE_API_BASE_URL || '/api',
timeout: 10_000,
headers: {
Accept: 'application/json',
'Content-Type': 'application/json'
}
})
// 仅在开发环境打印默认值,便于确认环境变量和实例配置。
if (import.meta.env.DEV) {
console.info('[request defaults]', {
baseURL: request.defaults.baseURL,
timeout: request.defaults.timeout,
contentType: request.defaults.headers.common['Content-Type']
})
}
export default request预期输出
text
[request defaults] { baseURL: "/api", timeout: 10000, contentType: "application/json" }当 VITE_API_BASE_URL 已设置时,baseURL 会显示对应地址;实际值可能不同。
配置环境变量
开发环境可在项目根目录创建 .env.development。变量名必须以 VITE_ 开头,修改后需要重启开发服务器。
bash
VITE_API_BASE_URL=/api该配置不会产生终端输出。重新运行开发服务后,浏览器控制台中的 baseURL 应为 /api。
在业务模块中复用
业务接口只导入统一实例,不再重复填写超时、请求头或网关地址。下面是用户列表接口的片段示例,依赖后端提供 /users 路由。
ts
import request from '@/utils/request'
export interface UserQuery {
page: number
pageSize: number
}
export function getUserList(params: UserQuery) {
return request.get('/users', { params })
}生效行为:最终请求地址由 baseURL 与 /users 组合,查询参数由 Axios 编码。可在浏览器 Network 面板确认请求 URL 和请求头。
典型问题与处理
出现重复 /api/api 时,检查业务路径和 baseURL 是否同时写了前缀。请求立即超时时,确认单位是毫秒,并检查代理或后端是否可达。环境变量未生效时,先确认名称以 VITE_ 开头,再重启开发服务。
按自己的节奏,确认真正理解。