serverless

    ------------------------------ | ----------------- | | Express | 0.0079s (7.9ms) | | Nest 使用 @nestjs/platform-express | 0.1974s (197.4ms) | | Nest（独立应用程序） | 0.1117s (111.7ms) | | 原始 Node.js 脚本 | 0.0071s (7.1ms) |

    info 注意 机器：MacBook Pro Mid 2014，2.5 GHz 四核 Intel Core i7，16 GB 1600 MHz DDR3，SSD。

    现在，让我们重复所有基准测试，但这次使用webpack（如果您安装了Nest CLI，您可以运行nest build --webpack）将我们的应用程序捆绑到单个可执行JavaScript文件中。 然而，我们不是使用Nest CLI默认的webpack配置，而是确保将所有依赖项（node_modules）捆绑在一起，如下所示：

    module.exports = (options, webpack) => {
  const lazyImports = [
    '@nestjs/microservices/microservices-module',
    '@nestjs/websockets/socket-module',
  ];

  return {
    ...options,
    externals: [],
    plugins: [
      ...options.plugins,
      new webpack.IgnorePlugin({
        checkResource(resource) {
          if (lazyImports.includes(resource)) {
            try {
              require.resolve(resource);
            } catch (err) {
              return true;
            }
          }
          return false;
        },
      }),
    ],
  };
};

    info 提示 要指示Nest CLI使用此配置，请在项目的根目录中创建一个新的webpack.config.js文件。

    使用此配置，我们获得了以下结果：

    Express0.0068s (6.8ms)
    Nest 使用 @nestjs/platform-express0.0815s (81.5ms)
    Nest（独立应用程序）0.0319s (31.9ms)
    原始 Node.js 脚本0.0066s (6.6ms)

    info 注意 机器：MacBook Pro Mid 2014，2.5 GHz 四核 Intel Core i7，16 GB 1600 MHz DDR3，SSD。

    info 提示 您可以通过应用额外的代码压缩和优化技术（使用webpack插件等）进一步优化它。

    如您所见，您编译代码的方式（以及是否捆绑代码）至关重要，对整体启动时间有显著影响。使用webpack，您可以将独立Nest应用程序（带有一个模块、控制器和服务的启动项目）的引导时间平均降至约32ms，将常规HTTP、基于express的NestJS应用程序的引导时间降至约81.5ms。

    对于更复杂的Nest应用程序，例如，具有10个资源（通过$ nest g resource示意图生成=10个模块、10个控制器、10个服务、20个DTO类、50个HTTP端点+AppModule），在MacBook Pro Mid 2014，2.5 GHz 四核 Intel Core i7，16 GB 1600 MHz DDR3，SSD上的整体启动时间约为0.1298s（129.8ms）。将单体应用程序作为无服务器函数运行通常没有太大意义，因此将此基准测试更多地视为引导时间可能如何随着应用程序增长而潜在增加的示例。

    运行时优化

    到目前为止，我们已经介绍了编译时优化。这些与您定义提供者和加载Nest模块的方式无关，而这在您的应用程序变大时起着至关重要的作用。

    例如，想象一下将数据库连接定义为异步提供者。异步提供者旨在延迟应用程序启动，直到一个或多个异步任务完成。 这意味着，如果您的无服务器函数平均需要2秒才能连接到数据库（在引导时），您的端点将需要至少额外两秒（因为它必须等待连接建立）才能发送响应（当它是冷启动且您的应用程序尚未运行时）。

    如您所见，在无服务器环境中，引导时间很重要，因此您构建提供者的方式有所不同。 另一个很好的例子是，如果您在某些情况下使用Redis进行缓存。也许，在这种情况下，您不应该将Redis连接定义为异步提供者，因为它会减慢引导时间，即使对于这个特定的函数调用不是必需的。

    此外，有时您可以使用LazyModuleLoader类延迟加载整个模块，如本章中所述。缓存也是一个很好的例子。 想象一下，您的应用程序有一个CacheModule，它内部连接到Redis，并且还导出CacheService以与Redis存储交互。如果您不需要它用于所有潜在的函数调用， 您可以按需、延迟加载它。这样，对于所有不需要缓存的调用，您将获得更快的启动时间（当发生冷启动时）。

    if (request.method === RequestMethod[RequestMethod.GET]) {
  const { CacheModule } = await import('./cache.module');
  const moduleRef = await this.lazyModuleLoader.load(() => CacheModule);

  const { CacheService } = await import('./cache.service');
  const cacheService = moduleRef.get(CacheService);

  return cacheService.get(ENDPOINT_KEY);
}

    另一个很好的例子是webhook或工作器，它根据一些特定条件（例如，输入参数）可能执行不同的操作。 在这种情况下，您可以在路由处理程序中指定一个条件，该条件为特定的函数调用延迟加载适当的模块，并延迟加载所有其他模块。

    if (workerType === WorkerType.A) {
  const { WorkerAModule } = await import('./worker-a.module');
  const moduleRef = await this.lazyModuleLoader.load(() => WorkerAModule);
  // ...
} else if (workerType === WorkerType.B) {
  const { WorkerBModule } = await import('./worker-b.module');
  const moduleRef = await this.lazyModuleLoader.load(() => WorkerBModule);
  // ...
}

    示例集成

    您的应用程序的入口文件（通常是main.ts文件）的外观取决于几个因素，因此没有一个适用于所有场景的单一模板。例如，启动无服务器函数所需的初始化文件因云提供商（AWS、Azure、GCP等）而异。 此外，根据您是要运行具有多个路由/端点的典型HTTP应用程序还是只提供单个路由（或执行特定部分代码）， 您的应用程序代码会有所不同（例如，对于每个函数一个端点的方法，您可以使用NestFactory.createApplicationContext而不是启动HTTP服务器、设置中间件等）。

    仅出于说明目的，我们将Nest（使用@nestjs/platform-express并启动完整功能的HTTP路由器） 与Serverless框架（在这种情况下，针对AWS Lambda）集成。正如我们前面提到的，您的代码会根据您选择的云提供商和许多其他因素而有所不同。

    首先，让我们安装所需的包：

    $ npm i @codegenie/serverless-express aws-lambda
