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

Spring MVC 中怎么统一包装 RESTful 风格响应结果

落强姑娘_9554

落强姑娘_9554

发布时间:2026-08-12 19:40:25

|

735人浏览过

|

来源于php中文网

原创

Spring MVC 中通过自定义 HandlerMethodReturnValueHandler 统一包装 RESTful 响应,使所有接口返回标准结构 {"code":200,"msg":"success","data":{...}};配合 @ControllerAdvice 全局异常处理,确保成功与错误响应格式一致。

spring mvc 中怎么统一包装 restful 风格响应结果

在 Spring MVC 中统一包装 RESTful 响应结果,核心目标是让所有接口返回结构一致(如 {"code":200,"msg":"success","data":{...}}),避免每个 Controller 方法手动封装,同时兼顾可读性、可维护性和前后端协作效率。

定义标准响应类

先创建一个通用的响应包装类,通常包含状态码、提示信息和业务数据三部分:

  • 字段建议用 Integer code、String msg、T data,泛型支持任意类型返回值
  • 提供静态工厂方法,如 Result.success(data) 和 Result.failure("xxx"),调用简洁
  • 实体类加 @Getter(Lombok)或完整 getter,确保 Jackson 能正常序列化
  • 可选:加 @JsonInclude(JsonInclude.Include.NON_NULL) 避免空字段出现在 JSON 中

控制器层直接返回业务对象

使用 @RestController 标注类后,方法默认返回 JSON。此时不直接返回 Result,而是返回原始业务对象(如 User、List<Order>),把包装逻辑后置:

  • 例如:@GetMapping("/{id}") public User getUser(@PathVariable Long id) { return userService.getById(id); }
  • 这样写更专注业务,Controller 不掺杂响应格式逻辑
  • 后续通过拦截器或返回值处理器统一套壳,解耦清晰

用 HandlerMethodReturnValueHandler 自动包装

这是最推荐的统一处理方式,Spring MVC 提供了扩展点,在 Controller 方法执行完、写入响应前自动包装返回值:

  • 实现 HandlerMethodReturnValueHandler 接口,判断返回类型是否为业务类(非 String、ResponseEntity、Void 等)
  • 若符合,则构造 Result.success(returnValue) 并替换原返回值
  • 注册该处理器时,需放在默认处理器之前(通过 WebMvcConfigurer.addReturnValueHandlers())
  • 优点:零侵入、全局生效、无需修改任何 Controller 代码

配合全局异常处理保持一致性

包装只解决“成功”路径,异常情况也要返回同样结构:

  • 用 @ControllerAdvice + @ExceptionHandler 捕获常见异常(如 IllegalArgumentException、自定义业务异常)
  • 每个异常处理器都返回 Result.failure(...),确保错误响应也带 code 和 msg
  • 对未捕获的异常,可设兜底处理器返回 Result.failure("系统繁忙"),code 设为 500
  • 注意:HTTP 状态码仍应匹配语义(如 404 返回 HttpStatus.NOT_FOUND),可用 ResponseEntity<Result> 控制

热门AI工具

更多
咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Loomy
Loomy Hot

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

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

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

豆包大模型

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2571

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

477

2026.01.26

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

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

60

2026.10.16

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

40

2026.10.16

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

40

2026.10.16

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

20

2026.10.16

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

20

2026.10.16

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

20

2026.10.16

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

40

2026.10.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

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