Spring Boot 中如何通过单个 API 接口返回多个不同类型的响应数据

云晨同学_2711

云晨同学_2711

2026-04-03

631人浏览

原创

在 spring boot 中,可通过自定义封装类统一返回多种类型数据(如 list 和 object),避免多次请求,提升接口设计的简洁性与前端调用效率。

在 spring boot 中,可通过自定义封装类统一返回多种类型数据(如 list 和 object),避免多次请求,提升接口设计的简洁性与前端调用效率。

在实际开发中,常遇到一个业务场景:根据 ID 查询订单详情的同时,还需关联获取多个快递信息(如历史配送记录)。此时若强行拆分为两个独立接口(如 /order/{id} 和 /couriers/{id}),不仅增加前端调用复杂度,还可能引发并发、时序或数据一致性问题。更优雅的方案是——将异构数据统一聚合到一个响应体中,通过单个 RESTful 接口返回。

✅ 正确实现方式:定义响应封装类

首先,创建一个 POJO 类(例如 SearchResponse),用于承载所有需返回的数据字段。注意:由于问题中提到需返回 List(而非单个 Courier),原答案中的 private Courier courier; 存在偏差,应修正为 private List couriers;:

public class SearchResponse {
    private OrderRelatedInfo order;
    private List<courier> couriers;

    // 全参构造(便于 ResponseEntity 构建)
    public SearchResponse(OrderRelatedInfo order, List<courier> couriers) {
        this.order = order;
        this.couriers = couriers;
    }

    // 必备:无参构造(Jackson 序列化所需)
    public SearchResponse() {}

    // Getter & Setter(Lombok 可简化为 @Data)
    public OrderRelatedInfo getOrder() { return order; }
    public void setOrder(OrderRelatedInfo order) { this.order = order; }

    public List<courier> getCouriers() { return couriers; }
    public void setCouriers(List<courier> couriers) { this.couriers = couriers; }
}</courier></courier></courier></courier>

✅ 控制器层:使用 ResponseEntity 返回

在 Controller 方法中,构造并返回该封装对象。推荐显式使用 ResponseEntity.ok(),既语义清晰,又便于后续扩展状态码或响应头:

@GetMapping("/search/{id}")
public ResponseEntity<searchresponse> search(@PathVariable String id) {
    // 模拟业务逻辑:查询订单与快递列表
    OrderRelatedInfo order = orderService.findById(id);
    List<courier> couriers = courierService.findByOrderId(id);

    // 封装并返回
    SearchResponse response = new SearchResponse(order, couriers);
    return ResponseEntity.ok(response);
}</courier></searchresponse>

? 提示:无需额外添加 @ResponseBody(Spring Boot 2.6+ 默认启用),且方法返回类型建议明确为 ResponseEntity,而非泛型模糊的 ResponseBody<...>(该写法在 Spring 中并不存在,属原文笔误)。

⚠️ 注意事项与最佳实践

  • 命名规范:避免使用 Output 或 Result 等泛化后缀,推荐采用语义化名称如 SearchResponse,体现接口用途;
  • 空值安全:若某字段可能为空(如未查到订单),建议在封装前做判空处理,或使用 Optional + 自定义序列化策略;
  • 性能考量:确保 courierService.findByOrderId(id) 是高效查询(如走索引),避免 N+1 查询问题;
  • 前端兼容性:JSON 响应结构清晰,前端可直接解构:response.order.id、response.couriers[0].trackingNo;
  • 扩展性预留:后续如需增加“物流轨迹”或“支付信息”,只需在 SearchResponse 中新增字段,保持接口契约稳定。

通过这种封装模式,你不仅实现了单一接口承载多维业务数据的目标,更践行了 REST API 设计中「资源聚合」与「客户端友好」的核心原则。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10217

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7342

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6452

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1104

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

908

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1336

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2689

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20011

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习