Nest入门教程 - 模块

绝地灬酷狼 2023-07-12 03:41 48阅读 0赞

# Nest入门教程 - 模块 #

### [模块][Link 1] ###

模块是具有 `@Module()` 装饰器的类。 `@Module()` 装饰器提供了元数据，Nest 用它来组织应用程序结构。

![图1][1]

每个 Nest 应用程序至少有一个模块，即根模块。根模块是 Nest 开始安排应用程序树的地方。事实上，根模块可能是应用程序中唯一的模块，特别是当应用程序很小时，但是对于大型程序来说这是没有意义的。在大多数情况下，您将拥有多个模块，每个模块都有一组紧密相关的**功能**。

`@module()` 装饰器接受一个描述模块属性的对象：

<table> 
 <thead> 
  <tr> 
   <th>&nbsp;</th> 
   <th>&nbsp;</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>providers</td> 
   <td>由 Nest 注入器实例化的提供者，并且可以至少在整个模块中共享</td> 
  </tr> 
  <tr> 
   <td>controllers</td> 
   <td>必须创建的一组控制器</td> 
  </tr> 
  <tr> 
   <td>imports</td> 
   <td>导入模块的列表，这些模块导出了此模块中所需提供者</td> 
  </tr> 
  <tr> 
   <td>exports</td> 
   <td>由本模块提供并应在其他模块中可用的提供者的子集。</td> 
  </tr> 
 </tbody> 
</table>

默认情况下, 模块**封装**提供者。这意味着如果提供者即不是当前模块的一部分, 也不是从另外模块(已导入)导出的，那么它就是无法注入的。

# #

## [功能模块][Link 2] ##

`CatsController` 和 `CatsService` 属于同一个应用程序域。 应该考虑将它们移动到一个功能模块下，即 `CatsModule`。

> cats/cats.module.ts

import { Module } from '@nestjs/common';
    import { CatsController } from './cats.controller';
    import { CatsService } from './cats.service';
    
    @Module({
      controllers: [CatsController],
      providers: [CatsService],
    })
    export class CatsModule {}Copy to clipboardErrorCopied

要使用 CLI 创建模块，只需执行 `$ nest g module cats` 命令。

我已经创建了 `cats.module.ts` 文件，并把与这个模块相关的所有东西都移到了 cats 目录下。我们需要做的最后一件事是将这个模块导入根模块 `(ApplicationModule)`。

> app.module.ts

import { Module } from '@nestjs/common';
    import { CatsModule } from './cats/cats.module';
    
    @Module({
      imports: [CatsModule],
    })
    export class ApplicationModule {}Copy to clipboardErrorCopied

现在 Nest 知道除了 `ApplicationModule` 之外，注册 `CatsModule` 也是非常重要的。 这就是我们现在的目录结构:

src
    ├──cats
    │    ├──dto
    │    │   └──create-cat.dto.ts
    │    ├──interfaces
    │    │     └──cat.interface.ts
    │    ├─cats.service.ts
    │    ├─cats.controller.ts
    │    └──cats.module.ts
    ├──app.module.ts
    └──main.tsCopy to clipboardErrorCopied

# #

## [共享模块][Link 3] ##

在 Nest 中，默认情况下，模块是**单例**，因此您可以轻松地在多个模块之间共享**同一个**提供者实例。

![图1][1 1]

实际上，每个模块都是一个**共享模块**。一旦创建就能被任意模块重复使用。假设我们将在几个模块之间共享 `CatsService` 实例。 我们需要把 `CatsService` 放到 `exports` 数组中，如下所示：

> cats.module.ts

import { Module } from '@nestjs/common';
    import { CatsController } from './cats.controller';
    import { CatsService } from './cats.service';
    
    @Module({
      controllers: [CatsController],
      providers: [CatsService],
      exports: [CatsService]
    })
    export class CatsModule {}Copy to clipboardErrorCopied