$ npm i -D @types/aws-lambda serverless-offline

    info 提示 为了加快开发周期，我们安装了serverless-offline插件，它可以模拟AWS λ和API Gateway。

    安装过程完成后，让我们创建serverless.yml文件来配置Serverless框架：

    service: serverless-example

plugins:
  - serverless-offline

provider:
  name: aws
  runtime: nodejs14.x

functions:
  main:
    handler: dist/main.handler
    events:
      - http:
          method: ANY
          path: /
      - http:
          method: ANY
          path: '{proxy+'}

    info 提示 要了解有关Serverless框架的更多信息，请访问官方文档。

    有了这个配置，我们现在可以导航到main.ts文件并使用所需的样板代码更新我们的引导代码：

    import { NestFactory } from '@nestjs/core';
import serverlessExpress from '@codegenie/serverless-express';
import { Callback, Context, Handler } from 'aws-lambda';
import { AppModule } from './app.module';

let server: Handler;

async function bootstrap(): Promise<Handler> {
  const app = await NestFactory.create(AppModule);
  await app.init();

  const expressApp = app.getHttpAdapter().getInstance();
  return serverlessExpress({ app: expressApp });
}

export const handler: Handler = async (
  event: any,
  context: Context,
  callback: Callback,
) => {
  server = server ?? (await bootstrap());
  return server(event, context, callback);
};

    info 提示 对于创建多个无服务器函数并在它们之间共享公共模块，我们建议使用CLI Monorepo模式。

    warning 警告 如果您使用@nestjs/swagger包，在无服务器函数上下文中使其正常工作需要几个额外步骤。查看此线程以获取更多信息。

    接下来，打开tsconfig.json文件，确保启用esModuleInterop选项，以使@codegenie/serverless-express包正确加载。

    {
  "compilerOptions": {
    ...
    "esModuleInterop": true
  }
}

    现在我们可以构建我们的应用程序（使用nest build或tsc）并使用serverless CLI在本地启动我们的lambda函数：

    $ npm run build
$ npx serverless offline

    应用程序运行后，打开浏览器并导航到http://localhost:3000/dev/[ANY_ROUTE]（其中[ANY_ROUTE]是应用程序中注册的任何端点）。

    在上面的部分中，我们已经表明使用webpack和捆绑应用程序可以对整体引导时间产生显著影响。 然而，要使其与我们的示例一起工作，您必须在webpack.config.js文件中添加一些额外的配置。通常， 为了确保我们的handler函数被拾取，我们必须将output.libraryTarget属性更改为commonjs2。

    return {
  ...options,
  externals: [],
  output: {
    ...options.output,
    libraryTarget: 'commonjs2',
  },
  // ... 其余配置
};

    有了这个配置，您现在可以使用$ nest build --webpack来编译函数的代码（然后使用$ npx serverless offline来测试它）。

    还建议（但不是必需，因为它会减慢构建过程）安装terser-webpack-plugin包并覆盖其配置，以在压缩生产构建时保持类名不变。不这样做可能会导致在应用程序中使用class-validator时出现不正确的行为。

    const TerserPlugin = require('terser-webpack-plugin');

return {
  ...options,
  externals: [],
  optimization: {
    minimizer: [
      new TerserPlugin({
        terserOptions: {
          keep_classnames: true,
        },
      }),
    ],
  },
  output: {
    ...options.output,
    libraryTarget: 'commonjs2',
  },
  // ... 其余配置
};

    使用独立应用程序功能

    或者，如果您想保持函数非常轻量，并且不需要任何HTTP相关功能（路由，还有守卫、拦截器、管道等）， 您可以只使用NestFactory.createApplicationContext（如前所述），而不是运行整个HTTP服务器（以及底层的express），如下所示：

    import { HttpStatus } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { Callback, Context, Handler } from 'aws-lambda';
import { AppModule } from './app.module';
import { AppService } from './app.service';

export const handler: Handler = async (
  event: any,
  context: Context,
  callback: Callback,
) => {
  const appContext = await NestFactory.createApplicationContext(AppModule);
  const appService = appContext.get(AppService);

  return {
    body: appService.getHello(),
    statusCode: HttpStatus.OK,
  };
};

    info 提示 请注意，NestFactory.createApplicationContext不会用增强器（守卫、拦截器等）包装控制器方法。为此，您必须使用NestFactory.create方法。

    您还可以将event对象传递给，例如，EventsService提供者，该提供者可以处理它并返回相应的值（取决于输入值和您的业务逻辑）。

    export const handler: Handler = async (
  event: any,
  context: Context,
  callback: Callback,
) => {
  const appContext = await NestFactory.createApplicationContext(AppModule);
  const eventsService = appContext.get(EventsService);
  return eventsService.process(event);
};