NestJS V8 GraphQL查询复杂度实现问题求助

问题核心 #

你遇到的矛盾点在于：手动实例化ComplexityPlugin时无法注入GraphQLSchemaHost依赖，省略plugins配置又触发版本兼容类错误，本质是对NestJS Apollo插件注册机制和依赖注入逻辑的误解，加上可能的版本不匹配。

正确配置步骤 #

1. 保留现有ComplexityPlugin代码 #

你的插件实现本身是正确的，无需修改：

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

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

  requestDidStart(
    requestContext: GraphQLRequestContext<BaseContext>,
  ): void | 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);
      },
    };
  }
}

2. 修改模块配置 #

关键：不要手动在GraphQLModule.forRoot中实例化插件，通过Nest依赖注入自动注册：

import { Module } from '@nestjs/common';
import { GraphQLModule } from '@nestjs/graphql';
import { ComplexityPlugin } from './complexity.plugin';
// 导入你的resolver等业务组件
import { ItemsResolver } from './items.resolver';

@Module({
  imports: [
    GraphQLModule.forRoot({
      // 你的GraphQL基础配置
      autoSchemaFile: 'schema.gql',
      playground: true,
      // 移除手动plugins配置项
    }),
  ],
  providers: [ComplexityPlugin, ItemsResolver], // 将插件加入providers数组
})
export class AppModule {}

3. 验证依赖版本匹配 #

确保package.json中依赖版本符合NestJS V8要求：

{
  "dependencies": {
    "@nestjs/common": "^8.0.0",
    "@nestjs/core": "^8.0.0",
    "@nestjs/graphql": "^10.0.0",
    "@nestjs/apollo": "^10.0.0",
    "apollo-server-plugin-base": "^3.0.0",
    "graphql": "^16.0.0",
    "graphql-query-complexity": "^0.12.0"
  }
}

4. 可选：自定义字段复杂度 #

在Resolver中为特定字段设置动态复杂度规则：

import { Resolver, Query, Args } from '@nestjs/graphql';
import { Item } from './item.entity';

@Resolver(() => Item)
export class ItemsResolver {
  @Query(() => [Item], {
    extensions: {
      // 根据请求参数动态计算复杂度
      complexity: (args: { limit: number }) => args.limit * 2,
    },
  })
  getItems(@Args('limit', { defaultValue: 10 }) limit: number) {
    // 业务逻辑实现
    return [];
  }
}

错误原因说明 #

• 手动new ComplexityPlugin()无法获取Nest容器中的GraphQLSchemaHost实例，依赖注入仅能处理容器内的对象实例化。
• @Plugin()装饰器会让Nest的Apollo插件探索器自动识别并注册插件，无需手动加入plugins配置数组。
• 你遇到的TypeError通常是@nestjs/apollo与apollo-server-plugin-base版本不兼容导致，版本匹配后即可解决。

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