logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页插件
下一页扩展

#复杂度

警告

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

查询复杂度功能允许您定义特定字段的复杂程度,并通过设置最大复杂度来限制查询。其核心思想是使用简单数字来定义每个字段的复杂度,通常默认给每个字段分配 1 的复杂度值。此外,GraphQL 查询的复杂度计算可以通过所谓的复杂度估算器进行自定义。复杂度估算器是一个计算字段复杂度的简单函数,您可以在规则中添加任意数量的估算器,它们会按顺序依次执行。第一个返回数值型复杂度结果的估算器将决定该字段的最终复杂度。

@nestjs/graphql 包与 graphql-query-complexity 等工具深度集成,后者提供了基于成本分析的解决方案。通过该库,您可以拒绝执行那些被认为代价过高的 GraphQL 服务器查询。

#安装

要开始使用它,我们首先需要安装所需的依赖项。

$ npm install --save graphql-query-complexity

#快速开始

安装过程完成后,我们就可以定义 ComplexityPlugin 类:

import { GraphQLSchemaHost } from '@nestjs/graphql';
import { Plugin } from '@nestjs/apollo';
import {
  ApolloServerPlugin,
  BaseContext,
  GraphQLRequestListener,
} from '@apollo/server';
import { GraphQLError } from 'graphql';
import {
  fieldExtensionsEstimator,
  getComplexity,
  simpleEstimator,
} from 'graphql-query-complexity';

@Plugin()
export class ComplexityPlugin implements ApolloServerPlugin {
  constructor(private gqlSchemaHost: GraphQLSchemaHost) {}

  async requestDidStart(): Promise<GraphQLRequestListener<BaseContext>> {
    const maxComplexity = 20;
    const { schema } = this.gqlSchemaHost;

    return {
      async didResolveOperation({ request, document }) {
        const complexity = getComplexity({
          schema,
          operationName: request.operationName,
          query: document,
          variables: request.variables,
          estimators: [
            fieldExtensionsEstimator(),
            simpleEstimator({ defaultComplexity: 1 }),
          ],
        });
        if (complexity > maxComplexity) {
          throw new GraphQLError(
            `Query is too complex: ${complexity}. Maximum allowed complexity: ${maxComplexity}`
          );
        }
        console.log('Query Complexity:', complexity);
      },
    };
  }
}

出于演示目的,我们将允许的最大复杂度指定为 20。在上面的示例中,我们使用了 2 个估算器:simpleEstimator 和 fieldExtensionsEstimator。

  • simpleEstimator:简单估算器为每个字段返回一个固定的复杂度值
  • fieldExtensionsEstimator:字段扩展估算器用于提取模式中每个字段的复杂度值
提示

请记得将此类添加到任意模块的 providers 数组中

#字段级复杂度

启用此插件后,我们现在可以通过在传入 @Field() 装饰器的选项对象中指定 complexity 属性来定义任意字段的复杂度,如下所示:

@Field({ complexity: 3 })
title: string;

或者,你也可以定义估算函数:

@Field({ complexity: (options: ComplexityEstimatorArgs) => ... })
title: string;

#查询/变更级别的复杂度

此外,@Query() 和 @Mutation() 装饰器可以像这样指定一个 complexity 属性:

@Query({ complexity: (options: ComplexityEstimatorArgs) => options.args.count * options.childComplexity })
items(@Args('count') count: number) {
  return this.itemsService.getItems({ count });
}