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

如何在 Retrofit @GET 请求中忽略 API 响应中的多余字段

梦涛小哥_7656

梦涛小哥_7656

发布时间:2026-01-07 23:58:02

|

381人浏览过

|

来源于php中文网

原创

如何在 Retrofit @GET 请求中忽略 API 响应中的多余字段

retrofit 默认支持“字段忽略”——只需在数据类中声明所需字段,gson 会自动跳过 json 中未定义的字段,无需额外配置。本文详解正确实现方式、常见报错原因及最佳实践。

在使用 Retrofit 进行 @GET 请求时,若后端返回的 JSON 包含大量字段(如 resourceUri、phone、email 等),而你仅需其中少数几个(例如仅 id),完全不需要定义全部字段。Retrofit + Gson 的默认行为正是「宽松反序列化」:只要目标数据类中声明了对应字段(类型兼容),其余未知字段会被自动忽略,不会抛出异常。

✅ 正确做法如下:

  1. 精简定义数据类(仅含所需字段):

    data class ApiResponse(
     val id: String
    )

    即使响应中包含 "xxx": null、"phone": "kkk" 等未声明字段,Gson 也会静默跳过,不会报错。

  2. 确保 Retrofit 配置了 GsonConverterFactory(关键!):

    anything-to-html
    anything-to-html

    将调研报告、方案对比、数据分析、需求梳理、会议纪要、设计说明、代码评审、学习笔记等任务产物输出为可在浏览器直接打开的单文件 HTML,替代 Markdown 作为最终交付物。Markdown 在信息密度、视觉清晰度和可分享性上已跟不上 AI 产物的丰富度,HTML 能同时承载排版、表格、SVG 等。

    下载
    val retrofit = Retrofit.Builder()
     .baseUrl("https://api.example.com/")
     .addConverterFactory(GsonConverterFactory.create()) // 必须添加!
     .build()

    ⚠️ 若遗漏此行,或使用了其他不兼容的 Converter(如 Moshi、Jackson 但未正确配置),将导致解析失败。

  3. 接口方法保持简洁:

    interface ApiService {
     @GET("user/profile")
     suspend fun apiCall(@Header("Authorization") authorization: String): Response<ApiResponse>
    }

? 常见报错原因排查:

  • ❌ JsonParseException / Expected BEGIN_OBJECT but was STRING:说明响应不是合法 JSON,或服务器返回了 HTML 错误页(如 401/500 页面);
  • ❌ NullPointerException 在访问 response.body():检查是否调用 response.isSuccessful,且 response.body() 不为 null;
  • ❌ IllegalArgumentException: Unable to create converter:确认 GsonConverterFactory 已添加,且 gson 依赖已引入(如 com.squareup.retrofit2:converter-gson:2.9.0);
  • ❌ 字段名不匹配:JSON 中是 "id",Kotlin 中写成 val ID: String(大小写敏感),可加 @SerializedName("id") 显式映射:
    data class ApiResponse(
        @SerializedName("id") val id: String
    )

? 进阶建议:

  • 如需更严格控制(如禁止未知字段),可自定义 Gson 实例:
    val gson = GsonBuilder()
        .setLenient() // 允许 JSON 格式松散(如末尾逗号)
        .create()
    Retrofit.Builder().addConverterFactory(GsonConverterFactory.create(gson))
  • 对于空值字段(如 "xxx": null 或 "xxx": []),只要数据类中未声明该字段,Gson 完全无视;若声明了但类型不匹配(如声明 val xxx: String 却收到 null),则需改用可空类型 val xxx: String? —— 但本例中无需声明,故无需处理。

总结:你的原始实现逻辑完全正确。问题大概率出在 Retrofit 初始化缺失 Gson Converter、网络响应非预期格式,或混淆了 Response<ApiResponse> 与 ApiResponse 的使用方式。请优先检查日志中的具体异常栈信息,再对照上述要点逐一验证。

热门AI工具

更多
豆包大模型

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

WorkBuddy

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

DeepSeek

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

墨刀AI
墨刀AI Hot

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

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

蛙蛙写作

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

相关专题

更多
Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

371

2026.02.12

Java Kotlin协程与异步编程实战
Java Kotlin协程与异步编程实战

本专题围绕 Kotlin 协程与异步编程展开,讲解挂起函数、协程作用域、异步任务调度及并发控制方法。通过实际项目案例,帮助开发者提升后端服务性能,实现高效异步任务处理与稳定性保障。

159

2026.04.13

Kotlin Android开发教程大全
Kotlin Android开发教程大全

系统讲解 Google 官方推荐的 Android 开发首选语言 Kotlin 的核心知识与工程实践,涵盖 Kotlin 简洁语法(空安全/数据类/扩展函数/解构声明/作用域函数)与 Java 互操作、集合操作与函数式编程、协程(Coroutines)异步编程(suspend/launch/async/Flow)、Jetpack Compose 声明式 UI 开发(状态管理/组合函数/导航/动画)、MVVM / MVI 架构设计与 Vi

248

2026.06.03

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2115

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

3202

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

1076

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

3639

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

6219

2023.08.02

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

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

0

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 224人学习

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

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