【NestJS系列】核心理念：模块模块

前言

模块是指用 @Module 装饰器装饰的类。每个应用程序至少有一个模块，即根模块。根模块是 Nest 构建应用程序的起点。理论上，Nest程序可能只有根模块，但大多数情况下有多个模块，每个模块都有自己封装的一组相关功能。

@模块装饰器

@Module()装饰器可以传入具有以下属性值的对象：

@模块({
  导入：[NanjiuModule，UserModule]，
  控制器：[AppController]，
  提供商：[应用程序服务]，
})
导出类 AppModule {}

模块共享

如果要将当前模块的服务暴露给其他模块，可以使用exports来暴露服务

例如，我使用nest g资源info创建一个新的info类，并使用export导出服务

// info.module.ts
从'@nestjs/common'导入{模块}；
从'./info.service'导入{InfoService}；
从'./info.controller'导入{InfoController}；

@模块（{
  控制器：[信息控制器]，
  提供者: [InfoService], // 提供者
  Exports: [InfoService] // 导出InfoService以供其他模块使用
})
导出类 InfoModule {}

然后我在 user 模块

// user.module.ts
从'@nestjs/common'导入{模块}；
从 './user.service' 导入 { UserService }；
从'./user.controller'导入{UserController}；
从'src/info/info.module'导入{InfoModule}；

@模块（{
  import: [InfoModule], // 导入 InfoModule
  控制器：[用户控制器]，
  提供者：[用户服务]
})
导出类 UserModule {}

最后在控制器中进行依赖注入并使用

// user.controller.ts
从'src/info/info.service'导入{InfoService}；

@Controller('用户')导出类 UserController {
  构造函数（
    私有只读用户服务：UserService，
    private readonly infoService: InfoService, // 注入 InfoService
    ）{}

  @邮政（）
  创建（@Body（）createUserDto：CreateUserDto）{
    return this.infoService.findAll() // 调用InfoService的findAll方法

    // 返回 this.userService.create(createUserDto);
  }
  //...
}

至此完成模块共享。可以看到我们可以调用user模块中info的服务

模块再导出

可以先将一些常用的公共模块导入到CommonModule中，然后再从exports中全部导出。如果有一个模块想要使用其中一个模块的Service，只需要导入这个CommonModule即可。就是这样，不需要导入所有依赖模块

//common.module.ts
@模块（{
  导入：[模块1，模块2，模块3，模块4]，
  导出：[模块1，模块2，模块3，模块4]，
})
导出类 CommonModule {}

依赖注入

模块类还可以注入providerservices

@模块（{控制器：[用户控制器]，
  提供者：[用户服务]，
})
导出类用户模块{
  构造函数（私有 userService：UserService）{}
}

全局模块

通过 @Global() 装饰器声明全局模块。只需要在根模块imports中注册全局模块，就可以在所有其他模块中使用它导出的。 服务

例如：声明info为全局模块

// info.module.ts
@Global() // 全局模块
@模块（{
  控制器：[信息控制器]，
  提供者: [InfoService], // 提供者
  Exports: [InfoService] // 导出InfoService以供其他模块使用
})
导出类 InfoModule {}

那么就不需要在user模块中导入了，只需依赖注入就可以直接使用了（前提是已经在根模块中导入了）

// user.controller.ts
从 './dto/create-user.dto' 导入 { CreateUserDto }；
从'src/info/info.service'导入{InfoService}；

@Controller('用户')
导出类 UserController {
  构造函数（
    私有只读用户服务：UserService，
    private readonly infoService: InfoService, // 注入 InfoService
    ）{}

  @邮政（）
  创建（@Body（）createUserDto：CreateUserDto）{return this.infoService.findAll() // 调用InfoService的findAll方法
  }
}

动态模块

动态模块允许我们创建可定制的模块。当模块被导入并且某些选项参数传递给它时，该模块会根据这些选项参数动态创建具有不同特征的模块。

创建动态模块

动态模块实际上为当前的Module类提供了一个forRoot方法。此方法返回一个新的Module。该Module的类型是Dyn amicModule，当其他模块需要注册使用时，可以使用xxxModule.forRoot(args)动态注册不同的Module来提供不同的provider。

这里我们创建一个config的动态模块

//config.module.ts
从 '@nestjs/common' 导入 { Module, DynamicModule, Global };
从 'src/nanjiu/nanjiu.service' 导入 { NanjiuService };
从 'src/user/user.service' 导入 { UserService }；

界面选项{
    名称：字符串
}
@全球的（）
@模块（{
})
导出类 ConfigModule {
    静态forRoot（选项：选项）：DynamicModule {
        console.log('选项', 选项)
        返回 {模块：配置模块，
            提供者：[
                {provide: 'config', useClass: www.sychzs.cn === 'nanjiu' ?南九服务 : UserService},
            ],
            出口：[
                {provide: 'config', useClass: www.sychzs.cn === 'nanjiu' ?南九服务：用户服务}
            ]
        }
    }
}

这个例子非常简单。首先，您需要自己编写一个静态方法。该方法通过接收传入的参数来决定使用哪个服务。并且为了方便起见，我使用@Global( )装饰器将模块声明为全局模块

使用

调用静态方法传递参数

//app.module.ts
@模块（{
  导入：[ConfigModule.forRoot({name: 'fe'})],
  控制器：[AppController]，
  提供商：[应用程序服务]，
})
导出类 AppModule {}

，然后在控制器中使用

从'@nestjs/common'导入{控制器，获取，注入}；
从'./app.service'导入{AppService}；

@控制器（）
导出类 AppController {
  构造函数（
    私有只读应用程序服务：应用程序服务，@Inject('config') private readonly configService // 注入 ConfigService
    ）{}

  @Get('/hello2')
  获取2() {
    return this.configService.getHello() // 调用ConfigService的getHello方法
  }
}

比如上面的forRoot传递的参数是{name: 'nanjiu'}，所以此时注入的ConfigModule应该是用户服务

修改forRoot参数

//app.module.ts
@模块（{
  导入：[ConfigModule.forRoot({name: 'nanjiu'})],
  控制器：[AppController]，
  提供商：[应用程序服务]，
})
导出类 AppModule {}

此时，如果您再次通过get访问同一条路线，您应该访问的是南九服务提供的服务。

以上就是动态模块的简单用法。我们会在接下来的内容中再次遇到它~