ts-rest项目中处理multipart/form-data请求的注意事项

理解问题背景

在Web开发中，处理文件上传是一个常见需求，通常使用multipart/form-data格式来传输文件数据。ts-rest作为一个类型安全的API契约库，在处理这类请求时需要特别注意一些细节。

核心问题分析

当使用ts-rest处理文件上传时，开发者可能会遇到两个主要问题：

1. 装饰器顺序问题：@TsRestHandler装饰器必须放在其他拦截器之前，否则会导致请求处理流程异常。

2. 文件类型验证问题：在服务器端，上传的文件实际上是Express.Multer.File类型，而不是浏览器端的File类型，因此需要使用正确的Zod验证方式。

解决方案详解

1. 正确的装饰器顺序

在NestJS控制器中，装饰器的顺序会影响中间件的执行顺序。对于ts-rest的文件上传处理，正确的顺序应该是：

@TsRestHandler(c.createPost)  // ts-rest处理器必须最先执行
@UseInterceptors(FileInterceptor('thumbnail'))  // 然后是文件拦截器
async createPost(
  @UploadedFile(new ParseFilePipe()) thumbnail: Express.Multer.File,
) {
  // 处理逻辑
}

2. 正确的文件类型验证

在定义API契约时，文件字段的验证应该使用z.custom<File>()而不是z.instanceof(File)，原因如下：

• 浏览器环境中上传的是File对象
• 服务器端接收的是经过Multer处理的Express.Multer.File对象
• z.custom提供了更灵活的类型检查方式

正确的契约定义示例：

const PostSchema = z.object({
  title: z.string(),
  thumbnail: z.custom<File>(),  // 使用custom而不是instanceof
});

深入理解技术细节

为什么装饰器顺序很重要

在NestJS中，装饰器的执行顺序是从下到上的。@TsRestHandler需要最先执行，因为它负责设置请求的解析和验证管道。如果文件拦截器先执行，它会修改请求体，可能导致ts-rest无法正确解析原始请求。

文件类型的差异

浏览器中的File对象和服务器端的Express.Multer.File虽然都表示文件，但属于不同的实现：

• 浏览器File是Web API的一部分
• Express.Multer.File是Multer中间件处理后的结果
• ts-rest在客户端使用File类型，在服务端会自动处理类型转换

最佳实践建议

1. 明确区分环境：在定义契约时，考虑客户端和服务端的类型差异。

2. 使用类型守卫：对于文件字段，可以添加自定义验证逻辑确保类型安全。

3. 错误处理：为文件上传添加适当的错误处理，包括大小限制、类型检查等。

4. 文档注释：清晰注释文件上传相关的接口，说明预期的行为和限制。

总结

处理multipart/form-data请求时，ts-rest需要特别注意装饰器顺序和类型验证。通过正确使用@TsRestHandler位置和z.custom验证，可以确保文件上传功能正常工作。理解客户端和服务端环境的差异是解决这类问题的关键。