现在，每个导入 `CatsModule` 的模块都可以访问 `CatsService` ，并且它们将共享相同的 `CatsService` 实例。

# #

## [模块导出][Link 4] ##

模块可以导出他们的内部提供者。 而且，他们可以再导出自己导入的模块。

@Module({
      imports: [CommonModule],
      exports: [CommonModule],
    })
    export class CoreModule {}Copy to clipboardErrorCopied

# [依赖注入][Link 5] #

提供者也可以注入到模块(类)中（例如，用于配置目的）：

> cats.module.ts

但是，由于[循环依赖][Link 6]性，模块类不能注入到提供者中。

# #

## [全局模块][Link 7] ##

如果你不得不在任何地方导入相同的模块，那可能很烦人。在 [Angular][] 中，提供者是在全局范围内注册的。一旦定义，他们到处可用。另一方面，Nest 将提供者封装在模块范围内。您无法在其他地方使用模块的提供者而不导入他们。但是有时候，你可能只想提供一组随时可用的东西 - 例如：helper，数据库连接等等。这就是为什么你能够使模块成为全局模块。

import { Module, Global } from '@nestjs/common';
    import { CatsController } from './cats.controller';
    import { CatsService } from './cats.service';
    
    @Global()
    @Module({
      controllers: [CatsController],
      providers: [CatsService],
      exports: [CatsService],
    })
    export class CatsModule {}Copy to clipboardErrorCopied

`@Global` 装饰器使模块成为全局作用域。 全局模块应该只注册一次，最好由根或核心模块注册。 在上面的例子中，`CatsService` 组件将无处不在，而想要使用 `CatsService` 的模块则不需要在 `imports` 数组中导入 `CatsModule`。

使一切全局化并不是一个好的解决方案。 全局模块可用于减少必要模板文件的数量。 `imports` 数组仍然是使模块 API 透明的最佳方式。

# #

## [动态模块][Link 8] ##

`Nest` 模块系统带有一个称为动态模块的功能。 它使您能够毫不费力地创建可定制的模块。 让我们来看看 `DatabaseModule`：

import { Module, DynamicModule } from '@nestjs/common';
    import { createDatabaseProviders } from './database.providers';
    import { Connection } from './connection.provider';
    
    @Module({
      providers: [Connection],
    })
    export class DatabaseModule {
      static forRoot(entities = [], options?): DynamicModule {
        const providers = createDatabaseProviders(options, entities);
        return {
          module: DatabaseModule,
          providers: providers,
          exports: providers,
        };
      }
    }Copy to clipboardErrorCopied

`forRoot()` 可以同步或异步（`Promise`）返回动态模块。

此模块默认定义了 `Connection` 提供者，但另外 - 根据传递的 `options` 和 `entities` - 创建一个提供者集合，例如存储库。实际上，动态模块扩展了模块元数据。当您需要动态注册组件时，这个实质特性非常有用。然后你可以通过以下方式导入 `DatabaseModule`：

import { Module } from '@nestjs/common';
    import { DatabaseModule } from './database/database.module';
    import { User } from './users/entities/user.entity';
    
    @Module({
      imports: [DatabaseModule.forRoot([User])],
    })
    export class ApplicationModule {}Copy to clipboardErrorCopied

为了导出动态模块，可以省略函数调用部分：

import { Module } from '@nestjs/common';
    import { DatabaseModule } from './database/database.module';
    import { User } from './users/entities/user.entity';
    
    @Module({
      imports: [DatabaseModule.forRoot([User])],
      exports: [DatabaseModule],
    })
    export class ApplicationModule {}Copy to clipboardErrorCopied

## ##

### [译者署名][Link 9] ###

