Vue / 系统课时

HTTP 客户端基础封装

HTTP 客户端基础封装

本课将把分散在组件中的请求配置收拢为统一 HTTP 客户端,完成基础地址、超时、请求头和通用查询参数的封装,并通过一个用户资料接口验证调用方式。

学习目标

  • 使用 Axios 创建可复用的请求实例
  • 合并基础配置与每次请求的自定义参数
  • 通过浏览器网络面板验证最终请求

明确封装职责

基础客户端只负责所有接口都需要的稳定配置,不处理令牌刷新、业务错误转换等流程逻辑。这样可以避免一个文件承担过多职责,也为后续加入请求与响应拦截器保留清晰边界。

建议将实例放在 src/api/http.ts,业务接口放在 src/api/modules。组件只调用业务函数,不直接拼接地址或重复声明超时时间。

创建请求实例

下面是项目文件示例,依赖 Vite、TypeScript 与 Axios。基础地址从环境变量读取;request 函数会把通用参数与业务参数合并,后传入的业务参数优先级更高。

ts
// src/api/http.ts
import axios, {
  type AxiosRequestConfig,
  type AxiosResponse,
} from "axios";

const http = axios.create({
  baseURL: import.meta.env.VITE_API_BASE_URL,
  timeout: 10_000,
  headers: {
    "Content-Type": "application/json",
    "X-Client": "anystack-web",
  },
});

export function request<T>(
  config: AxiosRequestConfig,
): Promise<AxiosResponse<T>> {
  return http.request<T>({
    ...config,
    params: {
      locale: navigator.language,
      client: "web",
      ...config.params,
    },
  });
}

export default http;

预期结果:所有通过 request 发出的请求都会复用基础地址、10 秒超时和固定请求头,并自动合并 locale、client 与业务查询参数。

业务模块只描述接口路径、方法、参数和返回类型,不重复底层配置。

ts
// src/api/modules/profile.ts
import { request } from "../http";

export interface UserProfile {
  id: string;
  name: string;
}

export async function getProfile(id: string): Promise<UserProfile> {
  const response = await request<UserProfile>({
    url: `/users/${id}`,
    method: "GET",
    params: {
      detail: true,
    },
  });

  return response.data;
}

预期结果:调用 getProfile("42") 时,业务模块返回类型明确的 UserProfile,组件不需要了解基础地址、超时和通用参数的来源。

验证结果与关键边界

在 .env.development 中配置 VITE_API_BASE_URL=https://api.example.com,启动项目后触发一次调用,再打开浏览器开发者工具的 Network 面板。实际域名、语言值和参数顺序可能不同,但请求应包含以下信息。

text
Request URL: https://api.example.com/users/42?locale=<LOCALE>&client=web&detail=true
Request Method: GET
Request Headers: Content-Type=application/json, X-Client=anystack-web
Timeout: 10000 ms

预期结果:Network 面板能够确认基础地址、请求方法、查询参数、请求头和超时配置均已生效。

baseURL 末尾是否带斜杠要在团队内统一,避免出现重复斜杠。通用参数只适合放稳定、无敏感性的标识;令牌、追踪号等动态值应由拦截器按请求生成。文件上传还需要覆盖默认 Content-Type,让浏览器自动生成 multipart 边界。

本课总结

  • Axios 实例用于集中保存基础地址、超时和固定请求头
  • 请求包装函数可以安全合并通用参数与业务参数
  • 基础封装应保持单一职责,动态流程交给拦截器处理

下一课预告

下一课将加入请求与响应拦截器,统一注入令牌和追踪标识,并完成响应解包与通用错误转换。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

HTTP 客户端基础封装

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通