logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页循环依赖
下一页懒加载模块

#模块参考

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

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

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

#获取实例

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

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

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

无法通过 get() 方法检索作用域提供者(瞬时或请求作用域)。请改用下文所述技术 。了解如何控制作用域请参阅此处 。

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

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

#解析作用域提供者

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

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

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

resolve() 方法会从它自己的依赖注入容器子树中返回该提供者的唯一实例。每个子树都有一个唯一的上下文标识符 。因此,如果多次调用此方法并比较实例引用,你会发现它们并不相同。

cats.service.ts
@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() 调用间生成单一实例,并确保它们共享相同的依赖注入容器子树,你可以向 resolve() 方法传入一个上下文标识符。使用 ContextIdFactory 类来生成上下文标识符,该类提供了 create() 方法,可返回一个合适的唯一标识符。

cats.service.ts
@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 提供者为 undefined,因为它们不是由 Nest 依赖注入系统实例化和管理的。

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

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

#获取当前子树

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

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

请求提供者的更多信息,请点击此处 。

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

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

#动态实例化自定义类

要动态实例化一个先前未注册为提供者的类,可使用模块引用的 create() 方法。

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

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

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