Cookies

HTTP cookie 是用户浏览器存储的一小段数据。Cookie 被设计为网站记住有状态信息的可靠机制。当用户再次访问网站时，cookie 会自动随请求发送。

与 Express 一起使用（默认）

首先安装所需的包（以及 TypeScript 用户的类型）：

$ npm i cookie-parser
$ npm i -D @types/cookie-parser

安装完成后，将 cookie-parser 中间件应用为全局中间件（例如，在你的 main.ts 文件中）。

import * as cookieParser from 'cookie-parser';
// 在你的初始化文件中
app.use(cookieParser());

你可以向 cookieParser 中间件传递几个选项：

• secret 用于签名 cookie 的字符串或数组。这是可选的，如果未指定，将不会解析签名 cookie。如果提供了字符串，则将其用作密钥。如果提供了数组，将按顺序尝试使用每个密钥来取消签名 cookie。
• options 作为第二个选项传递给 cookie.parse 的对象。更多信息请参阅 cookie。

该中间件将解析请求上的 Cookie 头，并将 cookie 数据公开为 req.cookies 属性，如果提供了密钥，则作为 req.signedCookies 属性。这些属性是 cookie 名称到 cookie 值的名值对。

当提供了密钥时，此模块将取消签名并验证任何签名的 cookie 值，并将这些名值对从 req.cookies 移到 req.signedCookies。签名 cookie 是值以 s: 为前缀的 cookie。签名验证失败的签名 cookie 将具有值 false 而不是被篡改的值。

有了这些，你现在可以在路由处理程序中读取 cookie，如下所示：

@Get()
findAll(@Req() request: Request) {
  console.log(request.cookies); // 或 "request.cookies['cookieKey']"
  // 或 console.log(request.signedCookies);
}

提示

@Req() 装饰器从 @nestjs/common 导入，而 Request 从 express 包导入。

要将 cookie 附加到传出响应，请使用 Response#cookie() 方法：

@Get()
findAll(@Res({ passthrough: true }) response: Response) {
  response.cookie('key', 'value')
}

警告

如果你想将响应处理逻辑留给框架，请记住将 passthrough 选项设置为 true，如上所示。在这里了解更多。

提示

@Res() 装饰器从 @nestjs/common 导入，而 Response 从 express 包导入。

与 Fastify 一起使用

首先安装所需的包：

$ npm i @fastify/cookie

安装完成后，注册 @fastify/cookie 插件：

import fastifyCookie from '@fastify/cookie';

// 在你的初始化文件中
const app = await NestFactory.create<NestFastifyApplication>(AppModule, new FastifyAdapter());
await app.register(fastifyCookie, {
  secret: 'my-secret', // 用于 cookie 签名
});

有了这些，你现在可以在路由处理程序中读取 cookie，如下所示：

@Get()
findAll(@Req() request: FastifyRequest) {
  console.log(request.cookies); // 或 "request.cookies['cookieKey']"
}

提示

@Req() 装饰器从 @nestjs/common 导入，而 FastifyRequest 从 fastify 包导入。

要将 cookie 附加到传出响应，请使用 FastifyReply#setCookie() 方法：

@Get()
findAll(@Res({ passthrough: true }) response: FastifyReply) {
  response.setCookie('key', 'value')
}

要了解更多关于 FastifyReply#setCookie() 方法的信息，请查看此页面。

警告

如果你想将响应处理逻辑留给框架，请记住将 passthrough 选项设置为 true，如上所示。在这里了解更多。

提示

@Res() 装饰器从 @nestjs/common 导入，而 FastifyReply 从 fastify 包导入。

创建自定义装饰器（跨平台）

要提供一种方便的、声明式的方式来访问传入的 cookie，我们可以创建一个自定义装饰器。

import { createParamDecorator, ExecutionContext } from '@nestjs/common';

export const Cookies = createParamDecorator((data: string, ctx: ExecutionContext) => {
  const request = ctx.switchToHttp().getRequest();
  return data ? request.cookies?.[data] : request.cookies;
});

@Cookies() 装饰器将从 req.cookies 对象中提取所有 cookie 或指定名称的 cookie，并用该值填充被装饰的参数。

有了这些，我们现在可以在路由处理程序签名中使用该装饰器，如下所示：

@Get()
findAll(@Cookies('name') name: string) {}