<table> 
 <thead> 
  <tr> 
   <th>用户名</th> 
   <th>头像</th> 
   <th>职能</th> 
   <th>签名</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><a href="https://github.com/zuohuadong" rel="nofollow">@zuohuadong</a></td> 
   <td><img alt="" src="https://imgconvert.csdnimg.cn/aHR0cHM6Ly93eDMuc2luYWltZy5jbi9sYXJnZS8wMDZmVlBDdmx5MWZtcG5sdDhzZWZqMzAyZDAyczc0Mi5qcGc?x-oss-process=image/format,png"></td> 
   <td>翻译</td> 
   <td>专注于 caddy 和 nest，<a href="https://github.com/zuohuadong/" rel="nofollow">@zuohuadong</a>&nbsp;at Github</td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/Armor-cn" rel="nofollow">@Armor</a></td> 
   <td><img alt="" height="67" src="https://img-blog.csdnimg.cn/202003061829390.png" width="73"></td> 
   <td>翻译</td> 
   <td>专注于 Java 和 Nest，<a href="https://armor.ac.cn/" rel="nofollow">@Armor</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://drixn.com/" rel="nofollow">@Drixn</a></td> 
   <td><img alt="" src="https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4uZHJpeG4uY29tL2ltZy9zcmMvYXZhdGFyMS5wbmc?x-oss-process=image/format,png"></td> 
   <td>翻译</td> 
   <td>专注于 nginx 和 C++，<a href="https://drixn.com/" rel="nofollow">@Drixn</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://github.com/tangkai123456" rel="nofollow">@tangkai</a></td> 
   <td><img alt="" height="70" src="https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXJzMS5naXRodWJ1c2VyY29udGVudC5jb20vdS8yMjQzNjkxMA?x-oss-process=image/format,png"></td> 
   <td>翻译</td> 
   <td>专注于 React，<a href="https://github.com/tangkai123456" rel="nofollow">@tangkai</a></td> 
  </tr> 
  <tr> 
   <td><a href="https://havef.github.io/" rel="nofollow">@havef</a></td> 
   <td><img alt="" height="71" src="https://img-blog.csdnimg.cn/20200306182930282.png" width="75"></td> 
   <td>校正</td> 
   <td>数据分析、机器学习、TS/JS技术栈&nbsp;<a href="https://havef.github.io/" rel="nofollow">@havef</a></td> 
  </tr> 
 </tbody> 
</table>

[Link 1]: https://docs.nestjs.cn/6/modules?id=%E6%A8%A1%E5%9D%97
[1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9kb2NzLm5lc3Rqcy5jb20vYXNzZXRzL01vZHVsZXNfMS5wbmc?x-oss-process=image/format,png
[Link 2]: https://docs.nestjs.cn/6/modules?id=%E5%8A%9F%E8%83%BD%E6%A8%A1%E5%9D%97
[Link 3]: https://docs.nestjs.cn/6/modules?id=%E5%85%B1%E4%BA%AB%E6%A8%A1%E5%9D%97
[1 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9kb2NzLm5lc3Rqcy5jb20vYXNzZXRzL1NoYXJlZF9Nb2R1bGVfMS5wbmc?x-oss-process=image/format,png
[Link 4]: https://docs.nestjs.cn/6/modules?id=%E6%A8%A1%E5%9D%97%E5%AF%BC%E5%87%BA
[Link 5]: https://docs.nestjs.cn/6/modules?id=%E4%BE%9D%E8%B5%96%E6%B3%A8%E5%85%A5
[Link 6]: https://docs.nestjs.cn/6/fundamentals?id=circular-dependency
[Link 7]: https://docs.nestjs.cn/6/modules?id=%E5%85%A8%E5%B1%80%E6%A8%A1%E5%9D%97
[Angular]: https://angular.io/
[Link 8]: https://docs.nestjs.cn/6/modules?id=%E5%8A%A8%E6%80%81%E6%A8%A1%E5%9D%97
[Link 9]: https://docs.nestjs.cn/6/modules?id=%E8%AF%91%E8%80%85%E7%BD%B2%E5%90%8D