如何用Node.js实现一个支持GraphQL订阅的实时API？-js教程-PHP中文网

如何用Node.js实现一个支持GraphQL订阅的实时API？

紅蓮之龍

发布： 2025-10-04 14:39:02

原创

964人浏览过

使用graphql-ws实现GraphQL订阅需结合WebSocket与发布-订阅模式。1. 安装express、graphql、ws、graphql-ws等依赖；2. 定义含Subscription类型的Schema并编写返回AsyncIterator的解析器；3. 用ws创建WebSocket服务器，通过useServer集成graphql-ws；4. 启动HTTP服务并可选添加express-graphql支持调试界面；5. 前端通过WebSocket连接发送订阅请求，服务端在Mutation中发布事件触发实时推送。关键在于路径一致与正确使用PubSub和AsyncIterator。

如何用node.js实现一个支持graphql订阅的实时api？

要实现一个支持GraphQL订阅的实时API，核心是使用WebSocket来建立持久连接，并结合GraphQL执行机制推送数据更新。Node.js生态中，graphql-ws和subscriptions-transport-ws是主流选择。推荐使用更现代、轻量且兼容性更好的graphql-ws库，配合express和graphql构建完整服务。

1. 安装必要依赖

先初始化项目并安装关键包：

npm init -y
npm install express graphql express-graphql ws graphql-ws

2. 定义GraphQL Schema和解析器

创建基本的Schema，包含查询和订阅类型：

const { buildSchema } = require('graphql');

const schema = buildSchema(` type Post { id: ID! title: String! content: String }

type Query { posts: [Post] }

type Subscription { postAdded: Post } `);

编写解析器，其中订阅返回一个AsyncIterator：

3. 配置WebSocket服务器支持订阅

使用ws创建WebSocket服务器，并通过graphql-ws处理订阅消息：

const express = require('express'); const { createServer } = require('http'); const { useServer } = require('graphql-ws/lib/use/ws'); const { WebSocketServer } = require('ws');

const app = express(); const server = createServer(app);

// 创建WebSocket服务器用于GraphQL订阅 const wss = new WebSocketServer({ server, path: '/graphql' });

useServer({ schema, execute, subscribe }, wss);

注意：execute和subscribe来自graphql模块，需导入：

ViiTor实时翻译

AI实时多语言翻译专家！强大的语音识别、AR翻译功能。

116

查看详情

const { execute, subscribe } = require('graphql');

4. 启动HTTP和WebSocket服务

让Express处理普通请求，WebSocket处理实时通信：

server.listen(4000, () => { console.log('HTTP服务器运行在 http://localhost:4000'); console.log('WebSocket服务器已启动，路径 /graphql'); });

可选：添加express-graphql中间件支持浏览器调试：

const { graphqlHTTP } = require('express-graphql');

app.use('/graphql', graphqlHTTP({ schema, rootValue: resolvers, graphiql: true // 启用GraphiQL界面 }));