0

0

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

碧海醫心

碧海醫心

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

|

361人浏览过

|

来源于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(关键!):

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

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

    360智图
    360智图

    AI驱动的图片版权查询平台

    下载
  3. 接口方法保持简洁

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

? 常见报错原因排查

  • ❌ 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 的使用方式。请优先检查日志中的具体异常信息,再对照上述要点逐一验证。

相关专题

更多
json数据格式
json数据格式

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

406

2023.08.07

json是什么
json是什么

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

531

2023.08.23

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

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

309

2023.10.13

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

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

74

2025.09.10

html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

603

2023.06.14

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

643

2023.06.21

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

465

2023.07.31

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

245

2023.08.01

java学习网站推荐汇总
java学习网站推荐汇总

本专题整合了java学习网站相关内容,阅读专题下面的文章了解更多详细内容。

6

2026.01.08

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

AngularJS教程
AngularJS教程

共24课时 | 2.4万人学习

CSS教程
CSS教程

共754课时 | 18.2万人学习

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

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