如何使用NestJS操作Passport-JS AuthGuard中的cookies？

在使用NestJS结合Passport-JS的AuthGuard时，处理cookies是一个常见的需求。Cookies通常用于存储会话信息，以便在客户端和服务器之间保持状态。以下是如何在NestJS中使用Passport-JS AuthGuard来操作cookies的基础概念和相关步骤：

基础概念

Cookies: 是一种存储在用户浏览器上的小型数据片段，它可以包含会话信息或其他数据。
Passport-JS: 是一个Node.js的身份验证中间件，支持多种策略。
AuthGuard: 是NestJS提供的一个守卫，用于保护路由，确保只有经过身份验证的用户才能访问。

类型

会话Cookies: 存储在服务器端，通常与一个会话ID关联。
持久Cookies: 设置了过期时间，即使关闭浏览器也会保留。

应用场景

用户登录状态维护: 使用cookies来跟踪用户的登录状态。
个性化设置: 存储用户的偏好设置或其他个性化信息。

如何操作Cookies

在NestJS中，你可以通过@nestjs/passport和passport模块来集成Passport-JS。以下是一个简单的例子，展示如何在AuthGuard中设置和读取cookies。

安装依赖

首先，确保你已经安装了必要的npm包：

npm install @nestjs/passport passport passport-local cookie-parser

配置Passport

在你的NestJS应用中配置Passport：

import { Module } from '@nestjs/common';
import { PassportModule } from '@nestjs/passport';
import { LocalStrategy } from './local.strategy';
import { AuthService } from './auth.service';

@Module({
  imports: [
    PassportModule.register({ defaultStrategy: 'local' }),
  ],
  providers: [AuthService, LocalStrategy],
})
export class AuthModule {}

创建AuthGuard

创建一个AuthGuard来保护你的路由：

import { Injectable } from '@nestjs/common';
import { CanActivate, ExecutionContext, UnauthorizedException } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { PassportStrategy } from '@nestjs/passport';
import { ExtractJwt, Strategy as JwtStrategy } from 'passport-jwt';

@Injectable()
export class JwtAuthGuard extends PassportStrategy(JwtStrategy) {
  constructor(private reflector: Reflector) {
    super({
      jwtFromRequest: ExtractJwt.fromAuthHeaderAsBearerToken(),
      ignoreExpiration: false,
      secretOrKey: process.env.JWT_SECRET,
    });
  }

  canActivate(context: ExecutionContext): boolean | Promise<boolean> {
    const roles = this.reflector.get<string[]>('roles', context.getHandler());
    if (roles) {
      const request = context.switchToHttp().getRequest();
      const jwt = this.extractJwt(request);
      const { role } = jwt.payload;
      if (!roles.includes(role)) {
        throw new UnauthorizedException('You do not have permission to access this resource');
      }
    }
    return super.canActivate(context);
  }
}

设置和读取Cookies

在你的控制器中，你可以使用cookie-parser中间件来解析请求中的cookies，并使用Passport来设置认证状态。

import { Controller, Get, UseGuards, Response } from '@nestjs/common';
import { Response as ExpressResponse } from 'express';
import { AuthGuard } from '@nestjs/passport';

@Controller('profile')
export class ProfileController {
  @UseGuards(AuthGuard('jwt'))
  @Get()
  getProfile(@Req() req, @Res() res: ExpressResponse) {
    // 设置一个cookie
    res.cookie('profileId', '12345', { maxAge: 900000, httpOnly: true });
    
    // 读取cookie
    const profileId = req.cookies.profileId;
    
    return { message: 'Profile page', profileId };
  }
}

可能遇到的问题及解决方法

问题：Cookies未正确设置或读取

原因: 可能是由于cookie-parser中间件未正确配置，或者cookies的属性（如httpOnly、secure等）设置不正确。
解决方法: 确保在app.module.ts中引入并使用CookieParser模块，并检查cookies的属性设置是否符合你的安全策略。

import { Module } from '@nestjs/common';
import { CookieParser } from '@nestjsplus/cookie-parser';

@Module({
  imports: [
    CookieParser(),
    // ...其他模块
  ],
})
export class AppModule {}