Vue-Vben-Admin 中 GET 请求数组参数处理的最佳实践

问题背景

在使用 Vue-Vben-Admin 项目开发后台管理系统时，开发者可能会遇到一个常见但棘手的问题：当通过 GET 请求传递数组参数时，服务器可能会返回 CORS 错误。这个问题看似是跨域问题，实则与参数序列化方式密切相关。

问题本质分析

表面上看，错误信息显示的是典型的 CORS 跨域错误，但实际上这是由于浏览器对特殊字符的处理方式导致的。当 URL 中包含方括号 [] 这样的特殊字符时，某些服务器配置可能会拒绝处理这样的请求，从而触发 CORS 错误。

参数序列化的三种常见方式

1. 方括号格式：createTime[]=value1&createTime[]=value2

   • 问题：容易触发服务器安全机制
   • 兼容性：较差

2. 索引格式：createTime[0]=value1&createTime[1]=value2

   • 优点：结构清晰
   • 缺点：仍然包含特殊字符

3. 重复键格式：createTime=value1&createTime=value2

   • 优点：兼容性最好
   • 缺点：语义不够明确

解决方案实现

在 Vue-Vben-Admin 中，可以通过以下方式优雅地解决这个问题：

import qs from 'qs';

export const requestClient = createRequestClient(apiURL, {
  responseReturn: 'data',
  paramsSerializer(params) {
    return qs.stringify(params, { 
      arrayFormat: 'repeat', // 使用重复键格式
      encode: false         // 不进行额外编码
    });
  },
});

最佳实践建议

1. 统一参数格式：建议团队约定使用一种统一的数组参数传递格式
2. 服务器端适配：确保后端能够正确解析选定的参数格式
3. 文档记录：在项目文档中明确记录参数传递规范
4. 错误处理：添加针对参数序列化错误的特定处理逻辑

深入理解

这个问题实际上反映了 Web 开发中一个更深层次的问题：HTTP 协议本身并没有明确规定如何通过 URL 传递数组参数。不同的框架和库实现了不同的解决方案，导致了兼容性问题。理解这一点有助于开发者在遇到类似问题时能够快速定位原因。

总结

在 Vue-Vben-Admin 项目中处理 GET 请求的数组参数时，采用重复键的参数序列化方式是最稳妥的解决方案。这不仅能避免 CORS 错误，还能提高接口的兼容性和稳定性。作为开发者，理解参数序列化背后的原理比记住具体解决方案更为重要。