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

小婷同学_4650

小婷同学_4650

2026-10-03

827人浏览

原创

java rest接口统一json响应需定义泛型result类(含code、message、data、timestamp)、@controlleradvice全局异常处理、controller中统一返回result,并配置jackson序列化规则。

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

在 Java 的 REST 接口中返回统一的 JSON 响应格式,核心是**定义一个通用响应体类 + 全局异常处理 + 统一返回封装**,避免每个接口手动拼 JSON 或重复写状态码、消息、数据字段。

定义统一响应结果类(Result)

创建一个泛型类,包含标准字段:状态码(code)、提示信息(message)、业务数据(data)、时间戳(timestamp)等:

  • code:约定成功为 200,参数错误 400,未授权 401,服务器异常 500 等
  • message:对前端友好的简明提示,如 "操作成功"、"用户不存在"
  • data:泛型 T,支持返回任意类型对象或 null(如删除接口可不返回数据)
  • 建议添加静态工厂方法,如 success()、fail(int code, String msg),简化调用

用 @ControllerAdvice + @ResponseBody 统一拦截异常

通过全局异常处理器捕获运行时异常、参数校验异常(如 @Valid 触发的 MethodArgumentNotValidException)、自定义业务异常等,并统一转为 Result 响应:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 用 @ExceptionHandler 分别处理不同异常类型
  • 对 MethodArgumentNotValidException,提取第一个校验失败的 message,避免返回整个错误列表
  • 对自定义异常(如 BusinessException),直接取其 code 和 message 构建 Result
  • 对未捕获的 Exception,记录日志并返回 500 错误,避免暴露堆栈给前端

在 Controller 中统一使用 Result 封装返回

所有接口方法返回类型设为 Result<t></t>,不再直接返回实体或 void:

  • 查询单个用户:return Result.success(user);
  • 无返回值操作(如删除):return Result.success();(data 为 null)
  • 校验失败或业务拒绝:return Result.fail(400, "手机号格式不正确");
  • 配合 Lombok 的 @Data 和静态构造方法,代码简洁且语义清晰

可选:配合 Spring Boot 的 WebMvcConfigurer 统一处理空值与日期格式

确保 JSON 序列化行为一致,提升前端解析稳定性:

  • 配置 Jackson,忽略 null 字段(JsonInclude.Include.NON_NULL)
  • 统一日期格式,如 @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") 或全局配置
  • 启用 WRITE_DATES_AS_TIMESTAMPS = false,避免时间戳数字形式

不复杂但容易忽略的是:前后端要提前约定好 code 含义和 message 风格(比如是否含标点、是否小写开头),并在文档或 Swagger 中体现。这样一套机制下来,接口响应结构干净,异常可控,前端也容易做统一 loading 和错误提示。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

9677

6

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

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

2023.07.05

6822

9

java自学难吗
java自学难吗

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

2023.07.31

6032

8

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

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

2023.08.01

1064

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

1276

5

java有什么用
java有什么用

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

2023.08.02

2529

5

java在线网站
java在线网站

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

2023.08.03

19871

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习