Graphql

扩展

学习如何在 NestJS GraphQL 中使用扩展功能来定义自定义元数据,实现字段级权限控制等高级功能。

扩展

警告 本章节仅适用于代码优先方法。

扩展是一个高级、底层功能,允许您在类型配置中定义任意数据。为特定字段附加自定义元数据使您能够创建更复杂、更通用的解决方案。例如,通过扩展,您可以定义访问特定字段所需的字段级角色。这些角色可以在运行时反映,以确定调用者是否有足够的权限来检索特定字段。

添加自定义元数据

要为字段附加自定义元数据,请使用从 @nestjs/graphql 包导出的 @Extensions() 装饰器。

@Field()
@Extensions({ role: Role.ADMIN })
password: string;

在上面的示例中,我们将 role 元数据属性分配为 Role.ADMIN 的值。Role 是一个简单的 TypeScript 枚举,它将我们系统中可用的所有用户角色分组。

请注意,除了在字段上设置元数据外,您还可以在类级别和方法级别(例如,在查询处理器上)使用 @Extensions() 装饰器。

使用自定义元数据

利用自定义元数据的逻辑可以根据需要变得复杂。例如,您可以创建一个简单的拦截器来存储/记录每个方法调用的事件,或者创建一个字段中间件来匹配检索字段所需的角色与调用者权限(字段级权限系统)。

为了说明目的,让我们定义一个 checkRoleMiddleware,它将用户的角色(此处硬编码)与访问目标字段所需的角色进行比较:

export const checkRoleMiddleware: FieldMiddleware = async (
  ctx: MiddlewareContext,
  next: NextFn,
) => {
  const { info } = ctx;
  const { extensions } = info.parentType.getFields()[info.fieldName];

  /**
   * 在实际应用程序中,"userRole" 变量
   * 应该代表调用者(用户)的角色(例如,"ctx.user.role")。
   */
  const userRole = Role.USER;
  if (userRole === extensions.role) {
    // 或者只是 "return null" 来忽略
    throw new ForbiddenException(
      `User does not have sufficient permissions to access "${info.fieldName}" field.`,
    );
  }
  return next();
};

有了这个设置,我们可以为 password 字段注册一个中间件,如下所示:

@Field({ middleware: [checkRoleMiddleware] })
@Extensions({ role: Role.ADMIN })
password: string;