Techniques

会话

学习如何在 NestJS 中使用 HTTP 会话来存储用户信息,包括 Express 和 Fastify 的配置方法。

会话

HTTP 会话提供了一种在多个请求之间存储用户信息的方法,这对于 MVC 应用程序特别有用。

与 Express 一起使用(默认)

首先安装所需的包(以及 TypeScript 用户的类型定义):

$ npm i express-session
$ npm i -D @types/express-session

安装完成后,将 express-session 中间件作为全局中间件应用(例如,在您的 main.ts 文件中)。

import * as session from 'express-session';
// 在您的初始化文件中的某个位置
app.use(
  session({
    secret: 'my-secret',
    resave: false,
    saveUninitialized: false,
  }),
);

注意 默认的服务器端会话存储故意不是为生产环境设计的。在大多数情况下它会泄漏内存,不能扩展到单个进程之外,并且仅用于调试和开发。在官方仓库中阅读更多信息。

secret 用于签名会话 ID cookie。这可以是单个密钥的字符串,也可以是多个密钥的数组。如果提供了密钥数组,只有第一个元素将用于签名会话 ID cookie,而在验证请求中的签名时将考虑所有元素。密钥本身不应该容易被人类解析,最好是一组随机字符。

启用 resave 选项会强制将会话保存回会话存储,即使会话在请求期间从未被修改。默认值是 true,但使用默认值已被弃用,因为默认值将在未来发生变化。

同样,启用 saveUninitialized 选项会强制将"未初始化"的会话保存到存储中。当会话是新的但未被修改时,会话是未初始化的。选择 false 对于实现登录会话、减少服务器存储使用或遵守在设置 cookie 之前需要许可的法律很有用。选择 false 也有助于解决客户端在没有会话的情况下发出多个并行请求时的竞争条件(来源)。

您可以向 session 中间件传递其他几个选项,在 API 文档中阅读更多关于它们的信息。

提示 请注意 secure: true 是一个推荐的选项。但是,它需要启用 https 的网站,即 HTTPS 对于安全 cookie 是必需的。如果设置了 secure,并且您通过 HTTP 访问您的站点,cookie 将不会被设置。如果您的 node.js 在代理后面并且使用 secure: true,您需要在 express 中设置 "trust proxy"

有了这个设置,您现在可以从路由处理程序中设置和读取会话值,如下所示:

@Get()
findAll(@Req() request: Request) {
  request.session.visits = request.session.visits ? request.session.visits + 1 : 1;
}

提示 @Req() 装饰器从 @nestjs/common 导入,而 Requestexpress 包导入。

或者,您可以使用 @Session() 装饰器从请求中提取会话对象,如下所示:

@Get()
findAll(@Session() session: Record<string, any>) {
  session.visits = session.visits ? session.visits + 1 : 1;
}

提示 @Session() 装饰器从 @nestjs/common 包导入。

与 Fastify 一起使用

首先安装所需的包:

$ npm i @fastify/secure-session

安装完成后,注册 fastify-secure-session 插件:

import secureSession from '@fastify/secure-session';

// 在您的初始化文件中的某个位置
const app = await NestFactory.create<NestFastifyApplication>(
  AppModule,
  new FastifyAdapter(),
);
await app.register(secureSession, {
  secret: 'averylogphrasebiggerthanthirtytwochars',
  salt: 'mq9hDxBVDbspDR6n',
});

提示 您也可以预生成一个密钥(查看说明)或使用密钥轮换

官方仓库中阅读更多关于可用选项的信息。

有了这个设置,您现在可以从路由处理程序中设置和读取会话值,如下所示:

@Get()
findAll(@Req() request: FastifyRequest) {
  const visits = request.session.get('visits');
  request.session.set('visits', visits ? visits + 1 : 1);
}

或者,您可以使用 @Session() 装饰器从请求中提取会话对象,如下所示:

@Get()
findAll(@Session() session: secureSession.Session) {
  const visits = session.get('visits');
  session.set('visits', visits ? visits + 1 : 1);
}

提示 @Session() 装饰器从 @nestjs/common 导入,而 secureSession.Session@fastify/secure-session 包导入(导入语句:import * as secureSession from '@fastify/secure-session')。