Java 中怎么使用 ResponseEntity 自定义 REST 接口响应状态码

风萱大大_8780

风萱大大_8780

2026-11-01

738人浏览

原创

ResponseEntity 是 Spring Boot 中最常用且灵活的响应封装方式,可精确控制 HTTP 状态码、响应头和响应体;推荐使用 HttpStatus 枚举而非数字状态码,并结合 HttpHeaders 添加自定义头,异常处理应通过 @ControllerAdvice 统一返回 ResponseEntity。

java 中怎么使用 responseentity 自定义 rest 接口响应状态码

在 Java 的 Spring Boot 项目中,ResponseEntity 是最常用、最灵活的响应封装方式,它允许你**精确控制 HTTP 状态码、响应头和响应体**,而不仅限于默认的 200 OK。

直接返回 ResponseEntity 包裹的数据和状态码

这是最常见也最推荐的方式:用 ResponseEntity.ok()、ResponseEntity.status() 或构造器显式指定状态码。

  • ResponseEntity.ok(data) → 返回 200 OK + 数据
  • ResponseEntity.status(HttpStatus.CREATED).body(data) → 返回 201 Created + 数据
  • ResponseEntity.badRequest().body("参数错误") → 返回 400 Bad Request + 错误信息
  • ResponseEntity.status(422).body(map) → 自定义非标准状态码(如 422 Unprocessable Entity)

配合 HttpStatus 枚举提升可读性和类型安全

Spring 提供了完整的 HttpStatus 枚举,建议优先使用它而不是硬写数字,避免拼写/数值错误,也便于后期维护。

Java 接口排错助手
Java 接口排错助手

在调试 Java 后端 API 故障时使用此技能,尤其适用于以下任务:分析日志、跨 Controller、Service 和 Mapper 层追踪请求、定位异常根因、检查 SQL 执行或参数流转,以及生成简洁的诊断结论与修复方案。

下载
  • 不推荐:ResponseEntity.status(404).body("未找到")
  • 推荐:ResponseEntity.status(HttpStatus.NOT_FOUND).body("用户不存在")
  • 常见枚举值:OK、CREATED、NO_CONTENT、BAD_REQUEST、NOT_FOUND、UNAUTHORIZED、FORBIDDEN、INTERNAL_SERVER_ERROR

添加自定义响应头(如 Location、X-Total-Count)

当需要返回额外元数据时(比如新建资源后的 URL、分页总数),可用 HttpHeaders 构建完整响应。

  • 例如创建用户后返回 Location 头:
    HttpHeaders headers = new HttpHeaders();<br>
      headers.setLocation(URI.create("/api/users/123"));<br>
      return ResponseEntity.created(headers.getLocation()).headers(headers).body(user);
  • 分页接口中带总数:
    headers.set("X-Total-Count", String.valueOf(total));<br>
      return ResponseEntity.ok().headers(headers).body(list);

统一异常处理中结合 ResponseEntity 使用

不要在每个 Controller 方法里手动写 4xx/5xx 响应。推荐用 @ControllerAdvice + @ExceptionHandler 统一拦截异常并包装为 ResponseEntity。

  • 例如捕获业务异常:
    @ExceptionHandler(UserNotFoundException.class)<br>
      public ResponseEntity<string> handleUserNotFound(UserNotFoundException e) {<br>
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(e.getMessage());<br>
      }</string>
  • 这样 Controller 层只关注正常流程,异常响应逻辑集中、一致、易测试

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

相关文章

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

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

下载

相关标签:

java 状态码

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

相关专题

更多
java
java

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

2023.06.15

11657

6

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

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

2023.07.05

8782

9

java自学难吗
java自学难吗

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

2023.07.31

7532

8

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

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

2023.08.01

1244

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1496

5

java有什么用
java有什么用

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

2023.08.02

3049

5

java在线网站
java在线网站

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

2023.08.03

20311

3

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

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

2023.08.03

1335

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习