如何解决NestJS中TypeError: Reflect.getMetadata报错问题？

问题背景 #

基于NestJS的多应用项目采用Docker Compose部署，启动时触发TypeError: Reflect.getMetadata报错。已尝试安装多个版本reflect-metadata、在测试文件中导入该依赖，但问题未解决。

核心报错信息 #

savon-1           | [Nest] 28  - 07/29/2024, 4:19:39 PM     LOG [NestFactory] Starting Nest application...
savon-1           | [Nest] 28  - 07/29/2024, 4:19:39 PM   ERROR [ExceptionHandler] 
savon-1           | TypeError
savon-1           |     at Reflect.getMetadata (/usr/src/app/node_modules/typeorm/node_modules/reflect-metadata/Reflect.js:367:23)
savon-1           |     at DependenciesScanner.isInjectable (/usr/src/app/node_modules/@nestjs/core/scanner.js:396:26)
savon-1           |     at DependenciesScanner.insertModule (/usr/src/app/node_modules/@nestjs/core/scanner.js:89:18)
savon-1           |     at DependenciesScanner.insertOrOverrideModule (/usr/src/app/node_modules/@nestjs/core/scanner.js:306:21)
savon-1           |     at DependenciesScanner.scanForModules (/usr/src/app/node_modules/@nestjs/core/scanner.js:37:85)
savon-1           |     at DependenciesScanner.scanForModules (/usr/src/app/node_modules/@nestjs/core/scanner.js:68:43)
savon-1           |     at async DependenciesScanner.scan (/usr/src/app/node_modules/@nestjs/core/scanner.js:27:9)
savon-1           |     at async /usr/src/app/node_modules/@nestjs/core/nest-factory.js:107:17)
savon-1           |     at async ExceptionsZone.asyncRun (/usr/src/app/node_modules/@nestjs/core/errors/exceptions-zone.js:22:13)
savon-1           |     at async NestFactoryStatic.initialize (/usr/src/app/node_modules/@nestjs/core/nest-factory.js:106:13)

解决方案 #

1. 确保在应用入口优先导入reflect-metadata #

仅在测试文件中导入无法覆盖应用启动流程，需将导入语句放在所有应用的main.ts最顶部：

import 'reflect-metadata';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

2. 清理重复的依赖版本 #

报错显示当前使用的是typeorm/node_modules下嵌套的reflect-metadata，说明存在多版本冲突：

• 删除本地node_modules和package-lock.json：

  rm -rf node_modules package-lock.json
  

• 重新安装依赖并自动去重：

  npm install && npm dedupe
  

3. 修正Docker环境依赖一致性问题 #

当前Docker Compose挂载了本地目录到容器，可能导致本地与容器依赖版本不一致：

• 方案1：修改启动命令，确保容器启动时重新同步依赖：
  在docker-compose.yml的savon和inux服务中，将command改为：

  command: npm install && npm run start:dev savon
  

• 方案2：优化Dockerfile，确保构建时依赖完整：

  FROM node:alpine
  
  WORKDIR /usr/src/app
  
  COPY package*.json ./
  RUN npm install
  
  COPY . .
  
  CMD ["npm", "run", "start:dev"]
  

4. 验证TypeScript配置完整性 #

确保项目根目录的tsconfig.json开启反射相关配置：

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    // 其他配置...
  }
}

预防措施 #

• 锁定依赖版本：在package.json中固定reflect-metadata版本，避免自动升级导致兼容问题：

  "dependencies": {
    "reflect-metadata": "0.1.14",
    // 其他依赖...
  }
  

• 强制入口导入：将import 'reflect-metadata';作为所有NestJS应用main.ts的第一行代码，确保反射元数据在应用启动前加载。
• 统一开发与容器环境：开发时确保本地已执行npm install，避免挂载本地目录到容器时依赖缺失；生产环境禁用node_modules卷挂载，完全依赖Docker构建的依赖。
• 定期检查依赖：使用npm ls reflect-metadata检查依赖版本，发现嵌套版本时执行npm dedupe去重。
• 同步测试与生产配置：测试文件和应用入口的反射元数据导入逻辑保持一致，避免仅在测试环境处理。

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