axios 响应对象全解析:Response 结构、validateStatus 判定机制与响应头访问原理
【免费下载链接】axiosPromise based HTTP client for the browser and node.js项目地址: https://gitcode.com/GitHub_Trending/ax/axios
本文基于 axios 官方文档《Response schema》(docs/es/pages/advanced/response-schema.md)展开,完整覆盖响应对象的六个字段(data/status/statusText/headers/config/request)、TypeScript 泛型签名AxiosResponse<T, D, H, P>、状态码判定与validateStatus定制、以及响应头的小写归一化机制。读完本文,你既能直接按文档用法处理响应,也能从 lib/core/settle.js、lib/core/dispatchRequest.js 等源码弄清每个字段的生成时机与判定逻辑。
一、响应对象的整体结构
axios 的每一次请求最终都会 resolve 出一个结构固定的响应对象。这一结构在浏览器端和 Node.js 端保持一致,无论底层走的是XMLHttpRequest还是http适配器:
{ // 服务器提供的响应数据。 // 若使用了 transformResponse,这里会是最后一次变换函数的结果。 data: {}, // 服务器响应中的 HTTP 状态码(如 200、404、500)。 status: 200, // 与状态码对应的状态消息(如 "OK"、"Not Found")。 statusText: "OK", // 服务器发送的响应头。 // 头名统一为小写,既可用方括号也可用点号访问。 headers: {}, // 本次请求所用的 axios 配置,包括 baseURL、headers、timeout、params // 以及你提供的所有其他选项。 config: {}, // 底层的请求对象。 // Node.js 中:最后一个 http.ClientRequest 实例(经过任何重定向之后)。 // 浏览器中:XMLHttpRequest 实例。 request: {}, }逐字段解读:
data:响应体。默认情况下,浏览器端的transformResponse会尝试把 JSON 字符串解析成对象(解析失败则原样返回字符串),因此你拿到的通常已经是可操作的对象;如果你在请求配置里覆盖了transformResponse,那么data就是最后一个变换函数的返回值。这一行为可以在 lib/core/dispatchRequest.js 中得到印证:适配器 resolve 之后,response.data = transformData.call(config, config.transformResponse, response)执行数据变换,随后才把响应对象向上抛出。status:数值型 HTTP 状态码,如200、404、500,是后续状态判定(见第三节)的输入。statusText:与状态码对应的原因短语,如"OK"、"Not Found"。headers:服务器返回的响应头,头名全部归一化为小写(原理见第四节)。config:本次请求实际生效的完整配置,即经过mergeConfig合并后的结果——包含实例级baseURL、请求级headers、timeout、params等全部选项。需要它排查"实际发出的请求参数到底是什么"时非常有用。request:底层请求句柄。Node.js 中是重定向链上的最后一个http.ClientRequest实例,浏览器中是XMLHttpRequest实例。通过它可以直接挂request.on('error', ...)之类的事件监听。
二、TypeScript 泛型签名 AxiosResponse<T, D, H, P>
在 TypeScript 中,AxiosResponse通过四个泛型参数分别约束响应数据(T)、请求数据(D)、响应头(H)和查询参数(P);config字段保留请求侧的两个泛型:
interface AxiosResponse<T = any, D = any, H = {}, P = any> { data: T; status: number; statusText: string; headers: (H & RawAxiosResponseHeaders) | AxiosResponseHeaders; config: InternalAxiosRequestConfig<D, P>; request?: any; }该签名与仓库类型声明 index.d.ts 完全一致。几个实践要点:
T决定data的类型。例如axios.get<User[]>("/api/users")让data被推断为User[],免去as断言。H与RawAxiosResponseHeaders相交(H & RawAxiosResponseHeaders),意味着你既可以通过自定义H为特定头声明类型,也能保留原始头对象上其他头的索引能力。request?: any是可选字段,因为不同适配器的底层对象类型不同,类型上不做进一步约束。- 与响应类型配套,错误类型 AxiosError 在 index.d.ts 中也持有
response?: AxiosResponse<T, D, {}, P>与status?: number——也就是说当请求因validateStatus被 reject 时,error.response依然是上文所述的完整响应对象结构,error.status则冗余了状态码便于直接使用。
三、访问响应字段:解构取值
实际使用中通常只需要解构出关心的部分:
const { data, status, headers } = await axios.get("/api/users/1"); console.log(status); // 200 console.log(headers["content-type"]); // "application/json; charset=utf-8" console.log(data); // { id: 1, name: "Jay", email: "jay@example.com" }注意响应字段来自 Promise 的 resolve 值,因此const { data, status } = await axios.get(...)与axios.get(...).then(({ data, status }) => ...)等价。解构data之后,对响应体的后续操作与普通对象访问无差别。
四、状态码判定与 validateStatus
axios 默认对任意 2xx 响应 resolve,对范围之外的状态码 reject。默认实现位于 lib/defaults/index.js:
validateStatus: function validateStatus(status) { return status >= 200 && status < 300; },可以通过validateStatus配置项自定义这一判定。官方文档给出的例子是把"500 以下"都视为成功:
const response = await axios.get("/api/resource", { validateStatus: (status) => status < 500, // resolve for anything below 500 });这一配置在源码中的消费点只有一处:lib/core/settle.js。settle是适配器 resolve 之后决定 Promise 走向的核心函数:
export default function settle(resolve, reject, response) { const validateStatus = response.config.validateStatus; if (!response.status || !validateStatus || validateStatus(response.status)) { resolve(response); } else { reject(new AxiosError( 'Request failed with status code ' + response.status, response.status >= 400 && response.status < 500 ? AxiosError.ERR_BAD_REQUEST : AxiosError.ERR_BAD_RESPONSE, response.config, response.request, response )); } }从源码可以读出三个关键细节:
- reject 时携带的是带
response的AxiosError,且code会按状态码分段:4xx得到ERR_BAD_REQUEST,其余(非 2xx 且非 4xx)得到ERR_BAD_RESPONSE,便于在 catch 中按error.code精细分支。 validateStatus的合并策略是"直接覆盖"而非深合并。在 lib/core/mergeConfig.js 中它被归入mergeDirectKeys;lib/core/mergeConfig.js 还有一段特殊逻辑:当请求级配置显式地把validateStatus置为undefined,且过渡选项validateStatusUndefinedResolves(默认true,见 lib/defaults/transitional.js)生效时,会取回实例级的validateStatus或彻底删除该键——对应 lib/core/settle.js 中!validateStatus直接 resolve 的分支,即"没有校验函数时视为一切状态都成功"。- 非 2xx 响应同样会走完
transformResponse。lib/core/dispatchRequest.js 的onAdapterRejection分支中,只要reason.response存在,就会对其data执行transformData并归一化headers。因此被 reject 的响应对象(error.response)结构与成功响应完全一致,error.response.data也已经是解析后的对象。
五、访问响应头:小写归一化与两种等价写法
无论服务器以什么大小写发送头名,axios 中的响应头名一律是小写:
const response = await axios.get("/api/resource"); // 以下两种写法等价 const contentType = response.headers["content-type"]; const contentType2 = response.headers.get("content-type");方括号与点号(对合法标识符头名如content-length需用方括号,驼峰化的合法键名可以用点号)访问之所以能工作,是因为响应头在装配阶段被统一封装成了AxiosHeaders实例:lib/core/dispatchRequest.js 在成功分支执行response.headers = AxiosHeaders.from(response.headers),拒绝分支对reason.response.headers同样处理(L88)。
小写化发生在AxiosHeaders内部:头名在toValidName中经String(header).trim().toLowerCase()归一化(lib/core/AxiosHeaders.js),set时也先做name.toLowerCase()再按内部规范化结构存储(lib/core/AxiosHeaders.js)。由此得到两个实用结论:
- 查找头名时永远写小写,
headers["Content-Type"]这种原始大小写形式不应依赖; headers.get("content-type")走的是AxiosHeaders的实例方法,与原生fetch的HeadersAPI 语义接近,迁移时心智负担较小。
六、小结:响应对象的生命周期
把以上源码证据串起来,一个响应对象在 axios 中的完整装配链路是:
- 适配器(lib/adapters/ 下的
xhr/http/fetch)产出包含原始status、statusText、headers、data、request的响应; - dispatchRequest 依次执行
transformResponse(改写data,见 lib/core/transformData.js——每个变换函数以当前data为输入、前一个的输出作为下一个的输入,最终结果回填response.data)、用AxiosHeaders.from归一化headers; - settle 依据
config.validateStatus决定 resolve 完整响应对象,还是 reject 一个携带response、request、config与code的AxiosError。
理解了这条链路,文档中"schema 在浏览器与 Node.js 中一致"这句话就有了实现层面的解释:一致性由共享的dispatchRequest/settle核心流程保证,适配器只负责填充底层request与原始响应数据。相关的行为验证可参考 tests/unit/core/settle.test.js、tests/unit/core/dispatchRequest.test.js 与 tests/unit/core/transformData.test.js。
【免费下载链接】axiosPromise based HTTP client for the browser and node.js项目地址: https://gitcode.com/GitHub_Trending/ax/axios
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考