NestJS 中文文档

注入作用域

对于来自不同编程语言背景的人来说，了解到在Nest中几乎所有东西都是跨传入请求共享的可能会出乎意料。我们有数据库连接池、具有全局状态的单例服务等。请记住，Node.js不遵循请求/响应多线程无状态模型，其中每个请求由单独的线程处理。因此，对我们的应用程序使用单例实例是完全安全的。

然而，在某些边缘情况下，基于请求的生命周期可能是期望的行为，例如，GraphQL应用程序中的每个请求缓存、请求跟踪和多租户。注入作用域提供了一种机制来获得所需的提供者生命周期行为。

提供者作用域

提供者可以有以下任何作用域：

`DEFAULT`	提供者的单个实例在整个应用程序中共享。实例生命周期直接与应用程序生命周期相关联。一旦应用程序启动，所有单例提供者都已实例化。默认使用单例作用域。
`REQUEST`	提供者的新实例是为每个传入的请求专门创建的。实例在请求处理完成后被垃圾回收。
`TRANSIENT`	瞬态提供者不在消费者之间共享。每个注入瞬态提供者的消费者将收到一个新的、专用的实例。

提示

对于大多数用例，推荐使用单例作用域。跨消费者和跨请求共享提供者意味着实例可以被缓存，并且其初始化仅在应用程序启动期间发生一次。

使用

通过将scope属性传递给@Injectable()装饰器选项对象来指定注入作用域：

import { Injectable, Scope } from '@nestjs/common';

@Injectable({ scope: Scope.REQUEST })
export class CatsService {}

同样，对于自定义提供者，在提供者注册的长表单中设置scope属性：

{
  provide: 'CACHE_MANAGER',
  useClass: CacheManager,
  scope: Scope.TRANSIENT,
}

提示

从@nestjs/common导入Scope枚举。

默认使用单例作用域，不需要声明。如果您确实想将提供者声明为单例作用域，请为scope属性使用Scope.DEFAULT值。

注意

WebSocket网关不应使用请求作用域的提供者，因为它们必须作为单例运行。每个网关封装一个真实的套接字，不能多次实例化。此限制也适用于其他一些提供者，如Passport策略或_Cron控制器_。

控制器作用域

控制器也可以有作用域，适用于该控制器中声明的所有请求方法处理程序。与提供者作用域一样，控制器的作用域声明了其生命周期。对于请求作用域的控制器，为每个入站请求创建一个新实例，并在请求处理完成后垃圾回收。

使用ControllerOptions对象的scope属性声明控制器作用域：

@Controller({
  path: 'cats',
  scope: Scope.REQUEST,
})
export class CatsController {}

作用域层次结构

REQUEST作用域会在注入链中向上冒泡。依赖于请求作用域提供者的控制器本身将是请求作用域的。

想象以下依赖图：CatsController <- CatsService <- CatsRepository。如果CatsService是请求作用域的（而其他是默认单例），CatsController将成为请求作用域的，因为它依赖于注入的服务。不依赖的CatsRepository将保持单例作用域。

瞬态作用域的依赖项不遵循该模式。如果单例作用域的DogsService注入瞬态LoggerService提供者，它将接收一个新实例。然而，DogsService将保持单例作用域，因此在任何地方注入它都不会解析为DogsService的新实例。如果这是期望的行为，DogsService也必须显式标记为TRANSIENT。

请求提供者

在基于HTTP服务器的应用程序中（例如，使用@nestjs/platform-express或@nestjs/platform-fastify），当使用请求作用域的提供者时，您可能希望访问原始请求对象的引用。您可以通过注入REQUEST对象来做到这一点。

REQUEST提供者本质上是请求作用域的，这意味着当使用它时，您不需要显式指定REQUEST作用域。此外，即使您尝试这样做，它也会被忽略。任何依赖于请求作用域提供者的提供者都会自动采用请求作用域，并且此行为无法更改。

import { Injectable, Scope, Inject } from '@nestjs/common';
import { REQUEST } from '@nestjs/core';
import { Request } from 'express';

@Injectable({ scope: Scope.REQUEST })
export class CatsService {
  constructor(@Inject(REQUEST) private request: Request) {}
}

由于底层平台/协议差异，您在Microservice或GraphQL应用程序中访问入站请求的方式略有不同。在GraphQL应用程序中，您注入CONTEXT而不是REQUEST：

import { Injectable, Scope, Inject } from '@nestjs/common';
import { CONTEXT } from '@nestjs/graphql';

@Injectable({ scope: Scope.REQUEST })
export class CatsService {
  constructor(@Inject(CONTEXT) private context) {}
}

然后，您配置context值（在GraphQLModule中）以包含request作为其属性。

询问者提供者

如果您想获取提供者被构造的类，例如在日志记录或指标提供者中，您可以注入INQUIRER令牌。

import { Inject, Injectable, Scope } from '@nestjs/common';
import { INQUIRER } from '@nestjs/core';

@Injectable({ scope: Scope.TRANSIENT })
export class HelloService {
  constructor(@Inject(INQUIRER) private parentClass: object) {}

  sayHello(message: string) {
    console.log(`${this.parentClass?.constructor?.name}: ${message}`);
  }
}

然后按如下方式使用它：

import { Injectable } from '@nestjs/common';
import { HelloService } from './hello.service';

@Injectable()
export class AppService {
  constructor(private helloService: HelloService) {}

  getRoot(): string {
    this.helloService.sayHello('My name is getRoot');

    return 'Hello world!';
  }
}

在上面的示例中，当调用AppService#getRoot时，"AppService: My name is getRoot"将被记录到控制台。

性能

