0

0

GraphQL Yoga 中错误处理与上下文访问的完整指南

心靈之曲

心靈之曲

发布时间:2026-03-06 11:02:33

|

861人浏览过

|

来源于php中文网

原创

GraphQL Yoga 中错误处理与上下文访问的完整指南

在 GraphQL Yoga 中,可通过 useLogger 插件捕获执行阶段的错误,并安全访问操作名、错误详情及请求上下文(如 context),实现与 Apollo Server didEncounterErrors 类似的错误可观测性能力。

在 graphql yoga 中,可通过 `uselogger` 插件捕获执行阶段的错误,并安全访问操作名、错误详情及请求上下文(如 `context`),实现与 apollo server `didencountererrors` 类似的错误可观测性能力。

GraphQL Yoga 作为轻量、现代且符合规范的 GraphQL 服务器实现,其插件系统设计更偏向组合式与函数式风格,不直接提供与 Apollo Server 完全同名的生命周期钩子(如 didEncounterErrors)。但其内置的 useLogger 插件正是为此类场景而生——它不仅用于日志记录,更是一个可靠的错误拦截与上下文增强入口。

useLogger 在 GraphQL 执行流程的关键节点(如 execute 阶段)触发,当查询执行失败并生成 errors 时,args.result.errors 即包含所有抛出的 GraphQLError 实例;同时,args.operationName、args.variables、args.query 等字段均可用。更重要的是:args.context 是完整传递的请求上下文对象,这意味着你可安全访问认证信息、数据库连接、追踪 ID 等自定义字段,完全满足错误诊断、审计或告警等生产需求。

以下为标准配置示例:

九歌
九歌

九歌--人工智能诗歌写作系统

下载
import { createYoga, useLogger } from 'graphql-yoga';

const yoga = createYoga({
  schema,
  plugins: [
    useLogger({
      logFn: (eventName, args) => {
        // 仅在执行出错时处理
        if (eventName === 'execute' && args.result?.errors?.length > 0) {
          const { errors, operationName, context } = args;

          // ✅ 安全访问上下文(含用户、req、db 等)
          console.error('[GraphQL Error]', {
            operationName,
            errorCount: errors.length,
            userId: context?.user?.id, // 示例:记录当前用户
            requestId: context?.requestId,
          });

          errors.forEach((error, index) => {
            console.error(`Error ${index + 1}:`, {
              message: error.message,
              locations: error.locations,
              path: error.path,
              extensions: error.extensions,
            });
          });
        }
      },
    }),
  ],
});

⚠️ 注意事项:

  • useLogger 的 logFn 会在多个事件(如 parse、validate、execute)中被调用,务必通过 eventName === 'execute' 和 args.result?.errors 进行精准过滤,避免重复日志或空引用错误;
  • args.context 是运行时注入的完整上下文,但需确保你在 createYoga 的 context 选项中已正确定义(例如返回 Promise 或同步对象),否则可能为 undefined;
  • 若需对错误进行修改(如脱敏、添加追踪码),useLogger 仅用于读取和日志——如需拦截/重写错误,请搭配 useSchema 或自定义 formatError 函数;
  • 生产环境建议将 console.error 替换为结构化日志库(如 pino)并集成 APM(如 Sentry),利用 error.extensions.code 做分类告警。

总结而言,useLogger 不仅是 Yoga 的日志工具,更是其面向可观测性的核心扩展点。它以简洁 API 提供了比 didEncounterErrors 更丰富的事件粒度与上下文保真度,是 Apollo 迁移中值得重点掌握的替代方案。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Python GraphQL API 开发实战
Python GraphQL API 开发实战

本专题系统讲解 Python 在 GraphQL API 开发中的实际应用,涵盖 GraphQL 基础概念、Schema 设计、Query 与 Mutation 实现、权限控制、分页与性能优化,以及与现有 REST 服务和数据库的整合方式。通过完整示例,帮助学习者掌握 使用 Python 构建高扩展性、前后端协作友好的 GraphQL 接口服务,适用于中大型应用与复杂数据查询场景。

23

2026.01.21

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

431

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

373

2023.10.25

console接口是干嘛的
console接口是干嘛的

console接口是一种用于在计算机命令行或浏览器开发工具中输出信息的工具,提供了一种简单的方式来记录和查看应用程序的输出结果和调试信息。本专题为大家提供console接口相关的各种文章、以及下载和课程。

419

2023.08.08

console.log是什么
console.log是什么

console.log 是 javascript 函数,用于在浏览器控制台中输出信息,便于调试和故障排除。想了解更多console.log的相关内容,可以阅读本专题下面的文章。

535

2024.05.29

undefined是什么
undefined是什么

undefined是代表一个值或变量不存在或未定义的状态。它可以作为默认值来判断一个变量是否已经被赋值,也可以用于设置默认参数值。尽管在不同的编程语言中,undefined可能具有不同的含义和用法,但理解undefined的概念可以帮助我们更好地理解和编写程序。本专题为大家提供undefined相关的各种文章、以及下载和课程。

6136

2023.07.31

网页undefined是什么意思
网页undefined是什么意思

网页undefined是指页面出现了未知错误的意思,提示undefined一般是在开发网站的时候定义不正确或是转换不正确,或是找不到定义才会提示undefined未定义这个错误。想了解更多的相关内容,可以阅读本专题下面的文章。

3306

2024.08.14

网页undefined啥意思
网页undefined啥意思

本专题整合了undefined相关内容,阅读下面的文章了解更多详细内容。后续继续更新。

1564

2025.12.25

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

19

2026.03.05

热门下载

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

精品课程

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

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