如何在NestJS微服务中使用GraphQL？

当然可以在NestJS的TCP微服务中集成GraphQL，下面分两种常用场景给出具体实现方案，同时解决Resolver与MessagePattern/EventPattern控制器的适配问题：

场景1：混合应用模式（同时支持GraphQL HTTP接口与TCP微服务） #

这是最常用的方案——让应用同时暴露HTTP端口用于GraphQL查询，以及TCP端口用于微服务间的消息通信。Resolver负责处理GraphQL请求，MessagePattern控制器负责处理TCP消息，二者各司其职，无需额外适配。

步骤1：修改启动代码（bootstrap） #

创建混合应用，同时启动HTTP服务和TCP微服务：

import { NestFactory } from '@nestjs/core';
import { Transport, MicroserviceOptions } from '@nestjs/microservices';
import { AppModule } from './app.module';

async function bootstrap() {
  // 创建HTTP应用，用于GraphQL访问
  const app = await NestFactory.create(AppModule);

  // 连接并启动TCP微服务
  const microservice = app.connectMicroservice<MicroserviceOptions>({
    transport: Transport.TCP,
    options: {
      port: 23001,
    },
  });

  // 先启动微服务，再启动HTTP服务
  await microservice.listen();
  await app.listen(3000); // HTTP端口，用于访问GraphQL Playground
}
bootstrap();

步骤2：配置GraphQLModule（AppModule） #

导入GraphQL相关依赖并配置自动生成Schema：

import { Module } from '@nestjs/common';
import { GraphQLModule } from '@nestjs/graphql';
import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
import { AppResolver } from './app.resolver';
import { AppController } from './app.controller';

@Module({
  imports: [
    GraphQLModule.forRoot<ApolloDriverConfig>({
      driver: ApolloDriver,
      autoSchemaFile: 'schema.gql', // 自动生成Schema文件
      playground: true, // 开启GraphQL调试界面
    }),
  ],
  providers: [AppResolver], // 注册Resolver
  controllers: [AppController], // 注册微服务控制器
})
export class AppModule {}

步骤3：编写Resolver与微服务控制器 #

• Resolver（处理GraphQL请求）：

import { Query, Resolver } from '@nestjs/graphql';

@Resolver()
export class AppResolver {
  @Query(() => String)
  getHello() {
    return 'Hello from GraphQL!';
  }
}

• 微服务控制器（处理TCP消息）：

import { Controller } from '@nestjs/common';
import { MessagePattern } from '@nestjs/microservices';

@Controller()
export class AppController {
  @MessagePattern({ cmd: 'ping' })
  handlePing() {
    return 'Pong from TCP microservice!';
  }
}

启动后，你可以通过http://localhost:3000/graphql访问GraphQL Playground，同时其他微服务可以通过TCP端口23001发送{ cmd: 'ping' }消息获取响应。

场景2：纯TCP微服务中处理GraphQL查询 #

如果不想暴露HTTP端口，所有请求都通过TCP传输，可以通过MessagePattern接收GraphQL查询参数，再调用GraphQL执行器处理请求，将Resolver的逻辑整合到消息处理流程中。

步骤1：配置GraphQLModule（关闭HTTP相关功能） #

import { Module } from '@nestjs/common';
import { GraphQLModule } from '@nestjs/graphql';
import { ApolloDriver, ApolloDriverConfig } from '@nestjs/apollo';
import { AppResolver } from './app.resolver';
import { AppController } from './app.controller';
import { GraphQLService } from './graphql.service';

@Module({
  imports: [
    GraphQLModule.forRoot<ApolloDriverConfig>({
      driver: ApolloDriver,
      autoSchemaFile: 'schema.gql',
      playground: false, // 关闭HTTP调试界面
    }),
  ],
  providers: [AppResolver, GraphQLService],
  controllers: [AppController],
})
export class AppModule {}

步骤2：创建GraphQL执行服务 #

用于执行接收到的GraphQL查询：

import { Injectable, OnModuleInit } from '@nestjs/common';
import { ApolloServer } from '@apollo/server';
import { getSchema } from '@nestjs/graphql';

@Injectable()
export class GraphQLService implements OnModuleInit {
  private apolloServer: ApolloServer;

  async onModuleInit() {
    // 初始化Apollo Server，使用自动生成的Schema
    this.apolloServer = new ApolloServer({ schema: getSchema() });
    await this.apolloServer.start();
  }

  async executeQuery(query: string, variables?: Record<string, any>) {
    return this.apolloServer.executeOperation({ query, variables });
  }
}

步骤3：编写消息处理控制器 #

通过MessagePattern接收GraphQL请求并转发给执行服务：

import { Controller } from '@nestjs/common';
import { MessagePattern, Payload } from '@nestjs/microservices';
import { GraphQLService } from './graphql.service';

@Controller()
export class AppController {
  constructor(private readonly graphQLService: GraphQLService) {}

  @MessagePattern({ cmd: 'graphql' })
  async handleGraphQLRequest(
    @Payload() payload: { query: string; variables?: Record<string, any> }
  ) {
    const { query, variables = {} } = payload;
    return this.graphQLService.executeQuery(query, variables);
  }
}

客户端可以通过TCP发送如下格式的消息来执行GraphQL查询：

// 示例客户端请求
client.send({ cmd: 'graphql' }, {
  query: `query { getHello }`,
  variables: {}
}).subscribe(response => console.log(response));

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