Uploadthing 项目中 OnUploadComplete 回调未触发问题解析

Uploadthing 是一个流行的文件上传解决方案，但在 ExpressJS 服务器环境中使用时，开发者可能会遇到 onUploadComplete 回调未被触发的问题。本文将深入分析这一问题的可能原因及解决方案。

问题现象

在 ExpressJS 服务器环境中配置 Uploadthing 后，文件上传操作表面上成功完成（返回 200 状态码），但开发者定义的 onUploadComplete 回调函数却未被触发。控制台日志显示上传请求处理成功，但回调函数中的日志语句未执行。

核心原因分析

经过对问题案例的研究，我们发现导致 onUploadComplete 回调未触发的常见原因包括：

1. 路由保护冲突：当 Uploadthing 的 API 端点（如 /api/uploadthing）被包含在应用的受保护路由中时，可能导致回调无法正常执行。

2. 环境配置问题：在本地开发环境中，Uploadthing 应该模拟回调执行，如果模拟失败，通常会在服务器控制台输出相关错误信息。

3. 中间件干扰：某些全局中间件可能干扰 Uploadthing 的正常回调机制。

解决方案

检查路由保护设置

确保 Uploadthing 的路由端点没有被包含在身份验证或其他保护性中间件中。例如：

// 错误配置 - 受保护的路由
app.use('/api', authMiddleware);
app.use('/api/uploadthing', createRouteHandler({/*...*/}));

// 正确配置 - 将上传路由排除在保护之外
app.use('/api/uploadthing', createRouteHandler({/*...*/}));
app.use('/api', authMiddleware);

验证本地环境回调模拟

在开发环境中，Uploadthing 会模拟回调执行。如果模拟失败，控制台通常会显示类似以下信息：

Failed to simulate callback for file 'filename.ext'. Is your webhook configured correctly?

如果看到此类信息，需要检查：

1. 确保 uploadthingId 和 uploadthingSecret 环境变量已正确配置
2. 验证文件路由定义是否正确

调试配置

启用调试日志可以帮助诊断问题：

createRouteHandler({
  router: ourFileRouter,
  config: {
    uploadthingId: process.env.UPLOADTHING_APP_ID,
    uploadthingSecret: process.env.UPLOADTHING_SECRET,
    logLevel: "debug"  // 启用详细日志
  }
})

最佳实践建议

1. 路由设计：为上传功能设计独立的路由路径，避免与其他 API 路由冲突。

2. 环境隔离：区分开发、测试和生产环境的配置，确保回调机制在各环境中都能正常工作。

3. 错误处理：在文件路由中添加全面的错误处理逻辑，便于问题排查。

4. 版本验证：确保使用的 Uploadthing 包版本与文档示例一致，避免版本兼容性问题。

通过以上分析和解决方案，开发者应该能够有效解决 Uploadthing 在 ExpressJS 环境中 onUploadComplete 回调未触发的问题。如果问题仍然存在，建议检查网络连接、安全策略设置以及服务端日志获取更多线索。