Apollo 2.x中GraphIQL无法触发订阅问题求助

我来帮你一步步定位这个订阅失效的问题，从Schema到配置再到Resolver，逐个环节检查：

1. 确认Schema中存在Subscription类型定义 #

首先要确保你的GraphQL Schema里明确声明了Subscription类型，这是订阅功能的核心入口。比如你需要添加类似这样的定义：

type Subscription {
  # 这里定义你需要的订阅事件，比如新增Resolution的通知
  resolutionAdded: Resolution!
}

如果没有这个类型，GraphIQL根本不知道有订阅可以触发，自然不会调用对应的Resolver。

2. 检查Apollo Server的订阅配置是否正确 #

Apollo订阅依赖WebSocket协议，所以必须在服务器端正确配置WebSocket支持，尤其是Apollo Server v3+版本，需要单独设置WebSocket服务器：

import { ApolloServer } from '@apollo/server';
import { expressMiddleware } from '@apollo/server/express4';
import { createServer } from 'http';
import { WebSocketServer } from 'ws';
import { useServer } from 'graphql-ws/lib/use/ws';
import { makeExecutableSchema } from '@graphql-tools/schema';

// 合并你的typeDefs和resolvers
const schema = makeExecutableSchema({ typeDefs, resolvers });

// 创建HTTP服务器
const httpServer = createServer(app);

// 配置WebSocket服务器，路径要和你的GraphQL端点一致
const wsServer = new WebSocketServer({
  server: httpServer,
  path: '/graphql',
});

// 将schema绑定到WebSocket服务器
useServer({ schema }, wsServer);

// 启动服务器时要监听httpServer，而不是直接监听express app
httpServer.listen({ port: 4000 }, () => {
  console.log(`🚀 Server ready at http://localhost:4000/graphql`);
});

如果跳过这一步，GraphIQL的订阅请求无法建立WebSocket连接，断点自然不会触发。

3. 验证订阅Resolver的实现逻辑 #

订阅的Resolver和Query/Mutation不同，需要返回一个AsyncIterator，通常会用pubsub工具来处理事件的发布和订阅：

import { PubSub } from 'graphql-subscriptions';
const pubsub = new PubSub();

const resolvers = {
  Subscription: {
    resolutionAdded: {
      // 这里返回一个迭代器，监听指定的事件通道
      subscribe: () => {
        console.log('订阅Resolver被触发了！'); // 加个日志调试
        return pubsub.asyncIterator('RESOLUTION_ADDED');
      },
    },
  },
  Mutation: {
    // 比如在新增Resolution的Mutation里发布事件
    addResolution: (parent, args) => {
      const newResolution = // 你的创建逻辑
      pubsub.publish('RESOLUTION_ADDED', { resolutionAdded: newResolution });
      return newResolution;
    },
  },
};

要注意两点：

• 订阅Resolver的subscribe函数必须返回有效的AsyncIterator
• 必须在某个触发事件的地方（比如Mutation）调用pubsub.publish，否则订阅不会收到任何数据

4. 检查GraphIQL的订阅连接状态 #

打开GraphIQL界面后，切换到"Subscription"标签页，发起订阅请求后，看右上角是否显示"Connected"状态：

• 如果显示"Disconnected"，说明WebSocket端点路径不对，检查你的WebSocket服务器配置的path是否和GraphIQL使用的路径一致（比如都是/graphql）
• 如果连接正常但没数据，那问题大概率出在Resolver或事件发布环节

5. 调试技巧帮你定位问题 #

• 在订阅Resolver的subscribe函数开头加日志，看服务器控制台是否有输出，判断请求是否到达Resolver
• 在pubsub.publish的地方加日志，确认事件是否被正确发布
• 检查发布事件时的数据结构是否和订阅字段匹配，比如发布的resolutionAdded必须是符合Resolution类型的对象，否则会返回null

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