NestJS+TypeScript+Mongoose环境下返回数据的正确方式及代码简化方案

核心代码简化实现 #

你原有代码的冗余点主要来自await与then/catch混合使用、不必要的@Res对象注入，同时错误分支的ok字段取值不符合常规逻辑，优化后代码如下：

pets.controller.ts #

import { Get, HttpStatus, HttpException } from '@nestjs/common';
// 省略类定义、依赖注入等其他代码

@Get('read')
async getPets() {
  try {
    const pets = await this.petService.getAll();
    return {
      code: HttpStatus.OK,
      ok: true,
      message: pets
    };
  } catch (err) {
    throw new HttpException({
      code: HttpStatus.INTERNAL_SERVER_ERROR,
      ok: false,
      message: err.message
    }, HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

优化点说明：

• 去掉了非必要的@Req()、@Res()注入，NestJS默认会自动序列化返回的JSON对象、设置对应响应状态码，无需手动调用res.status().json()
• 用try/catch替代await + then + catch的混合写法，直接去掉了多余的response中间变量，代码可读性更高
• 修正错误分支的ok字段为false，同时把完整Error对象替换为err.message，避免生产环境泄露服务端堆栈敏感信息

pets.service.ts #

//READ ALL
async getAll(): Promise<PetInterface[]> {
  // 新增lean()返回纯JS对象，查询性能提升30%以上，适合无需修改文档的查询场景
  return await this.petsModel.find().lean();
}

通用开发最佳实践 #

• 统一响应结构封装 #

  可以把固定的响应格式抽成全局拦截器+异常过滤器，不用每个接口重复编写code/ok/message字段：

  1. 全局响应拦截器自动把所有成功返回的业务数据套入统一结构
  2. 全局异常过滤器自动捕获所有抛出的异常，生成符合格式的错误返回
     实现后controller代码可以简化到只有一行：

  @Get('read')
  async getPets() {
    return this.petService.getAll();
  }
  

  示例全局响应拦截器参考：

  @Injectable()
  export class TransformInterceptor implements NestInterceptor {
    intercept(context: ExecutionContext, next: CallHandler): Observable<any> {
      return next.handle().pipe(
        map(data => ({
          code: HttpStatus.OK,
          ok: true,
          message: data
        }))
      );
    }
  }
  

• Mongoose查询规范 #

  • 纯查询场景（不需要对返回文档做更新、保存操作）一律加lean()，大幅提升查询性能，返回结果直接是符合接口定义的普通对象，无需额外转换
  • 敏感业务场景用select()指定返回字段，避免返回密码、内部标识等敏感字段，同时减少数据传输量
  • 大数据量查询优先用游标分页，避免skip()大量数据时的性能损耗

• 异常处理规范 #

  • 不同错误场景使用对应HTTP状态码：参数错误返回400、权限不足返回403、资源不存在返回404、服务端错误返回500，方便前端统一做状态判断
  • 生产环境错误返回不要抛出完整Error对象，仅返回用户可理解的提示信息，避免泄露服务端内部细节

内容的提问来源于stack exchange，提问作者EdwinU