其他特性

    在 GraphQL 世界中，关于如何处理认证或操作的副作用等问题存在很多争论。我们应该在业务逻辑内部处理这些事情吗？我们应该使用高阶函数来增强查询和变更的授权逻辑吗？还是应该使用 schema directives？这些问题没有放之四海而皆准的答案。

    Nest 通过其跨平台特性（如 guards 和 interceptors）帮助解决这些问题。其理念是减少冗余，并提供有助于构建结构良好、可读且一致的应用程序的工具。

    概述

    您可以像使用任何 RESTful 应用程序一样，以相同的方式将标准的 guards、interceptors、filters 和 pipes 与 GraphQL 一起使用。此外，您还可以利用 custom decorators 特性轻松创建自己的装饰器。让我们看一个示例 GraphQL 查询处理器。

    @Query('author')
@UseGuards(AuthGuard)
async getAuthor(@Args('id', ParseIntPipe) id: number) {
  return this.authorsService.findOneById(id);
}

    如您所见，GraphQL 与守卫和管道的配合方式与 HTTP REST 处理器完全相同。因此，您可以将认证逻辑移至守卫中；甚至可以跨 REST 和 GraphQL API 接口复用同一个守卫类。类似地，拦截器在两种类型的应用程序中以相同的方式工作：

    @Mutation()
@UseInterceptors(EventsInterceptor)
async upvotePost(@Args('postId') postId: number) {
  return this.postsService.upvoteById({ id: postId });
}

    执行上下文

    由于 GraphQL 在传入请求中接收不同类型的数据，因此守卫和拦截器接收到的 execution context 在 GraphQL 与 REST 中有所不同。GraphQL 解析器具有一组不同的参数：root、args、context 和 info。因此，守卫和拦截器必须将通用的 ExecutionContext 转换为 GqlExecutionContext。这很简单：

    import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
import { GqlExecutionContext } from '@nestjs/graphql';

@Injectable()
export class AuthGuard implements CanActivate {
  canActivate(context: ExecutionContext): boolean {
    const ctx = GqlExecutionContext.create(context);
    return true;
  }
}

    由 GqlExecutionContext.create() 返回的 GraphQL 上下文对象为每个 GraphQL 解析器参数暴露了一个 get 方法（例如，getArgs()、getContext() 等）。转换后，我们可以轻松地为当前请求挑选出任何 GraphQL 参数。

    异常过滤器

    Nest 标准的 exception filters 同样兼容 GraphQL 应用程序。与 ExecutionContext 一样，GraphQL 应用程序应将 ArgumentsHost 对象转换为 GqlArgumentsHost 对象。

    @Catch(HttpException)
export class HttpExceptionFilter implements GqlExceptionFilter {
  catch(exception: HttpException, host: ArgumentsHost) {
    const gqlHost = GqlArgumentsHost.create(host);
    return exception;
  }
}

    info 提示 GqlExceptionFilter 和 GqlArgumentsHost 均从 @nestjs/graphql 包中导入。

    请注意，与 REST 情况不同，您不使用原生的 response 对象来生成响应。

    自定义装饰器

    如前所述，custom decorators 特性在 GraphQL 解析器中按预期工作。

    export const User = createParamDecorator(
  (data: unknown, ctx: ExecutionContext) =>
    GqlExecutionContext.create(ctx).getContext().user,
);

    如下使用 @User() 自定义装饰器：

    @Mutation()
async upvotePost(
  @User() user: UserEntity,
  @Args('postId') postId: number,
) {}

    info 提示 在上面的示例中，我们假设 user 对象已分配给您的 GraphQL 应用程序的上下文。

    在字段解析器级别执行增强器

    在 GraphQL 上下文中，Nest 不会在字段级别运行增强器（拦截器、守卫和过滤器的通用名称）see this issue：它们仅针对顶层 @Query()/@Mutation() 方法运行。您可以通过在 GqlModuleOptions 中设置 fieldResolverEnhancers 选项，告诉 Nest 为带有 @ResolveField() 注解的方法执行拦截器、守卫或过滤器。根据需要传入 'interceptors'、'guards' 和/或 'filters' 的列表：

    GraphQLModule.forRoot({
  fieldResolverEnhancers: ['interceptors']
}),

    警告 当您返回大量记录且字段解析器被执行数千次时，为字段解析器启用增强器可能会导致性能问题。因此，当您启用 fieldResolverEnhancers 时，我们建议您跳过对字段解析器并非严格必需的增强器的执行。您可以使用以下辅助函数来实现：

    export function isResolvingGraphQLField(context: ExecutionContext): boolean {
  if (context.getType<GqlContextType>() === 'graphql') {
    const gqlContext = GqlExecutionContext.create(context);
    const info = gqlContext.getInfo();
    const parentType = info.parentType.name;
    return parentType !== 'Query' && parentType !== 'Mutation';
  }
  return false;
}

    创建自定义驱动

    Nest 提供了两个开箱即用的官方驱动：@nestjs/apollo 和 @nestjs/mercurius，以及一个允许开发者构建新的自定义驱动的 API。使用自定义驱动，您可以集成任何 GraphQL 库或扩展现有集成，在其之上添加额外功能。

    例如，要集成 express-graphql 包，您可以创建以下驱动类：

    import { AbstractGraphQLDriver, GqlModuleOptions } from '@nestjs/graphql';
import { graphqlHTTP } from 'express-graphql';

class ExpressGraphQLDriver extends AbstractGraphQLDriver {
  async start(options: GqlModuleOptions<any>): Promise<void> {
    options = await this.graphQlFactory.mergeWithSchema(options);

    const { httpAdapter } = this.httpAdapterHost;
    httpAdapter.use(
      '/graphql',
      graphqlHTTP({
        schema: options.schema,
        graphiql: true,
      }),
    );
  }

  async stop() {}
}

    然后按如下方式使用它：

    GraphQLModule.forRoot({
  driver: ExpressGraphQLDriver,
});