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

相关推荐
M ? A4 分钟前
你的 Vue v-for,VuReact 会编译成什么样的 React 代码?
前端·javascript·vue.js·经验分享·react.js·面试·vureact
午安~婉4 分钟前
Electron桌面应用(续3)
前端·javascript·electron·重构通用模型·异步可迭代对象
W.A委员会5 分钟前
伪类与伪元素
前端·javascript·css
午安~婉5 分钟前
Electron桌面应用(续2)
前端·javascript·electron·路由守卫·优化llm返回的内容
eEKI DAND29 分钟前
一个比 Nginx 还简单的 Web 服务器
服务器·前端·nginx
Highcharts.js8 小时前
Highcharts 云端渲染的真相:交互式图表与服务器端生成的边界
前端·信息可视化·服务器渲染·highcharts·图表渲染
zhuyan1089 小时前
Linux 系统磁盘爆满导致无法启动修复指南
前端·chrome
编程牛马姐9 小时前
独立站SEO流量增长:提高Google排名的优化方法
前端·javascript·网络
NotFound4869 小时前
实战指南如何实现Java Web 拦截机制:Filter 与 Interceptor 深度分享
java·开发语言·前端
Dontla10 小时前
高基数(High Cardinality)问题介绍(Prometheus、高基数字段、低基数字段)
前端·数据库·prometheus