Skip to content

压缩

压缩可以大大减小响应体的大小,从而提高 Web 应用的速度。

对于高流量的生产环境网站,强烈建议将压缩从应用服务器中卸载——通常在反向代理(例如 Nginx)中处理。在这种情况下,你不应该使用压缩中间件。

与 Express 一起使用(默认)

使用 compression 中间件包来启用 gzip 压缩。

首先安装所需的包:

bash
$ npm i --save compression
$ npm i --save-dev @types/compression

安装完成后,将 compression 中间件应用为全局中间件。

typescript
import * as compression from 'compression';
// 在你的初始化文件中
app.use(compression());

与 Fastify 一起使用

如果使用 FastifyAdapter,你需要使用 fastify-compress

bash
$ npm i --save @fastify/compress

安装完成后,将 @fastify/compress 中间件应用为全局中间件。

警告

请确保在创建应用程序时使用 NestFastifyApplication 类型。否则,你将无法使用 register 来应用压缩中间件。

typescript
import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify';

import compression from '@fastify/compress';

// 在 bootstrap() 内部
const app = await NestFactory.create<NestFastifyApplication>(AppModule, new FastifyAdapter());
await app.register(compression);

默认情况下,@fastify/compress 会在浏览器表示支持该编码时使用 Brotli 压缩(在 Node >= 11.7.0 上)。虽然 Brotli 在压缩比方面可能非常高效,但它也可能相当慢。默认情况下,Brotli 设置最大压缩质量为 11,但可以通过调整 BROTLI_PARAM_QUALITY(最小 0,最大 11)来减少压缩时间以换取压缩质量。这需要微调以优化空间/时间性能。一个质量为 4 的示例:

typescript
import { constants } from 'node:zlib';
// 在你的初始化文件中
await app.register(compression, { brotliOptions: { params: { [constants.BROTLI_PARAM_QUALITY]: 4 } } });

为了简化,你可能希望告诉 fastify-compress 仅使用 deflate 和 gzip 来压缩响应;你最终会得到可能更大的响应,但它们将更快地传递。

要指定编码,请向 app.register 提供第二个参数:

typescript
await app.register(compression, { encodings: ['gzip', 'deflate'] });

上面的代码告诉 fastify-compress 仅使用 gzip 和 deflate 编码,如果客户端同时支持两者则优先使用 gzip。

基于 NestJS 官方文档翻译