Fundamentals

模块引用

学习如何使用 ModuleRef 类导航内部提供者列表并获取任何提供者的引用

模块引用

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

@@filename(cats.service)
@Injectable()
export class CatsService {
  constructor(private moduleRef: ModuleRef) {}
}
@@switch
@Injectable()
@Dependencies(ModuleRef)
export class CatsService {
  constructor(moduleRef) {
    this.moduleRef = moduleRef;
  }
}

提示 ModuleRef 类从 @nestjs/core 包导入。

检索实例

ModuleRef 实例（以下我们将其称为模块引用）有一个 get() 方法。默认情况下，此方法返回在当前模块中注册并已实例化的提供者、控制器或可注入对象（例如，守卫、拦截器等），使用其注入令牌/类名。如果找不到实例，将抛出异常。

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

  onModuleInit() {
    this.service = this.moduleRef.get(Service);
  }
}
@@switch
@Injectable()
@Dependencies(ModuleRef)
export class CatsService {
  constructor(moduleRef) {
    this.moduleRef = moduleRef;
  }

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

警告您不能使用 get() 方法检索作用域提供者（瞬态或请求作用域）。相反，请使用下面描述的技术。了解如何控制作用域这里。

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

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

解析作用域提供者

要动态解析作用域提供者（瞬态或请求作用域），请使用 resolve() 方法，将提供者的注入令牌作为参数传递。

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

  async onModuleInit() {
    this.transientService = await this.moduleRef.resolve(TransientService);
  }
}
@@switch
@Injectable()
@Dependencies(ModuleRef)
export class CatsService {
  constructor(moduleRef) {
    this.moduleRef = moduleRef;
  }

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

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

@@filename(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
  }
}
@@switch
@Injectable()
@Dependencies(ModuleRef)
export class CatsService {
  constructor(moduleRef) {
    this.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() 方法，该方法返回适当的唯一标识符。

@@filename(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
  }
}
@@switch
@Injectable()
@Dependencies(ModuleRef)
export class CatsService {
  constructor(moduleRef) {
    this.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 提供者是 undefined，因为它们不是由 Nest 依赖注入系统实例化和管理的。

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

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

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

@@filename(cats.service)
@Injectable()
export class CatsService {
  constructor(
    @Inject(REQUEST) private request: Record<string, unknown>,
  ) {}
}
@@switch
@Injectable()
@Dependencies(REQUEST)
export class CatsService {
  constructor(request) {
    this.request = request;
  }
}

提示在这里了解更多关于请求提供者的信息。

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

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

动态实例化自定义类

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

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

  async onModuleInit() {
    this.catsFactory = await this.moduleRef.create(CatsFactory);
  }
}
@@switch
@Injectable()
@Dependencies(ModuleRef)
export class CatsService {
  constructor(moduleRef) {
    this.moduleRef = moduleRef;
  }

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

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

循环依赖

了解如何在 NestJS 中处理循环依赖，包括使用前向引用和 ModuleRef 类来解决提供者和模块之间的循环依赖问题。

懒加载模块

学习如何使用懒加载模块来减少启动时间并提高无服务器环境中的性能

模块引用

模块引用

检索实例

解析作用域提供者

注册 REQUEST 提供者

获取当前子树

动态实例化自定义类

注册 `REQUEST` 提供者