NestJS Cookies

HTTP cookie 是用戶瀏覽器存儲的一小段數(shù)據(jù)。 Cookie 旨在成為網(wǎng)站記住狀態(tài)信息的可靠機制。 當用戶再次訪問網(wǎng)站時，cookie 會自動隨請求一起發(fā)送。

與 Express 一起使用（默認）

首先安裝所需的包（以及 TypeScript 用戶的類型）：

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

安裝完成后，將 cookie-parser 中間件應(yīng)用為全局中間件（例如，在 main.ts 文件中）。

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

你可以將幾個選項傳遞給 cookieParser 中間件：

• secret 用于簽署 cookie 的字符串或數(shù)組。這是可選的，如果未指定，將不會解析簽名的 cookie。如果提供了字符串，則將其用作密鑰。如果提供了一個數(shù)組，則將嘗試按順序使用每個密鑰對 cookie 取消簽名。
• options 作為第二個選項傳遞給 cookie.parse 的對象。

中間件將解析請求上的 Cookie 標頭，并可以使用 req.cookies 訪問 cookie 數(shù)據(jù)，如果提供了密鑰，則使用屬性 req.signedCookies 訪問簽名的cookie。這些屬性是 cookie 名稱到 cookie 值的鍵值對。

當提供密鑰時，此模塊將取消簽名并驗證任何已簽名的 cookie 值，并將這些名稱值對從 req.cookies 移動到 req.signedCookies。簽名 cookie 是一個值以 s: 為前綴的 cookie。簽名驗證失敗的簽名 cookie 將具有值 false 而不是被篡改的值。

有了這個，我們現(xiàn)在可以從路由處理程序中讀取 cookie，如下所示：

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

提示 ： @Req() 裝飾器是從 @nestjs/common 導(dǎo)入的，而 Request 是從 express 包導(dǎo)入的。

要將 cookie 附加到傳出響應(yīng)，請使用 Response#cookie() 方法：

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

警告 如果想將響應(yīng)處理邏輯留給框架，請記住將 passthrough 選項設(shè)置為 true，如上所示。

@Res() 裝飾器是從 @nestjs/common 導(dǎo)入的，而 Response 是從 express 包導(dǎo)入的。

與 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 簽名
});

有了這個，我們現(xiàn)在可以從路由處理程序中讀取 cookie，如下所示：

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

@Req() 裝飾器是從 @nestjs/common 導(dǎo)入的，而 FastifyRequest 是從 fastify 包導(dǎo)入的。

要將 cookie 附加到傳出響應(yīng)，請使用 FastifyReply#setCookie() 方法：

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

警告 如果我們想將響應(yīng)處理邏輯留給框架，請記住將 passthrough 選項設(shè)置為 true 。

@Res() 裝飾器是從 @nestjs/common 導(dǎo)入的，而 FastifyReply 是從 fastify 包導(dǎo)入的。

創(chuàng)建自定義裝飾器（跨平臺）

為了提供一種方便的、聲明式的方式來訪問傳入的 cookie，我們可以創(chuàng)建一個自定義裝飾器 。

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，并使用該值填充裝飾參數(shù)。

有了這個，我們現(xiàn)在可以在路由處理程序簽名中使用裝飾器，如下所示：

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