nest.js的动态模块核心逻辑

动态模块的独立性

动态模块是通过静态模块的静态方法返回的,每次调用生成的模块实例是新的模块,它具有自己的模块作用域,它与原来的静态模块相比是独立两个模块

这类似于静态模块是基类,然后动态模块继承于它,创建一个新的类,多个动态模块之间也是独立的,相当于创建的多个实例。

所以无法通过静态模块直接去访问动态模块的提供者,但是可以使用有一个module 属性,就是用于在宿主模块中合并动态模块的提供者和导出项。

模块的作用域

在nest中,你可以把模块理解成js的文件模块,你要使用某个模块的方法,就必须导入这个方法所属的模块,并不存在什么父子层级关系。

有人错误的理解成子模块和父模块,认为导入的是子模块,子模块中再导入的又是孙子模块,父模块可以访问孙子模块,其实这是错误的。

需要明确一点,模块之前要访问彼此的提供者,只有两种方式:导入模块和全局模块,且提供者必须是导出的。

动态模块与自身静态模块类的关系

每个 DynamicModule 的返回值中包含一个 module 属性,它指定了模块的标识。这通常是静态模块类的名字,例如 MyDynamicModule。Nest.js 使用这个类名来识别模块是否相同。

typescript 复制代码
class MyDynamicModule {
   static register(config: any): DynamicModule {
       return {
           module: MyDynamicModule, // 静态模块的类名作为标识
           providers: [{ provide: 'CONFIG', useValue: config }],
           exports: ['CONFIG'],
       };
   }
}

使用register每次生成的都是新的动态模块,而这些动态模块的module属性都是MyDynamicModule类。 这样产生的效果是:

  1. 相同 module 标识的模块会共享静态模块的提供者
  2. 相同 module 标识的模块,它们会被认为是同一个模块,但是不是静态模块,而是静态模块的另外的一个分身
  3. 虽然 module 标识是静态模块类,但是静态模块无法访问动态模块生成的提供者,因为他们只是公用基类而创建的不同模块

我们将注册动态模块的那个模块称为动态模块的宿主模块:

typescript 复制代码
@Module({
  imports: [
    MyDynamicModule.register({ key: 'value1' }), // 动态模块
    MyDynamicModule.register({ key: 'value2' }), // 新的动态模块实例
  ],
})
export class AppModule {}

AppModule是MyDynamicModule生成的两个动态模块的宿主模块

这些动态模块的提供者只能在宿主模块中被访问,如果想让这些动态模块的提供者可以被外界访问,必须将动态模块导出。

typescript 复制代码
@Module({
  imports: [
    MyDynamicModule.register({ key: 'value1' }), // 动态模块
    MyDynamicModule.register({ key: 'value2' }), // 新的动态模块实例
  ],
  exports: [MyDynamicModule],
})
export class AppModule {}

这里为什么导出静态模块类,就能实现当前动态模块的导出呢?

其实是因为当前两个动态模块的module一样,都使用MyDynamicModule作为模块的命名空间,所以会合并两个动态模块的 providersexports 到同一个模块中,并且模块的命名空间是类MyDynamicModule,类MyDynamicModule只是作为一个标识符,让两个动态模块的内容合并,导出的是当前宿主模块中以类MyDynamicModule为标识符合并的动态模块,与静态MyDynamicModule其实关系不大。

相关推荐
胡萝卜的兔1 小时前
go 日志的分装和使用 Zap + lumberjack
开发语言·后端·golang
en-route1 小时前
如何在 Spring Boot 中指定不同的配置文件?
java·spring boot·后端
栀椩2 小时前
springboot配置请求日志
java·spring boot·后端
Swift社区3 小时前
如何解决 Spring Bean 循环依赖
java·后端·spring
爱吃烤鸡翅的酸菜鱼3 小时前
【Redis】常用数据结构之Hash篇:从常用命令到使用场景详解
数据结构·数据库·redis·后端·缓存·哈希算法
bobz9653 小时前
calico vxlan 模式如何实现和公有云一样的 VPC 功能?
后端
面汤放盐4 小时前
互联网“黑话”生存实用指南(100)
java·后端
爱吃烤鸡翅的酸菜鱼4 小时前
【Redis】常用数据结构之List篇:从常用命令到典型使用场景
数据结构·redis·后端·缓存·list
ytadpole5 小时前
揭秘 XXL-JOB 调度:从代码深处看路由策略的精妙设计
java·后端
京东零售技术5 小时前
查收你的技术成长礼包
后端·算法·架构