0

0

如何在 GraphQL 中正确合并多个命名操作的 DocumentNode

聖光之護

聖光之護

发布时间:2025-12-29 20:59:17

|

103人浏览过

|

来源于php中文网

原创

如何在 GraphQL 中正确合并多个命名操作的 DocumentNode

本文介绍如何将多个带有命名操作(如别名字段)的 graphql documentnode 合并为一个合法的、单 `query` 块内包含多个字段的 documentnode,避免因误用 `concat_ast` 导致的“anonymous operation must be the only defined operation”错误。

在使用 Python 处理 GraphQL 查询时,开发者常希望通过组合多个 DocumentNode(例如分别代表不同数据表的查询)来构建一个批量请求。然而,直接调用 graphql.utilities.concat_ast() 会将每个 DocumentNode 视为独立操作(即多个 { ... } 块),从而生成语法非法的 GraphQL 文本——GraphQL 规范明确禁止在单个文档中存在多个匿名操作({ ... }),除非它们被包裹在统一的 query、mutation 或 subscription 操作声明中。

根本问题在于:concat_ast 是为合并多个完整操作(OperationDefinition)或片段(FragmentDefinition) 设计的,而非拼接多个“裸对象字面量”。你提供的示例中,原始 DocumentNode 实际上是仅含 SelectionSet 的匿名查询(即无 OperationDefinition 节点),concat_ast 将其作为独立操作节点合并,导致输出多个 {} 块,违反规范。

✅ 正确做法是:不依赖 AST 拼接,而是从结构化对象出发,显式构造一个带类型(如 "query")和多个命名字段(alias + field)的 Operation,再渲染为合法 GraphQL 字符串,最后通过 gql() 解析为 DocumentNode。

推荐使用轻量、专为构建查询设计的第三方库 graphql-query(非官方但稳定、类型友好、无运行时依赖)。它提供面向对象的 DSL,可清晰表达别名、参数、嵌套字段等,并确保输出符合 GraphQL 规范的单操作文档。

以下为完整实现示例:

法语写作助手
法语写作助手

法语助手旗下的AI智能写作平台,支持语法、拼写自动纠错,一键改写、润色你的法语作文。

下载
from graphql_query import Argument, Field, Operation, Query
from graphql import parse  # 或使用 gql()(来自 graphql-core)

# 定义第一个命名字段:table1 别名指向 fetchTable1
fetchTable1 = Query(
    name="fetchTable1",
    alias="table1",
    arguments=[
        Argument(name="id", value=[5, 45]),
        Argument(name="perPage", value=5),
        Argument(name="currentPage", value=1),
    ],
    fields=[Field(name="data", fields=["id", "name"])]
)

# 定义第二个命名字段:table2 别名指向 fetchTable2
fetchTable2 = Query(
    name="fetchTable2",
    alias="table2",
    arguments=[
        Argument(name="table1_id", value=[5, 45]),
        Argument(name="perPage", value=5),
        Argument(name="currentPage", value=1),
    ],
    fields=[Field(name="data", fields=["id", "customer"])]
)

# 组合成一个顶层 query 操作(注意:type="query")
operation = Operation(
    type="query",
    queries=[fetchTable1, fetchTable2],
)

# 渲染为标准 GraphQL 字符串
graphql_string = operation.render()
print(graphql_string)

输出结果为合法的单操作 GraphQL 文本:

query {
  table1: fetchTable1(
    id: [5, 45]
    perPage: 5
    currentPage: 1
  ) {
    data {
      id
      name
    }
  }

  table2: fetchTable2(
    table1_id: [5, 45]
    perPage: 5
    currentPage: 1
  ) {
    data {
      id
      customer
    }
  }
}

最后,转换为 DocumentNode 供执行器(如 graphql_sync 或 Apollo Client)使用:

from graphql import parse

document_node = parse(graphql_string)  # ✅ 合法 DocumentNode
# 或使用 gql()(若已安装 graphql-core >= 3.2)
# from graphql import gql
# document_node = gql(graphql_string)

⚠️ 注意事项:

  • 不要对已有 DocumentNode 直接 concat_ast —— 它适用于合并多个含 OperationDefinition 的文档(如多个命名 query),而非“裸 selection set”。
  • 若需复用单表查询逻辑,建议封装为函数(如 build_table1_query(...)),返回 Query 对象而非 DocumentNode,便于灵活组合。
  • graphql-query 不解析 Schema,仅生成字符串,因此无需连接服务端,适合构建阶段或动态查询场景。
  • 如需强类型支持或与 strawberry/ariadne 集成,可基于 graphql.language.ast 手动构造 OperationDefinition 节点,但复杂度显著升高,不推荐初学者采用。

总结:合并命名字段查询的核心在于语义对齐——将多个字段视为同一 query 操作下的并列选择,而非多个独立操作。使用 graphql-query 是兼顾可读性、健壮性与开发效率的最佳实践。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

711

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

625

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

737

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1235

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

573

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

696

2023.08.11

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号