NestJS动态模块打包后注入Service为undefined问题排查

我需要为多个NestJS后端提供前端日志接口，计划开发动态模块并打包为npm包复用。通过注入令牌注入Logger，用标准DI注入FrontendLogService，但模块发布安装后，注入的Service为undefined。我严格遵循NestJS动态模块文档，也尝试用ModuleRef获取服务，仍出现ModuleRef为undefined的问题。相关代码如下：

frontend-log.module.ts:

import { DynamicModule, Module } from "@nestjs/common";
import { FrontendLogService } from "./frontend-log.service";
import { Logger } from "./interfaces/logger";
import { FrontendLogController } from "./frontend-log.controller";

@Module({})
export class FrontendLogModule {
  static forRoot(logger: Logger): DynamicModule {
    return {
      module: FrontendLogModule,
      controllers: [FrontendLogController],
      providers: [FrontendLogService, { provide: "LOGGER", useValue: logger }],
    };
  }
}

frontend-log.controller.ts:

import { Body, Controller, Inject, Post, Req } from "@nestjs/common";
import { FrontendLogMessage } from "../model/frontend-log-message";
import { Request } from "express";
import { RequestWithToken } from "../model/request-with-token";
import { Logger } from "./interfaces/logger";
import { ArrayMaxSize, ArrayMinSize, ValidateNested } from "class-validator";
import { Type } from "class-transformer";
import { FrontendLogService } from "./frontend-log.service";

class FrontendLogData {
  @Type(() => FrontendLogMessage)
  @ArrayMinSize(1)
  @ArrayMaxSize(20)
  @ValidateNested({ each: true })
  messages: FrontendLogMessage[];
}

@Controller()
export class FrontendLogController {
  constructor(
    @Inject("LOGGER") private logger: Logger,
    private logService: FrontendLogService
  ) {}

  @Post("log")
  public log(@Req() req: Request, @Body() data: FrontendLogData) {
    this.logService.logFrontendMessages(  // logService is undefined here
      this.logger,
      data.messages,
      (req as RequestWithToken).kauth.grant.access_token.content
    );
  }
}

frontend-log.service.ts:

import { Injectable } from "@nestjs/common";
import { FrontendLogMessage } from "../model/frontend-log-message";
import { AccessTokenContent } from "../model/request-with-token";
import { Logger } from "./interfaces/logger";

@Injectable()
export class FrontendLogService {
  public logFrontendMessages(
    logger: Logger,
    data: FrontendLogMessage[],
    accessToken?: AccessTokenContent
  ) {
    const user = accessToken
      ? `${accessToken.name} (${accessToken.sub})`
      : "anonymous";
    data.forEach((logEntry) => {
      logger.log(logEntry.level, `[FRONTEND] [${user}] ${logEntry.message}`);
    });
  }
}

我构建并发布包后，在消费项目的AppModule中导入：

@Module({
  imports: [
    // ...
    FrontendLogModule.forRoot(getLogger('debug')),
  ],
  controllers: [
    // ...
  ],
  providers: [
    // ...
  ],
})
export class AppModule implements NestModule {
  // ...
}

调用/log接口时出现错误：

[Nest] 15280  - 26.10.2022, 09:03:50   ERROR [ExceptionsHandler] Cannot read properties of undefined (reading 'logFrontendMessages')
TypeError: Cannot read properties of undefined (reading 'logFrontendMessages')
    at FrontendLogController.log

接口已正常暴露，但Service为undefined。请问我哪里出错了？是发布NestJS模块时忽略了什么，还是有基础错误？

1. 检查模块打包的文件完整性 #

NestJS模块发布成npm包时，必须确保编译后的所有文件都被正确包含：

• 确认tsconfig.json的outDir配置正确，编译产物路径符合预期
• 检查package.json的files字段，必须包含编译后的dist目录（或自定义输出目录），以及.d.ts类型定义文件，避免遗漏服务、控制器相关的编译文件
• 排查是否在.npmignore中误排除了关键文件

2. 验证DI元数据的正确性 #

NestJS的依赖注入依赖类装饰器生成的元数据，确保没有破坏这些元数据：

• 确认FrontendLogService的@Injectable()装饰器正确引入且无拼写错误
• 控制器构造函数中的注入语法无误，不要使用非标准的注入方式导致元数据丢失

3. 显式导出服务（可选但有效） #

即使模块内部使用服务，显式导出服务可以帮助NestJS的DI容器更清晰地识别依赖关系，修改动态模块配置：

static forRoot(logger: Logger): DynamicModule {
  return {
    module: FrontendLogModule,
    controllers: [FrontendLogController],
    providers: [FrontendLogService, { provide: "LOGGER", useValue: logger }],
    exports: [FrontendLogService] // 显式导出服务
  };
}

4. 确保版本兼容性 #

模块使用的NestJS核心包（@nestjs/common、@nestjs/core）版本必须和消费项目一致或兼容：

• 对比模块和消费项目的package.json，确认核心依赖的版本范围，尽量使用相同大版本（比如均为9.x）
• 版本差异可能导致DI容器的元数据处理逻辑冲突，引发注入失败

5. 本地调试排查问题 #

不要直接使用发布的npm包，通过npm link将本地模块链接到消费项目，实时调试：

• 在模块目录执行npm link
• 在消费项目目录执行npm link your-module-name
• 启动项目后，调试控制器的构造函数，查看logService是否在实例化阶段就已为undefined，定位问题根源

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