ts-rest 框架中 req.query 解析问题的分析与解决

问题背景

在使用 ts-rest 框架与 Express 集成开发时，开发者可能会遇到请求查询参数(req.query)未被正确解析的问题。具体表现为：

1. 查询参数未被按预期进行类型转换（如字符串"true"未被转为布尔值true）
2. 未在模式中定义的额外查询参数未被过滤掉

技术解析

问题根源

问题的根本原因在于对 ts-rest 框架请求处理流程的理解偏差。ts-rest 框架设计上已经对请求参数进行了处理，但开发者错误地直接从 Express 的 req.query 获取原始参数，而非使用框架提供的已解析参数。

正确用法

ts-rest 框架在处理请求时，会：

1. 自动解析查询参数
2. 根据定义的 Zod 模式进行验证和类型转换
3. 过滤掉未在模式中定义的额外参数
4. 将处理后的结果通过 handler 函数的参数对象提供

正确的做法是从 handler 函数的参数中直接获取已处理的查询参数，而非使用原始的 req.query。

解决方案

代码修正

原代码中：

handler: async ({ req }) => ({
  status: 200,
  body: req.query
})

应修改为：

handler: async ({ query }) => ({
  status: 200,
  body: query
})

技术细节

1. 参数解析流程：

   • Express 接收请求，原始查询参数为字符串形式
   • ts-rest 中间件拦截请求
   • 根据定义的 Zod 模式进行解析和验证
   • 将处理后的参数传递给 handler 函数

2. 类型安全保证：

   • 使用 Zod 模式定义确保类型安全
   • 自动类型转换（如字符串到布尔值）
   • 自动过滤未定义的参数

最佳实践

1. 始终使用框架提供的参数：

   • 避免直接使用 req.query 或 req.body
   • 使用 handler 函数提供的已解析参数

2. 充分利用 Zod 特性：

   • 使用 coerce 选项进行自动类型转换
   • 定义严格的参数模式确保数据安全

3. 错误处理：

   • ts-rest 会自动处理参数验证错误
   • 无需在 handler 中额外处理参数验证

总结

ts-rest 框架提供了强大的请求参数处理能力，开发者需要理解其设计理念和工作流程，正确使用框架提供的已解析参数而非原始请求对象。这种方式不仅简化了开发，还确保了类型安全和数据一致性。通过遵循框架的最佳实践，可以避免此类参数解析问题，提高开发效率和代码质量。