使用Benzene构建GraphQL服务器入门指南
前言
在现代Web开发中,GraphQL已经成为构建API的热门选择。Benzene是一个轻量级的GraphQL服务器实现,它提供了构建GraphQL服务器所需的核心功能。本文将带你使用Benzene构建一个简单的书籍投票应用,涵盖查询、变更和订阅等GraphQL核心概念。
项目概述
我们将构建一个具有以下功能的书籍投票应用:
- 获取书籍和作者列表
- 为书籍投票
- 实时同步投票变化
环境准备
首先创建一个新项目并安装必要的依赖:
mkdir book-votes
cd book-votes
npm init -y
npm i ws graphql @benzene/http @benzene/ws @graphql-tools/schema
确保在package.json
中设置"type": "module"
以使用ES模块语法。
定义GraphQL模式
创建一个schema.js
文件,定义我们的GraphQL模式:
import { makeExecutableSchema } from "@graphql-tools/schema";
import { on, EventEmitter } from "events";
// 定义作者和书籍的初始数据
const authors = [
{ id: 1, name: "Tom Coleman" },
{ id: 2, name: "Sashko Stubailo" },
{ id: 3, name: "Mikhail Novikov" },
];
const books = [
{ id: 1, authorId: 1, title: "Introduction to GraphQL", votes: 2 },
{ id: 2, authorId: 2, title: "Welcome to Meteor", votes: 3 },
{ id: 3, authorId: 2, title: "Advanced GraphQL", votes: 1 },
{ id: 4, authorId: 3, title: "Launchpad is Cool", votes: 7 },
];
// 定义GraphQL类型
const typeDefs = `
type Author {
id: Int!
name: String
books: [Book]
}
type Book {
id: Int!
title: String
author: Author
votes: Int
}
type Query {
books: [Book]
}
type Mutation {
bookUpvote (
bookId: Int!
): Book
}
type Subscription {
bookSubscribe: Book
}
`;
// 使用事件发射器实现订阅功能
const ee = new EventEmitter();
// 定义解析器
const resolvers = {
Query: {
books: () => books,
},
Mutation: {
bookUpvote: (_, { bookId }) => {
const book = books.find((book) => book.id === bookId);
if (!book) {
throw new Error(`找不到ID为${bookId}的书籍`);
}
book.votes += 1;
ee.emit("BOOK_SUBSCRIBE", { bookSubscribe: book });
return book;
},
},
Subscription: {
bookSubscribe: {
subscribe: async function* bookSubscribe() {
for await (const event of on(ee, "BOOK_SUBSCRIBE")) {
yield event[0];
}
},
},
},
Author: {
books: (author) => books.filter((book) => book.authorId === author.id),
},
Book: {
author: (book) => authors.find((author) => author.id === book.authorId),
},
};
// 创建可执行模式
const schema = makeExecutableSchema({
typeDefs,
resolvers,
});
export default schema;
这个模式定义了三种操作:
- 查询:获取所有书籍及其作者信息
- 变更:为指定书籍投票
- 订阅:实时监听书籍投票变化
创建服务器
接下来创建server.js
文件,设置HTTP和WebSocket服务器:
import { createServer } from "http";
import WebSocket from "ws";
import { Benzene, parseGraphQLBody, makeHandler } from "@benzene/http";
import { makeHandler as makeHandlerWs } from "@benzene/ws";
import schema from "./schema.js";
// 读取请求体
function readBody(request) {
return new Promise((resolve) => {
let body = "";
request.on("data", (chunk) => (body += chunk));
request.on("end", () => resolve(body));
});
}
// 创建Benzene实例
const GQL = new Benzene({ schema });
// 创建HTTP和WebSocket处理器
const graphqlHTTP = makeHandler(GQL);
const graphqlWS = makeHandlerWs(GQL);
// 创建HTTP服务器
const server = createServer(async (req, res) => {
const rawBody = await readBody(req);
const result = await graphqlHTTP({
method: req.method,
headers: req.headers,
body: parseGraphQLBody(rawBody, req.headers["content-type"]),
});
res.writeHead(result.status, result.headers);
res.end(JSON.stringify(result.payload));
});
// 创建WebSocket服务器
const wss = new WebSocket.Server({ server });
wss.on("connection", (ws) => {
graphqlWS(ws);
});
// 启动服务器
server.listen(3000, () => {
console.log(`🚀 服务器已启动: http://localhost:3000`);
});
关键点解析
-
请求体处理:我们自定义了
readBody
函数来读取请求体,并使用parseGraphQLBody
处理不同内容类型的GraphQL请求。 -
Benzene实例:创建Benzene实例时传入我们定义的模式,然后使用它创建HTTP和WebSocket处理器。
-
通用性设计:Benzene的设计允许它与各种框架和运行时环境配合使用,只需提供符合规范的请求对象即可。
性能优化建议
对于追求更高性能的场景,可以考虑使用graphql-jit
进行查询编译:
import { makeCompileQuery } from "@benzene/jit";
const GQL = new Benzene({
compileQuery: makeCompileQuery(),
});
这种方式可以获得2倍以上的性能提升。
测试应用
启动服务器:
node ./server.js
测试查询
使用浏览器开发者工具测试查询功能:
await fetch("/graphql", {
method: "POST",
headers: { "content-type": "application/graphql+json" },
body: JSON.stringify({
query: "query { books { id, title, author { name }, votes } }",
}),
}).then((res) => res.json());
测试订阅
建立WebSocket连接并订阅书籍变化:
const websocket = new WebSocket(
"ws://localhost:3000/graphql",
"graphql-transport-ws"
);
websocket.send(JSON.stringify({ type: "connection_init" }));
websocket.send(
JSON.stringify({
type: "subscribe",
id: "1",
payload: { query: "subscription { bookSubscribe { title, votes } }" },
})
);
测试变更
执行投票变更操作:
await fetch("/graphql", {
method: "POST",
headers: { "content-type": "application/graphql+json" },
body: JSON.stringify({ query: "mutation { bookUpvote(bookId: 1) { id } }" }),
}).then((res) => res.json());
此时订阅者会收到更新通知,显示书籍的最新投票数。
总结
通过本教程,我们使用Benzene构建了一个完整的GraphQL服务器,实现了查询、变更和订阅功能。Benzene的轻量级设计和灵活性使其成为构建GraphQL服务的优秀选择,特别是当你需要自定义程度较高的解决方案时。
这个基础示例可以进一步扩展,例如添加认证、数据验证或集成数据库等。Benzene的模块化设计使得这些扩展变得简单而直观。
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~044CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。06GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0300- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选









