Redux Toolkit中RTK Query处理数组类型URL参数的解决方案

在基于Redux Toolkit的RTK Query进行API请求时，开发人员可能会遇到一个常见问题：如何正确处理数组类型的URL查询参数。默认情况下，RTK Query会将数组参数序列化为逗号分隔的字符串形式（如?array=v1,v2），但某些后端API期望接收PHP风格的数组格式（如?array[]=v1&array[]=v2）。

问题背景

当使用RTK Query发起GET请求并传递数组参数时：

query: (params) => ({
  url: `myurl`,
  method: "GET",
  params: { array: ['v1', 'v2'] }
})

默认生成的URL查询字符串会是?array=v1,v2。这种格式虽然简洁，但不符合某些后端框架（特别是PHP）处理数组参数的预期格式。

解决方案

RTK Query已经提供了灵活的解决方案：自定义参数序列化器（paramsSerializer）。通过这个配置项，开发者可以完全控制查询参数的序列化方式。

实现自定义序列化

以下是实现PHP风格数组参数序列化的示例：

import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'
import qs from 'querystring'

const api = createApi({
  baseQuery: fetchBaseQuery({ baseUrl: '/' }),
  endpoints: (builder) => ({
    getItems: builder.query({
      query: (params) => ({
        url: 'myurl',
        params,
        paramsSerializer: (params) => qs.stringify(params, { arrayFormat: 'brackets' })
      })
    })
  })
})

在这个示例中，我们使用了Node.js的querystring模块（也可以使用其他类似的库如qs），并通过arrayFormat: 'brackets'选项实现了PHP风格的数组参数格式。

替代方案

如果不想引入额外依赖，也可以手动实现序列化逻辑：

paramsSerializer: (params) => {
  return Object.entries(params)
    .flatMap(([key, value]) => 
      Array.isArray(value) 
        ? value.map(v => `${encodeURIComponent(key)}[]=${encodeURIComponent(v)}`)
        : `${encodeURIComponent(key)}=${encodeURIComponent(value)}`
    )
    .join('&')
}

设计考量

Redux Toolkit团队选择不内置特定风格的数组参数处理，主要基于以下考虑：

1. API多样性：不同后端框架对数组参数的处理方式各异，没有统一标准
2. 灵活性：通过暴露paramsSerializer接口，开发者可以根据实际需求自由定制
3. 轻量性：避免在核心库中集成过多特定场景的逻辑

最佳实践建议

1. 与后端团队协商确定统一的参数格式标准
2. 在项目中使用一致的序列化方式
3. 对于复杂参数结构，考虑使用POST请求替代GET请求
4. 将序列化逻辑封装为可复用的工具函数

通过合理利用RTK Query提供的扩展点，开发者可以轻松应对各种参数格式需求，同时保持代码的整洁和可维护性。