Axios Params 序列化解决方案

Axios Params 序列化解决方案(paramsSerializer)

这篇笔记解决什么问题

当你遇到下面任一情况时,这篇笔记可以直接给出方案:

  • 前端传了数组/对象,后端却"收不到"或结构不对
  • 同一个参数在不同接口上格式要求不一致([]、下标、重复 key)
  • 你不确定该用 Axios 内置配置,还是引入 qs

30 秒选型(先看这里)

  • 只用扁平对象 + 普通数组:用 Axios 内置 paramsSerializer.indexes
  • 有复杂嵌套对象、严格后端协议:用 qs.stringify
  • 想团队统一风格:在 axios 实例里一次性配置,不要散落在每个接口

paramsSerializer 是什么(定义)

paramsSerializer 用来控制 Axios 如何把 params 序列化成 URL query string。

  • 作用对象:params
  • 不作用于:data(请求体)、路径参数(如 /users/:id)
  • 即使是 POST/PUT,只要传了 params,它也会生效

示例:

ts 复制代码
axios.post('/users', data, {
  params: { page: 1 },
})

Axios 内置三种序列化方式(数组)

假设:

ts 复制代码
params = { tags: ['red', 'blue'] }
配置 结果 适用场景
indexes: false tags[]=red&tags[]=blue 常见 PHP/部分后端习惯(Axios 默认)
indexes: true tags[0]=red&tags[1]=blue 后端需要明确索引
indexes: null tags=red&tags=blue 后端按重复 key 解析数组

示例:

ts 复制代码
axios.get('/users', {
  params: { tags: ['red', 'blue'] },
  paramsSerializer: { indexes: null },
})

什么时候需要 qs

如果你有以下需求,建议直接用 qs:

  • 嵌套对象较深(如 filter[name]=tom)
  • 后端对参数格式有明确规范
  • 需要统一控制空值、编码、数组格式、键排序

示例:

ts 复制代码
import qs from 'qs'

axios.get('/users', {
  params: { filter: { name: 'tom' }, tags: ['a', 'b'] },
  paramsSerializer: {
    serialize: (params) => qs.stringify(params, { arrayFormat: 'repeat' }),
  },
})

推荐落地方式(项目级)

把策略放到请求实例,统一生效:

ts 复制代码
const request = axios.create({
  baseURL: '/api',
  paramsSerializer: {
    indexes: null,
  },
})

一句话结论

paramsSerializer 只负责"params 怎么拼到 URL 上";内置够用就别加库,复杂协议再用 qs。

相关推荐
LuHang24 分钟前
我一行代码没写,把领导派的活做成了公司内部系统😭
前端
明月_清风31 分钟前
Meta 开源了一个 AI Native 组件库:Astryx,150+ React 组件,专为 AI Agent 而设计
前端·人工智能·ai编程
用户850869276151 小时前
秒杀系统中 Shell 脚本并发控制 Bug:究竟哪里出了
前端
炫酷的大高个3 小时前
6 亿播放的闪身步,我用前端算出 15 倍重心差
前端·javascript
不可能片场4 小时前
内容运营自动化 配图折行别把词切两半
前端·electron
Lank_M4 小时前
HEIC转JPG统一转sRGB,P3高饱和色就回不来了
前端
补码缩写4 小时前
sharp默认转JPG颜色没错,ICC和EXIF却全没了
前端
用户7783366132114 小时前
SerpBase AI Overview 引用卡片:React 组件实战
前端
林小帅4 小时前
【笔记】Prisma v7 + SQLite TS2305 及连锁 TS7006 问题
前端·javascript·后端
HUANGZHENXUAN1234 小时前
最大子矩阵和:从 O(n⁴) 到 O(n³) 的列压缩 + Kadane
c语言·前端