Vue / 系统课时

封装请求拦截器

封装请求拦截器

本课在请求实例发送数据前统一补充认证信息、请求标识和公共参数,并根据 JSON 与表单请求的差异调整请求头。完成后,业务接口无需重复拼接令牌,也不会因手动设置上传边界而导致文件请求失败。

学习目标

  • 理解请求拦截器在发送前修改配置的时机
  • 自动添加访问令牌、请求标识和公共查询参数
  • 正确处理 JSON 请求与 FormData 上传的请求头差异

拦截器的执行位置

请求拦截器接收即将发送的 Axios 配置,返回修改后的配置后才进入浏览器网络层。它适合处理所有接口共有的横切逻辑,但不应塞入某个页面独有的业务参数。

Axios 请求拦截流程

注册请求拦截器

在已有的 src/utils/request.ts 中,为实例添加拦截器。以下实现面向 Axios 1.x,使用 AxiosHeaders 提供的 set、has 和 delete 方法。

ts
import axios from 'axios'
import type { InternalAxiosRequestConfig } from 'axios'

const request = axios.create({
  baseURL: import.meta.env.VITE_API_BASE_URL || '/api',
  timeout: 10_000,
  headers: {
    Accept: 'application/json'
  }
})

request.interceptors.request.use(
  (config: InternalAxiosRequestConfig) => {
    const token = localStorage.getItem('access_token')
    const locale = localStorage.getItem('locale') || 'zh-CN'

    // 每次请求生成独立标识,便于前后端按同一 ID 排查日志。
    config.headers.set('X-Request-ID', crypto.randomUUID())

    if (token) {
      config.headers.set('Authorization', `Bearer ${token}`)
    }

    // FormData 的 boundary 必须由浏览器生成,不能手动固定 Content-Type。
    if (config.data instanceof FormData) {
      config.headers.delete('Content-Type')
    } else if (config.data && !config.headers.has('Content-Type')) {
      config.headers.set('Content-Type', 'application/json')
    }

    if (config.method?.toLowerCase() === 'get') {
      config.params = {
        ...config.params,
        locale
      }
    }

    return config
  },
  (error: unknown) => Promise.reject(error)
)

export default request

该配置本身不会直接输出日志。它会在每次调用 request 时修改最终请求,可通过浏览器 Network 面板验证。

验证注入结果

在开发环境临时执行下面的验证代码。接口即使返回错误,也不影响检查浏览器已经发出的请求头和查询参数。

ts
import request from '@/utils/request'

localStorage.setItem('access_token', 'demo-token')
localStorage.setItem('locale', 'zh-CN')

request.get('/users', {
  params: { page: 1 }
}).catch(() => undefined)

预期结果

text
Request URL: /api/users?page=1&locale=zh-CN
Authorization: Bearer demo-token
X-Request-ID: <ID>

<ID> 每次请求都会变化。后端响应状态取决于本地接口是否存在,因此不作为本次验证条件。

处理不同请求类型

普通对象作为请求体时,拦截器补充 application/json。上传文件时传入 FormData,拦截器删除手动设置的 Content-Type,浏览器会自动生成带 boundary 的值。下载文件通常还需在具体接口中单独设置 responseType: 'blob',不应由全局拦截器强制覆盖。

公共查询参数也要克制。语言、租户标识等确实适用于全部 GET 请求时才统一添加;分页、筛选条件和页面状态仍应由业务接口显式传入。

边界与排错

令牌不存在时不要发送空的 Authorization。出现 401 时,先检查存储键名、令牌格式和过期时间,再检查后端认证规则。上传接口报参数缺失时,确认没有手动固定 multipart/form-data,并在 Network 面板查看请求头是否包含浏览器生成的 boundary。

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

目录与阅读设置

阅读设置

17

记录一个想法

封装请求拦截器

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

登录哪都通