解析Routing-Controllers中HTTP错误响应的Content-Type问题

在Node.js应用开发中，typestack/routing-controllers是一个流行的基于装饰器的路由控制框架。本文将深入分析该框架中HTTP错误响应内容类型(content-type)设置的问题，帮助开发者理解其工作机制并提供解决方案。

问题现象

当使用routing-controllers框架抛出内置HTTP错误(如BadRequestError)时，虽然文档说明会返回JSON格式的错误信息，但实际响应头中的Content-Type却被设置为"text/html; charset=utf-8"。这导致前端应用无法正确解析响应体内容。

问题根源分析

框架提供了两种主要的控制器装饰器：

1. @Controller - 基础控制器，不自动设置响应内容类型
2. @JsonController - 专为JSON API设计，自动设置application/json内容类型

当使用@Controller时，即使抛出内置HTTP错误，框架也不会自动修改响应内容类型。这是设计上的有意行为，因为普通控制器可能返回各种类型的内容(HTML、JSON等)。

解决方案

方案一：使用JsonController

对于纯JSON API，最简单的解决方案是使用@JsonController替代@Controller。这会确保所有响应(包括错误)都带有正确的application/json内容类型。

@JsonController()
export class UserController {
  @Get("/users/:id")
  getOne(@Param("id") id: number) {
    const user = this.userRepository.findOneById(id);
    if (!user) {
      throw new NotFoundError("User not found");
    }
    return user;
  }
}

方案二：手动设置响应

对于需要混合返回HTML和JSON的控制器，可以手动注入并操作Express的Response对象：

@Controller()
export class MixedController {
  @Get("/api/data")
  getData(@Res() res: Response) {
    try {
      const data = getSomeData();
      return res.json(data);
    } catch (error) {
      res.status(400);
      return res.json({
        name: error.name,
        message: error.message
      });
    }
  }

  @Get("/page")
  @Render("template")
  getPage() {
    return { title: "My Page" };
  }
}

方案三：全局错误处理

更优雅的解决方案是实现自定义错误处理中间件，统一处理错误响应格式：

@Middleware({ type: "after" })
export class ErrorHandlerMiddleware implements ExpressErrorMiddlewareInterface {
  error(error: any, req: Request, res: Response, next: NextFunction) {
    if (error instanceof HttpError) {
      res.status(error.httpCode);
      res.json({
        name: error.name,
        message: error.message
      });
    } else {
      next(error);
    }
  }
}

然后在应用配置中注册这个中间件：

createExpressServer({
  middlewares: [ErrorHandlerMiddleware],
  controllers: [/* your controllers */]
});

最佳实践建议

1. 对于纯API服务，统一使用@JsonController
2. 对于混合型应用，明确区分API路由和页面路由
3. 实现统一的错误处理中间件，确保一致的错误响应格式
4. 在团队内部建立响应格式规范，避免前后端解析不一致

通过理解框架的设计理念和正确使用其提供的各种机制，开发者可以灵活地构建符合项目需求的Web应用，同时确保前后端数据交互的可靠性。