如何解决扩展 Request 接口以添加固定用户属性并扩展任何其他类
我正在使用 NestJS 和 TypeScript 结合 Passport JWT 的实现来开发服务器端应用程序。
先介绍一下上下文:
我的 JwtStrategy (这里没有问题):
@Injectable()
export class JwtStrategy extends PassportStrategy(Strategy) {
constructor(private userService: UserService) {
super({
jwtFromrequest: ExtractJwt.fromAuthHeaderAsBearerToken(),secretorKey: 'hi',});
}
async validate(payload: IJwtClaims): Promise<UserEntity> {
const { sub: id } = payload;
// Find the user's database record by its "id" and return it.
const user = await this.userService.findById(id);
if (!user) {
throw new UnauthorizedException();
}
return user;
}
}
根据有关 validate()
方法的文档:
Passport 将根据我们的返回值构建一个用户对象 validate() 方法,并将其作为一个属性附加到 Request 对象上。
由于这种行为,我可以像这样访问处理程序中的 user
对象:
@Get('hi')
example(@Req() request: Request) {
const userId = (request.user as UserEntity).id;
}
您是否注意到我使用了类型断言(告诉编译器将用户对象视为 UserEntity)?没有它,我将无法自动完成我的实体的属性。
作为一个快速的解决方案,我创建了一个扩展 Request
接口并包含我自己的 UserEntity
类型属性的类。
import { Request } from 'express';
import { UserEntity } from 'entities/user.entity';
export class WithUserEntityRequestDto extends Request {
user: UserEntity;
}
现在,我的处理程序将是:
@Get('hi')
example(@Req() request: WithUserEntityRequestDto) {
const userId = request.user.id; // Nicer
}
现在真正的问题:
我有(并将有更多)一个接收有效载荷的处理程序,我们在本示例中将其称为 PasswordResetRequestDto
。
export class PasswordResetRequestDto {
currentPassword: string;
newPassword: string;
}
处理程序将是:
@Get('password-reset')
resetPassword(@Body() request: PasswordResetRequestDto) {
}
现在,我无权访问用户的对象。我想访问它以了解发出此请求的用户是谁。
我尝试过的:
使用 TypeScript 泛型并向我之前的 WithUserEntityRequestDto
类添加一个新属性,如下所示:
export class WithUserEntityRequestDto<T> extends Request {
user: UserEntity;
newProp: T;
}
处理程序将是:
@Get('password-reset')
resetPassword(@Req() request: WithUserEntityRequestDto<PasswordResetRequestDto>) {
}
但现在 PasswordResetRequestDto
将位于 newProp
之下,使其不是可扩展的解决方案。我作为泛型传递的任何类型都将在 newProp
下。另外,我不能扩展 T
因为一个类不能扩展两个类。我不认为自己一直在上这样的课。
我期望实现的目标:
将类型传递给我的 WithUserEntityRequestDto
类以默认包含传递的类型属性和用户对象。例如,我可以做的一种方式:
request: WithUserEntityRequestDto<AwesomeRequestDto>
request: WithUserEntityRequestDto<BankRequestDto>
该值将类似于:
{
user: UserEntity,// As default,always present
// all the properties of the passed type (T),// all the properties of the Request interface
}
我的目标是找到一种简单且可扩展的方法来扩展 Request
接口并在其上包含任何类型/类,同时始终存在用户对象 (UserEntity
)。
感谢您抽出时间提供任何帮助/建议/方法。
解决方法
Nestjs 为您的问题提供了一个优雅的解决方案,即 Custom decoration
将属性附加到请求对象是常见的做法。然后在每个路由处理程序中手动提取它们,
你需要做的是创建一个用户装饰器:
//user.decorator.ts
import { createParamDecorator,ExecutionContext } from '@nestjs/common';
export const User = createParamDecorator(
(data: unknown,ctx: ExecutionContext) => {
const request = ctx.switchToHttp().getRequest();
return request.user;
},);
然后你可以像这样简单地在你的控制器中使用它:
@Get('hi')
example(@Req() request: Request,@User() user: UserEntity) {
const userId = user.id;
}
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。