NestJS使用AuthGuard后Express Request无user属性的类型问题

你可以通过以下两种方式解决类型报错问题：

方案1：全局扩展Express Request类型（推荐） #

该方案可以让所有用到Express Request的地方都自动识别user字段，无需额外修改业务代码类型声明。

1. 新建类型声明文件src/types/express.d.ts，写入以下内容：

// 先自定义你的JWT用户结构，替换为你实际validate返回的字段
interface JwtUser {
  id: number
  username: string
  // 补充其他你存储在JWT payload中的字段
}

declare namespace Express {
  export interface Request {
    user: JwtUser
  }
}

2. 调整项目根目录的tsconfig.json配置，确保你的自定义类型目录被加载：

{
  "compilerOptions": {
    // 其他原有配置保留
    "typeRoots": ["node_modules/@types", "src/types"]
  }
}

配置完成后重启TS服务，原有代码中req.user就会自动带上类型提示，不会再报不存在的错误。

方案2：自定义局部请求类型 #

如果你不想全局修改Express的类型定义，可以单独定义带user字段的请求类型使用：

1. 在公共类型文件或者对应控制器顶部定义扩展类型：

import { Request } from 'express'

// 自定义用户结构
interface JwtUser {
  id: number
  username: string
}

export interface RequestWithJwt extends Request {
  user: JwtUser
}

2. 控制器中替换Request类型为你自定义的RequestWithJwt即可：

async createUsers(@Body() dto: UserDto, @Req() req: RequestWithJwt): Promise<any> {
  console.log(req.user) // 正常识别类型，无报错
}

额外优化建议 #

你可以把AuthStrategy中validate方法的返回值也替换为你定义的JwtUser类型，替换掉原有any类型，进一步提升类型安全性。

内容的提问来源于stack exchange，提问作者Ctfrancia