REST接口开发中怎么返回统一的 JSON 响应格式

冬涛大大_2439

冬涛大大_2439

2026-10-01

125人浏览

原创

统一rest响应需定义result类封装code、msg、data,并用@restcontrolleradvice通过responsebodyadvice自动包装正常返回、exceptionhandler统一处理异常,确保所有接口返回结构一致且符合http规范。

rest接口开发中怎么返回统一的 json 响应格式

REST接口返回统一JSON格式,核心是让所有成功响应和异常响应都走同一套结构,避免前端反复适配不同字段名或嵌套层级。关键不在“怎么写JSON”,而在于“怎么让所有出口自动套上这个壳”。

定义清晰的响应体结构

先约定一个通用Java类,比如叫 Result,包含三个固定字段:

  • code:业务状态码(不是HTTP状态码),比如200表示成功,400表示参数错误,500表示系统异常
  • msg:可读提示信息,如“操作成功”“用户名已存在”
  • data:泛型数据体,支持返回任意对象、列表或null

配合一个枚举类 ResultCode 管理常用码值和描述,避免硬编码字符串和数字。

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载

用 @RestControllerAdvice 统一包装正常返回

写一个全局响应增强器,实现 ResponseBodyAdvice 接口:

  • 在 beforeBodyWrite 方法中拦截所有 @RestController 的返回值
  • 若原返回已是 Result 类型,直接放行;否则自动包装成 Result.success(原数据)
  • 这样 Controller 里只需写 return user;,框架自动转成 {"code":200,"msg":"成功","data":{...}}

用 @ExceptionHandler 拦截并格式化异常

同样在同一个 @RestControllerAdvice 类中添加异常处理器:

  • 捕获 NoHandlerFoundException(404)、HttpRequestMethodNotSupportedException(405)、自定义业务异常等
  • 根据异常类型设置对应 code 和 msg,例如 404 → code=404, msg="请求地址不存在"
  • 务必开启配置 spring.mvc.throw-exception-if-no-handler-found=true,否则404不会进你的异常处理器

确保 HTTP 头正确且内容合法

统一格式只是第一步,客户端能否正确解析还取决于响应头和JSON语法:

  • Spring Boot 默认已设 Content-Type: application/json,无需额外操作
  • 但要注意:如果返回空对象或含中文字段,需确认 Jackson 配置支持 UTF-8(一般默认已支持)
  • 避免在 Controller 中手动 response.getWriter().write(...),会绕过统一处理机制

相关文章

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

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

下载

相关标签:

java js json

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

相关专题

更多
java
java

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

2023.06.15

9457

6

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

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

2023.07.05

6602

9

java自学难吗
java自学难吗

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

2023.07.31

5872

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2489

5

java在线网站
java在线网站

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

2023.08.03

19831

3

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

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

2023.08.03

1115

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习