Skip to main content
目录

模块引用

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

@Injectable()
export class CatsService {
  constructor(private moduleRef: ModuleRef) {}
}
tip

ModuleRef类是从@nestjs/core包中导入的。

检索实例​

ModuleRef实例（以下简称为模块引用）具有一个get()方法。 此方法使用其注入令牌/类名在当前模块中检索已存在（已实例化）的提供程序、控制器或可注入对象 （例如，守卫、拦截器等）。

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

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

不能使用get()方法检索作用域提供程序（瞬态或请求作用域）。 而是，请使用下面描述的技术。了解如何控制作用域，请参阅此处。

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

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

解析作用域提供程序​

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

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

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

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

@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()方法，返回一个适当的唯一标识符。

@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
  }
}
tip

ContextIdFactory类是从@nestjs/core包中导入的

注册REQUEST提供程序​

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

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

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

获取当前子树​

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

@Injectable()
export class CatsService {
  constructor(
    @Inject(REQUEST) private request: Record<string, unknown>,
  ) {}
}

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

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

动态实例化自定义类​

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

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

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

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