当前位置:

首页 > 编程开发 > Quarkus REST API 返回 JSON 无数组包装方法

Quarkus REST API 返回 JSON 无数组包装方法

本文档旨在解决在使用Quarkus构建RESTAPI时,由于返回Multi<String>类型并指定APPLICATION_JSON媒体类型,导致响应被额外数组包装的问题。通过使用@Stream(Stream.MODE.RAW)注解,可以有效地避免这种不必要的包装,并理解其对响应格式和数据流处理的影响。

本文目录

    Quarkus REST API 返回 JSON 时避免额外的数组包装

    正如摘要所述,本文档旨在解决在使用 Quarkus 构建 REST API 时,由于返回 Multi 类型并指定 APPLICATION_JSON 媒体类型,导致响应被额外数组包装的问题。我们将探讨如何通过使用 @Stream(Stream.MODE.RAW) 注解来避免这种不必要的包装,并理解其对响应格式和数据流处理的影响。

    问题描述

    在使用 Quarkus 开发 REST API 时,如果使用 Multi 作为返回类型,并指定 APPLICATION_JSON 作为 Produces 的媒体类型,可能会遇到一个问题:即使返回的是有效的 JSON 字符串,Quarkus 也会自动将响应包装在一个额外的数组中。例如,以下代码:

    @Path("/testData")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    public Multi test() throws IOException {
        return Multi.createFrom().items(IOUtils.toString(getClass().getResourceAsStream("/TestJSON.json"), StandardCharsets.UTF_8));
    }

    如果 /TestJSON.json 文件包含以下 JSON 内容:

    {
      "isA": "customerDocument",
      "createdOn": "2022-10-10T12:29:43",
      "customerBody": {
        "customerList": [
          {
            "name": "Batman",
            "age": 45,
            "city": "gotham"
          }
        ]
      }
    }

    实际返回的响应将会是:

    [
      {
        "isA": "customerDocument",
        "createdOn": "2022-10-10T12:29:43",
        "customerBody": {
          "customerList": [
            {
              "name": "Batman",
              "age": 45,
              "city": "gotham"
            }
          ]
        }
      }
    ]

    可以看到,JSON 对象被包裹在一个数组中,这通常不是我们期望的结果。

    解决方案

    解决这个问题的方法是使用 @Stream(Stream.MODE.RAW) 注解。将该注解添加到 REST API 方法上,可以指示 Resteasy(Quarkus 使用的 REST 实现)直接将每个值写入到输出流,而无需进行任何格式化。

    修改后的代码如下:

    @Path("/testData")
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    @Stream(Stream.MODE.RAW)
    public Multi test() throws IOException {
        return Multi.createFrom().items(IOUtils.toString(getClass().getResourceAsStream("/TestJSON.json"), StandardCharsets.UTF_8));
    }

    添加 @Stream(Stream.MODE.RAW) 注解后,返回的响应将不再包含额外的数组包装,而是直接返回 /TestJSON.json 文件中的 JSON 内容。

    原理解释

    根据 Resteasy 的文档,当 REST API 方法没有使用 @Stream 注解时,Resteasy 会收集 Multi 发出的所有值,然后将它们包装到一个 java.util.List 实体中,并将其发送给客户端。这就是为什么响应会被额外的数组包装的原因。

    @Stream(Stream.MODE.RAW) 注解改变了这种行为。它指示 Resteasy 直接将每个值写入到输出流,而无需等待 Multi 完成。这不仅避免了额外的数组包装,还可能影响数据的流处理方式。

    注意事项

    使用 @Stream(Stream.MODE.RAW) 注解时,需要注意以下几点:

    • 数据格式: 确保 Multi 发出的每个值都是有效的 JSON 字符串,因为 Resteasy 不会进行任何格式化。
    • 流处理: @Stream(Stream.MODE.RAW) 注解会改变数据的流处理方式。如果没有该注解,Resteasy 会等待 Multi 完成,然后一次性发送所有数据。使用该注解后,Resteasy 会立即发送每个值。这可能会影响性能,具体取决于数据的生成速度和网络带宽。
    • 适用场景: @Stream(Stream.MODE.RAW) 注解最适合用于处理可以被分割成小块的数据,例如字符串、字节或缓冲区。

    总结

    通过使用 @Stream(Stream.MODE.RAW) 注解,可以有效地解决 Quarkus REST API 返回 Multi 类型并指定 APPLICATION_JSON 媒体类型时,响应被额外数组包装的问题。在使用该注解时,需要注意其对数据格式和流处理方式的影响,并根据实际情况选择合适的方案。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    Nod 0.8.1怎样理解状态码、Ray ID与计划检查
    Nod 0.8.1怎样理解状态码、Ray ID与计划检查

    Nod 0.8.1补充连接服务状态与原因、Attio Cloudflare 403诊断,并让Gmail在连接服务429或503后延后计划轮询。

    Ducter 0.0.59如何理解同会话聊天、Git可选和附件变化
    Ducter 0.0.59如何理解同会话聊天、Git可选和附件变化

    Ducter 0.0.59扩展Telegram、Slack和Mac iMessage会话,区分项目目录来源、Git可选、等待状态与附件入口。

    llama.cpp b12435、b12436、b12438测试构建的三类兼容变化有什么区别?
    llama.cpp b12435、b12436、b12438测试构建的三类兼容变化有什么区别?

    llama.cpp b12435、b12436、b12438预发布构建,分别解释Vulkan并列选择确定性、32位编译与Jinja JSON键排序的适用范围。

    ScopeWeaver 0.9.2、0.9.3与0.9.4如何区分运行时、Zod和任务状态变化
    ScopeWeaver 0.9.2、0.9.3与0.9.4如何区分运行时、Zod和任务状态变化

    ScopeWeaver 0.9.2、0.9.3与0.9.4分别调整桥运行时、Zod依赖和同进程服务器重建后的暂停状态;区分版本对象与作者本地研究用途声明。

    AG2 1.3.2的输入Token为何变多,旧ACP版本还能用吗
    AG2 1.3.2的输入Token为何变多,旧ACP版本还能用吗

    AG2 1.3.2统一缓存Token统计并更新ACP1.x依赖;解释预算提前触达、报表口径与Python3.15构建限制。

    llama.cpp b12433怎样为AMD奇数列保留MUL_MAT_ID回退路径
    llama.cpp b12433怎样为AMD奇数列保留MUL_MAT_ID回退路径

    llama.cpp b12433避免AMD设备将奇数src0列送入需要偶数列的MMVF路径:满足偶数条件才保留MMVF,其他形状沿用既有回退。对应改动发生在MUL_MAT_ID处理和相关同步判断中,范围限定于代码说明中的类型与token条件。

    Ducter 0.0.58如何区分下一步消息、完成后消息与后台会话
    Ducter 0.0.58如何区分下一步消息、完成后消息与后台会话

    Ducter 0.0.58调整任务阅读、执行中消息和后台会话,区分下一步发送与做完再说,并说明tailnet HTTPS辅助的条件。

    Unlimited OCR 2在TextMind能否直接使用,账号权限与模型示例如何区分
    Unlimited OCR 2在TextMind能否直接使用,账号权限与模型示例如何区分

    Unlimited OCR 2官方确认百度智能云TextMind渠道;区分云端入口、账号权限配额与本地模型部署,避免混淆接口和计费条件。

    TensorFold 1.2.9的Ollama接口和服务配置文件怎么用
    TensorFold 1.2.9的Ollama接口和服务配置文件怎么用

    TensorFold 1.2.9的服务配置文件用于保存和复用启动参数,Ollama兼容API则在同一推理路径上提供聊天、生成和模型查询等接口。理解配置优先级及后端限制,比只看到“兼容”就直接迁移全部流量更有用。

    如何理解Univer 1.5.2的二次混淆移除与构建边界?
    如何理解Univer 1.5.2的二次混淆移除与构建边界?

    理解Univer 1.5.2的关键,是把额外混淆与构建压缩分开。本版删除二次混淆插件及相关配置,同时保留Pro模块的minify设置;它解释的是产物处理方式的变化,不代表增加了表格或公式能力。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。