使用请求作用域的提供者会对应用程序性能产生影响。虽然Nest尝试缓存尽可能多的元数据，但它仍然必须在每个请求上创建类的实例。因此，它会减慢您的平均响应时间和整体基准测试结果。除非提供者必须是请求作用域的，否则强烈建议您使用默认的单例作用域。

提示

尽管这一切听起来相当令人生畏，但一个正确设计的利用请求作用域提供者的应用程序在延迟方面不应减慢超过~5%。

持久提供者

如上面部分所述，请求作用域的提供者可能会导致延迟增加，因为至少有1个请求作用域的提供者（注入到控制器实例中，或更深层次 - 注入到其提供者之一中）会使控制器也成为请求作用域的。这意味着它必须在每个单独的请求上重新创建（实例化）（并在之后垃圾回收）。现在，这也意味着，对于例如30k并行请求，将有30k个控制器（及其请求作用域提供者）的临时实例。

让大多数提供者依赖的公共提供者（想想数据库连接或日志服务）会自动将所有这些提供者也转换为请求作用域的提供者。这在多租户应用程序中可能构成挑战，特别是对于那些具有中央请求作用域"数据源"提供者的应用程序，该提供者从请求对象中获取标头/令牌，并基于其值检索相应的数据库连接/架构（特定于该租户）。

例如，假设您有一个由10个不同客户交替使用的应用程序。每个客户都有自己的专用数据源，您希望确保客户A永远无法访问客户B的数据库。实现这一点的一种方法是声明一个请求作用域的"数据源"提供者，该提供者基于请求对象确定"当前客户"并检索其相应的数据库。通过这种方法，您可以在几分钟内将应用程序转变为多租户应用程序。但是，这种方法的一个主要缺点是，由于您的应用程序组件很可能大部分依赖于"数据源"提供者，它们将隐式成为"请求作用域"的，因此您无疑会看到应用程序性能的影响。

但是，如果我们有更好的解决方案呢？既然我们只有10个客户，我们难道不能为每个客户拥有10个单独的DI子树（而不是每个请求重新创建每个树）吗？如果您的提供者不依赖于每个连续请求真正唯一的任何属性（例如，请求UUID），而是有一些特定的属性让我们聚合（分类）它们，那么就没有理由在每个传入请求上重新创建DI子树。

而这正是持久提供者派上用场的时候。

在我们开始将提供者标记为持久之前，我们必须首先注册一个策略，该策略指示Nest什么是那些"公共请求属性"，提供分组请求的逻辑 - 将它们与其相应的DI子树相关联。

import {
  HostComponentInfo,
  ContextId,
  ContextIdFactory,
  ContextIdStrategy,
} from '@nestjs/core';
import { Request } from 'express';

const tenants = new Map<string, ContextId>();

export class AggregateByTenantContextIdStrategy implements ContextIdStrategy {
  attach(contextId: ContextId, request: Request) {
    const tenantId = request.headers['x-tenant-id'] as string;
    let tenantSubTreeId: ContextId;

    if (tenants.has(tenantId)) {
      tenantSubTreeId = tenants.get(tenantId);
    } else {
      tenantSubTreeId = ContextIdFactory.create();
      tenants.set(tenantId, tenantSubTreeId);
    }

    // 如果树不持久，返回原始的 "contextId" 对象
    return (info: HostComponentInfo) =>
      info.isTreeDurable ? tenantSubTreeId : contextId;
  }
}

提示

持久性会在注入链中向上冒泡。这意味着如果A依赖于B，而B被标记为durable，A也会隐式变得持久（除非A提供者的durable显式设置为false）。

警告

请注意，此策略不适合具有大量租户的应用程序。

从attach方法返回的值指示Nest对于给定的主机应该使用什么上下文标识符。在这种情况下，我们指定当主机组件（例如，请求作用域控制器）被标记为持久时（您可以在下面学习如何将提供者标记为持久），应该使用tenantSubTreeId而不是原始的、自动生成的contextId对象。此外，在上面的示例中，没有有效负载会被注册（其中有效负载 = 代表子树"根" - 父级的REQUEST/CONTEXT提供者）。

如果您想为持久树注册有效负载，请使用以下构造：

// `AggregateByTenantContextIdStrategy#attach` 方法的返回：
return {
  resolve: (info: HostComponentInfo) =>
    info.isTreeDurable ? tenantSubTreeId : contextId,
  payload: { tenantId },
};

现在，每当您使用@Inject(REQUEST)/@Inject(CONTEXT)注入REQUEST提供者（或GraphQL应用程序的CONTEXT）时，payload对象将被注入（在这种情况下，由单个属性tenantId组成）。

好的，有了这个策略，您可以在代码的某个地方注册它（因为它无论如何都全局适用），所以例如，您可以将它放在main.ts文件中：

ContextIdFactory.apply(new AggregateByTenantContextIdStrategy());

提示

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

只要注册发生在任何请求到达您的应用程序之前，一切都会按预期工作。

最后，要将常规提供者转变为持久提供者，只需将durable标志设置为true并将其作用域更改为Scope.REQUEST（如果REQUEST作用域已经在注入链中，则不需要）：

import { Injectable, Scope } from '@nestjs/common';

@Injectable({ scope: Scope.REQUEST, durable: true })
export class CatsService {}

同样，对于自定义提供者，在提供者注册的长表单中设置durable属性：

{
  provide: 'foobar',
  useFactory: () => { ... },
  scope: Scope.REQUEST,
  durable: true,
}

#注入作用域

#提供者作用域

#使用

#控制器作用域

#作用域层次结构

#请求提供者

#询问者提供者

#性能

#持久提供者