Inertia.js React 2.0.2 中数组参数重复合并问题解析

问题现象

在使用 Inertia.js React 2.0.2 版本时，开发者在处理包含数组的 GET 请求参数时遇到了一个特殊问题。当页面重新加载且 URL 中包含数组参数时，参数值会出现重复合并的情况。

具体表现为：假设初始数据为 { state: ['todo', 'done'] }，而当前 URL 为 http://test.localhost/?state[0]=todo，重新加载后 URL 会变成 http://test.localhost/?state[0]=todo&state[1]=todo&state[2]=done。这显然不符合预期行为，会导致参数重复和混乱。

问题根源

经过分析，这个问题源于 deepmerge 函数在 url.ts 文件中的 mergeDataIntoQueryString 方法内的使用方式。当方法为 GET 且包含数据时，系统会尝试将现有查询参数与新数据合并。

关键问题代码段：

if (method === 'get' && Object.keys(data).length) {
    url.search = qs.stringify(deepmerge(qs.parse(url.search, { ignoreQueryPrefix: true }), data), {
      encodeValuesOnly: true,
      arrayFormat: qsArrayFormat,
    })
    data = {}
}

当执行 deepmerge({ state: ["todo"] }, { state: ["todo"] }) 时，结果会变成 {state: ["todo", "todo"]}，这就是导致参数重复的根本原因。

解决方案

临时解决方案

可以通过为 deepmerge 提供自定义的 arrayMerge 选项来解决这个问题：

const overwriteMerge = (destinationArray, sourceArray, options) => sourceArray;

deepmerge(qs.parse(url.search, { ignoreQueryPrefix: true }), data, { arrayMerge: overwriteMerge })

这种方式会确保新数据完全覆盖 URL 中的现有数据。但需要注意这种解决方案可能会带来其他副作用，特别是在需要保留某些参数的情况下。

正确实践方案

更合理的解决方案是重新考虑 API 的使用方式。router.reload 方法的初衷是重新加载当前页面而不改变查询参数，因此不应该用于需要修改查询参数的场景。

正确的做法是使用 router.get 方法：

router.get('/data-table', data, options)

这种方法明确表达了意图：导航到指定路由并携带新的查询参数。这既符合 API 设计初衷，也能避免参数重复的问题。

最佳实践建议

1. 明确方法用途：理解每个路由方法的用途，reload 用于刷新当前页面，get 用于带参数导航。

2. 参数处理：当需要修改查询参数时，始终使用 router.get 而不是尝试通过 reload 来实现。

3. 数组参数：处理数组参数时要特别注意合并逻辑，考虑是否需要覆盖式合并还是追加式合并。

4. 版本适配：注意不同版本间的行为差异，这个问题在 Inertia.js React 2.0.2 中存在，后续版本可能会优化。

总结

这个问题揭示了框架使用中一个重要原则：理解每个API的设计意图并正确使用。router.reload 不是用来修改查询参数的，这种误用导致了参数重复的问题。开发者应该根据实际需求选择合适的路由方法，对于需要修改查询参数的情况，router.get 才是正确的选择。

同时，这个问题也提醒我们在处理数组参数的合并时需要特别注意，默认的合并行为可能不符合预期，必要时应提供自定义合并策略。