0

0

如何在 Retrofit 中自动解包 JSON 响应中的 items 数组字段

聖光之護

聖光之護

发布时间:2026-02-23 08:49:23

|

391人浏览过

|

来源于php中文网

原创

如何在 Retrofit 中自动解包 JSON 响应中的 items 数组字段

本文介绍一种基于 Gson TypeAdapterFactory 的专业方案,通过自定义反序列化逻辑,在 Retrofit 请求返回时自动提取嵌套的 items 数组,使 Call 直接映射到扁平化列表,无需额外包装类。

本文介绍一种基于 gson `typeadapterfactory` 的专业方案,通过自定义反序列化逻辑,在 retrofit 请求返回时自动提取嵌套的 `items` 数组,使 `call>` 直接映射到扁平化列表,无需额外包装类。

在使用 Retrofit + Gson 构建 Android 或 Java 后端客户端时,常遇到服务端统一返回类似如下结构的 JSON 响应:

{
  "items": [
    { "user_id": 1, "tags": { "role": "admin" } },
    { "user_id": 2, "tags": { "role": "user" } }
  ]
}

但业务层期望直接消费 List,而非 UserWrapper(含 items: List 字段)。若为每种资源都定义包装类(如 UserResponse, RepoResponse),不仅样板代码激增,还破坏了接口契约的简洁性——Call> 才是语义最清晰的声明。

Gson 提供了高度可扩展的类型适配机制,其中 TypeAdapterFactory 是实现条件化、上下文感知反序列化的理想入口。本文推荐的方案是:仅对顶层响应启用 items 解包,避免影响嵌套结构(如 User.repos: List,从而兼顾灵活性与安全性。

✅ 核心实现:线程安全的顶层解包工厂

以下是一个经过工程验证的 FlatteningTypeAdapterFactory 实现:

Amazon Nova
Amazon Nova

亚马逊云科技(AWS)推出的一系列生成式AI基础模型

下载
public final class FlatteningTypeAdapterFactory implements TypeAdapterFactory {
    public static final FlatteningTypeAdapterFactory INSTANCE = new FlatteningTypeAdapterFactory();

    private FlatteningTypeAdapterFactory() {}

    // 使用 ThreadLocal 避免多线程/递归调用干扰
    private static final ThreadLocal<Boolean> IS_TOP_LEVEL = ThreadLocal.withInitial(() -> true);

    @Override
    public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
        // ✅ 仅作用于顶层反序列化(如 Call<List<User>> 的响应体)
        if (!Boolean.TRUE.equals(IS_TOP_LEVEL.get())) {
            return null;
        }

        // 检查目标类型是否为参数化 List(如 List<User>)
        if (!(type.getRawType() == List.class && type.getType() instanceof ParameterizedType)) {
            return null;
        }

        // 获取泛型元素类型,如 User.class
        Type elementType = ((ParameterizedType) type.getType()).getActualTypeArguments()[0];
        TypeToken<?> elementToken = TypeToken.get(elementType);

        // 临时切换为嵌套调用模式,委托给默认适配器处理 items 内容
        IS_TOP_LEVEL.set(false);
        TypeAdapter<?> delegate = gson.getDelegateAdapter(this, elementToken);
        IS_TOP_LEVEL.set(true);

        return (TypeAdapter<T>) new TypeAdapter<List<?>>() {
            @Override
            public void write(JsonWriter out, List<?> value) throws IOException {
                throw new UnsupportedOperationException("Flattening adapter is read-only");
            }

            @Override
            public List<?> read(JsonReader in) throws IOException {
                in.beginObject();
                String key = in.nextName();
                if (!"items".equals(key)) {
                    throw new JsonParseException("Expected 'items' field, but got: " + key);
                }

                // ✅ 安全委托:此时 IS_TOP_LEVEL = false,避免二次解包
                List<Object> list = new ArrayList<>();
                in.beginArray();
                while (in.hasNext()) {
                    Object item = delegate.read(in);
                    list.add(item);
                }
                in.endArray();
                in.endObject();

                return list;
            }
        };
    }
}

? 关键设计说明

  • ThreadLocal IS_TOP_LEVEL 精确控制作用域,确保 User.tags.repos: List 不被误解包;
  • 显式校验 "items" 键名,增强健壮性;
  • 手动遍历 JsonReader 数组,比通用 delegate.read(in) 更可控(规避原方案中嵌套 isNestedCall 的潜在竞态)。

? Retrofit 集成方式

在构建 Retrofit 实例时,将该工厂注册至 GsonBuilder:

Gson gson = new GsonBuilder()
    .registerTypeAdapterFactory(FlatteningTypeAdapterFactory.INSTANCE)
    // 可选:添加其他配置,如日期格式、空值策略等
    .setDateFormat("yyyy-MM-dd HH:mm:ss")
    .create();

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.example.com/")
    .addConverterFactory(GsonConverterFactory.create(gson))
    .build();

随后,你的 API 接口可直接声明为:

interface ApiService {
    @GET("users")
    Call<List<User>> getUsers(); // ✅ 自动解包 items 数组

    @GET("repos")
    Call<List<Repo>> getRepos(); // ✅ 同理
}

⚠️ 注意事项与最佳实践

  • 不适用于非 items 字段名:若服务端字段名动态变化(如 data、results),需扩展工厂支持配置化键名,或改用 JsonDeserializer + 注解标记;
  • 禁止用于 @Body 请求:本工厂仅处理响应反序列化,请求体序列化不受影响;
  • 泛型兼容性:当前实现严格匹配 List,如需支持 Set 或自定义集合,需扩展类型判断逻辑;
  • 错误处理建议:生产环境应捕获 JsonParseException 并转换为统一业务异常(如 ApiDataException),便于全局错误监控;
  • 性能考量:ThreadLocal 开销极小,且仅在反序列化路径触发,实测千次调用耗时增加

✅ 总结

通过 TypeAdapterFactory 实现响应体自动解包,是一种零侵入、高内聚、可复用的架构优化手段。它消除了模板包装类,提升了 Retrofit 接口的语义表达力,同时借助 Gson 的类型系统保障了类型安全。对于存在统一响应封装规范的中大型项目,该方案值得作为标准基础设施纳入 SDK 层。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

445

2023.08.07

json是什么
json是什么

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

544

2023.08.23

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

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

322

2023.10.13

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

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

81

2025.09.10

java中boolean的用法
java中boolean的用法

在Java中,boolean是一种基本数据类型,它只有两个可能的值:true和false。boolean类型经常用于条件测试,比如进行比较或者检查某个条件是否满足。想了解更多java中boolean的相关内容,可以阅读本专题下面的文章。

364

2023.11.13

java boolean类型
java boolean类型

本专题整合了java中boolean类型相关教程,阅读专题下面的文章了解更多详细内容。

39

2025.11.30

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1605

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

463

2025.10.17

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

1030

2026.02.13

热门下载

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

精品课程

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

共101课时 | 9.5万人学习

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

共39课时 | 3.3万人学习

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

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