讲师中心 微信公众号
AI工具推荐 视频效率加速

GraphQL 响应中避免字符串字段的意外转义:正确建模嵌套 JSON 数据

冬晨小哥_5135

冬晨小哥_5135

发布时间:2026-04-27 22:29:17

|

238人浏览过

|

来源于php中文网

原创

GraphQL 响应中避免字符串字段的意外转义:正确建模嵌套 JSON 数据

当 graphql 字段类型为 string 但实际需返回结构化 json 对象时,graphql 会将其序列化为带双引号和转义符的字符串字面量;解决方法是将该字段定义为自定义对象类型,而非 string。

当 graphql 字段类型为 string 但实际需返回结构化 json 对象时,graphql 会将其序列化为带双引号和转义符的字符串字面量;解决方法是将该字段定义为自定义对象类型,而非 string。

问题本质在于类型语义错配:你的 payload: String 字段在 GraphQL Schema 中声明为纯字符串,因此即使 Java 后端传入的是合法 JSON 字符串(如 {"logo": "https://www.php.cn/link/bb859699a1e4fc28c59162684235a28c", ...}),GraphQL 执行器仍会将其作为字符串值整体编码——即对内部引号、换行等字符进行 JSON 转义,并包裹外层双引号,最终导致前端收到的是一个被双重编码的字符串(例如 "{ \"logo\": \"...\" }"),而非可直接访问的 JSON 对象。

✅ 正确做法是让 GraphQL 类型系统准确反映数据结构。你需要定义明确的 schema 类型,替代模糊的 String:

type Payload {
  logo: String!
  name: LanguageSpecificContent!
  copyrightText: LanguageSpecificContent!
  help: String!
  termsAndCondition: String!
}

type LanguageSpecificContent {
  en: String!
  ja: String!
}

同时更新 StringApiResponse 定义:

type StringApiResponse {
  statusCode: String!
  message: String!
  timestamp: String!
  payload: Payload  # ← 不再是 String!
}

在 Java 端,对应地使用强类型对象(如 Lombok 的 @Data POJO 或 Record)替代 String 类型的 payload:

dmap-jsapi-skill
dmap-jsapi-skill

DMap GL地图JSAPI(dmapgl)开发指南。用于编写、审查、调试 DMap 地图 API 代码,涵盖地图初始化、覆盖物渲染、图层管理、事件处理、控件交互等任务。当用户提及 dmap、dmapgl、jsapi‑gl 或相关地图开发需求时自动触发。

下载
public record Payload(
    String logo,
    LanguageSpecificContent name,
    LanguageSpecificContent copyrightText,
    String help,
    String termsAndCondition
) {}

public record LanguageSpecificContent(String en, String ja) {}

// 在 Resolver 中:
@QueryMapping
public StringApiResponse getValue() {
    String rawJson = ValueService.getValue(); // 假设返回原始 JSON 字符串
    // ✅ 关键:解析为 Java 对象,而非保留为 String
    Payload payload = new ObjectMapper().readValue(rawJson, Payload.class);

    return StringApiResponse.builder()
        .statusCode("S0000")
        .message("Success")
        .timestamp(Instant.now().toString())
        .payload(payload) // ← 传递对象,非字符串
        .build();
}

这样,GraphQL 执行器会递归序列化 Payload 及其嵌套结构,生成原生 JSON 对象响应,不再出现多余转义:

{
  "data": {
    "getValue": {
      "payload": {
        "logo": "https://www.php.cn/link/bb859699a1e4fc28c59162684235a28c",
        "name": { "en": "AAA", "ja": "aaa" },
        "copyrightText": { "en": "AAA", "ja": "aaa" },
        "help": "http://help",
        "termsAndCondition": "http://terms"
      }
    }
  }
}

⚠️ 注意事项:

  • ❌ 避免“字符串即 JSON”的反模式:String 类型字段无法表达结构,强制前端 JSON.parse() 是临时补救,破坏类型安全与 IDE 支持;
  • ✅ 前端查询应显式选择所需字段(如示例中的嵌套 name { en, ja }),既提升性能,也强化接口契约;
  • ? 若后端数据源动态多变(如任意 JSON Schema),可考虑 @graphql-java 的 GraphQLScalarType 自定义 JSON 标量,但静态结构推荐强类型对象——更安全、可验证、易维护。

通过精准的 schema 设计与 Java 端对象映射,你不仅能彻底消除恼人的转义字符,更能构建出真正符合 GraphQL 精神的、类型驱动的 API。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

209

2026.01.21

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1738

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2664

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6044

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

5609

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

7294

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

10574

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

5399

2025.07.29

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn