模块参考 Module reference

Nest 提供了 `ModuleRef` 类来浏览内部提供程序列表，并使用其注入令牌作为查找键来获取对任何提供程序的引用。`ModuleRef` 类还提供了一种动态实例化静态和作用域提供程序的方法。`ModuleRef` 可以以常规方式注入到类中：

ts
TS
ts
// cats.service
@Injectable()
export class CatsService {
  constructor(private moduleRef: ModuleRef) {}
}
提示

ModuleRef 类从 @nestjs/core 包导入。

检索实例

ModuleRef 实例（以下我们将其称为 模块引用）具有 get() 方法。默认情况下，此方法返回已注册并已使用其注入令牌/类名在 当前模块 中实例化的提供程序、控制器或可注入项（例如，guard、拦截器等）。如果未找到该实例，则会引发异常。

ts
TS
ts
// cats.service
@Injectable()
export class CatsService implements OnModuleInit {
  private service: Service
  constructor(private moduleRef: ModuleRef) {}

  onModuleInit() {
    this.service = this.moduleRef.get(Service)
  }
}
警告

您无法使用 get() 方法检索范围提供程序（瞬态或请求范围）。相反，请使用下面描述的技术。了解如何控制范围此处。

要从全局上下文中检索提供程序（例如，如果提供程序已注入其他模块），请将 {{ '{' }} strict: false {{ '}' }} 选项作为第二个参数传递给 get()。

ts
this.moduleRef.get(Service, { strict: false })

解析范围提供程序

要动态解析范围提供程序（临时或请求范围），请使用 resolve() 方法，将提供程序的注入令牌作为参数传递。

ts
TS
ts
// cats.service
@Injectable()
export class CatsService implements OnModuleInit {
  private transientService: TransientService
  constructor(private moduleRef: ModuleRef) {}

  async onModuleInit() {
    this.transientService = await this.moduleRef.resolve(TransientService)
  }
}

resolve() 方法从其自己的 DI 容器子树 返回提供程序的唯一实例。每个子树都有一个唯一的 上下文标识符。因此，如果您多次调用此方法并比较实例引用，您将发现它们不相等。

ts
TS
ts
// cats.service
@Injectable()
export class CatsService implements OnModuleInit {
  constructor(private moduleRef: ModuleRef) {}

  async onModuleInit() {
    const transientServices = await Promise.all([
      this.moduleRef.resolve(TransientService),
      this.moduleRef.resolve(TransientService),
    ])
    console.log(transientServices[0] === transientServices[1]) // false
  }
}

要跨多个 resolve() 调用生成单个实例，并确保它们共享相同的生成的 DI 容器子树，您可以将上下文标识符传递给 resolve() 方法。使用 ContextIdFactory 类来生成上下文标识符。此类提供了一个 create() 方法，该方法返回适当的唯一标识符。

ts
TS
ts
// cats.service
@Injectable()
export class CatsService implements OnModuleInit {
  constructor(private moduleRef: ModuleRef) {}

  async onModuleInit() {
    const contextId = ContextIdFactory.create()
    const transientServices = await Promise.all([
      this.moduleRef.resolve(TransientService, contextId),
      this.moduleRef.resolve(TransientService, contextId),
    ])
    console.log(transientServices[0] === transientServices[1]) // true
  }
}
提示

ContextIdFactory 类从 @nestjs/core 包导入。

注册 REQUEST 提供程序

手动生成的上下文标识符（使用 ContextIdFactory.create()）表示 DI 子树，其中 REQUEST 提供程序是 未定义 的，因为它们未由 Nest 依赖注入系统实例化和管理。

要为手动创建的 DI 子树注册自定义 REQUEST 对象，请使用 ModuleRef#registerRequestByContextId() 方法，如下所示：

ts
const contextId = ContextIdFactory.create();
this.moduleRef.registerRequestByContextId(/* YOUR_REQUEST_OBJECT */, contextId);

获取当前子树

有时，您可能希望在请求上下文中解析请求范围提供程序的实例。假设CatsService是请求范围的，并且您想要解析也被标记为请求范围提供程序的CatsRepository实例。为了共享相同的DI容器子树，您必须获取当前上下文标识符而不是生成新标识符（例如，使用ContextIdFactory.create()函数，如上所示）。要获取当前上下文标识符，请首先使用@Inject()装饰器注入请求对象。

ts
TS
ts
// cats.service
@Injectable()
export class CatsService {
  constructor(
    @Inject(REQUEST) private request: Record<string, unknown>,
  ) {}
}
提示

在此处了解有关请求提供程序的更多信息。

现在，使用 ContextIdFactory 类的 getByRequest() 方法根据请求对象创建上下文 ID，并将其传递给 resolve() 调用：

ts
const contextId = ContextIdFactory.getByRequest(this.request)
const catsRepository = await this.moduleRef.resolve(CatsRepository, contextId)

动态实例化自定义类

要动态实例化之前未注册为提供程序的类，请使用模块引用的 create() 方法。

ts
TS
ts
// cats.service
@Injectable()
export class CatsService implements OnModuleInit {
  private catsFactory: CatsFactory
  constructor(private moduleRef: ModuleRef) {}

  async onModuleInit() {
    this.catsFactory = await this.moduleRef.create(CatsFactory)
  }
}

此技术使您能够有条件地实例化框架容器之外的不同类。