Java 中怎么用 ResponseEntity 自定义 HTTP 状态码与响应头

千雪姑娘_4143

千雪姑娘_4143

2026-10-03

821人浏览

原创

responseentity是spring boot中最常用、最灵活的响应封装方式,支持控制http状态码、响应体和响应头;可通过静态工厂方法、builder模式、空响应体及异常处理器等方式灵活使用。

java 中怎么用 responseentity 自定义 http 状态码与响应头

在 Spring Boot 中,ResponseEntity 是最常用、最灵活的响应封装方式,它让你能同时控制 HTTP 状态码、响应体(body)和响应头(headers)。

直接构造 ResponseEntity 并设置状态码与头信息

最基础的方式是使用 ResponseEntity 的静态工厂方法(如 ok()、badRequest()、status()),再链式调用 header() 或 headers() 设置自定义响应头:

  • ResponseEntity.ok().header("X-App-Version", "2.1.0").body(data) → 返回 200 + 自定义头
  • ResponseEntity.status(HttpStatus.UNAUTHORIZED).header("WWW-Authenticate", "Bearer").body(Map.of("error", "token expired"))
  • 若需多个头,可用 headers() 传入 HttpHeaders 对象:
HttpHeaders headers = new HttpHeaders();
headers.add("X-Request-ID", UUID.randomUUID().toString());
headers.add("Cache-Control", "no-cache");
return ResponseEntity.status(HttpStatus.CREATED).headers(headers).body(result);

用 Builder 模式精细控制(推荐)

当逻辑稍复杂(比如动态判断状态码或头信息)时,用 ResponseEntity<t>.builder()</t> 更清晰、可读性更强:

Java Maven Code Review
Java Maven Code Review

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

下载
  • 先调用 status() 设定状态码(支持 HttpStatus 枚举或 int 值)
  • 再用 header() 或 headers() 添加头
  • 最后用 body() 或 build() 结束
return ResponseEntity
    .<user>builder()
    .status(user.isActive() ? HttpStatus.OK : HttpStatus.CONFLICT)
    .header("X-User-State", user.isActive() ? "active" : "pending")
    .body(user);</user>

返回空响应体但带状态码和头(如 204 No Content)

有些接口只需告知客户端操作结果,无需返回 JSON 数据。此时用 ResponseEntity<void></void> 或直接 ResponseEntity> :

  • return ResponseEntity.noContent().header("X-Processed-At", Instant.now().toString()).build();
  • return ResponseEntity.status(HttpStatus.ACCEPTED).header("Location", "/tasks/123").build();

注意:调用 build() 而非 body(null),避免 Jackson 尝试序列化 null 导致潜在问题。

配合异常统一处理返回自定义响应

实际项目中,常结合 @ControllerAdvice 和 @ExceptionHandler 统一包装错误响应。例如:

  • 抛出自定义异常(如 UserNotFoundException)
  • 在全局异常处理器中返回带状态码、头、结构化错误体的 ResponseEntity
@ExceptionHandler(UserNotFoundException.class)
public ResponseEntity<errorresponse> handleUserNotFound(UserNotFoundException e) {
    ErrorResponse error = new ErrorResponse("USER_NOT_FOUND", e.getMessage());
    return ResponseEntity
        .status(HttpStatus.NOT_FOUND)
        .header("X-Error-ID", UUID.randomUUID().toString())
        .body(error);
}</errorresponse>

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

9557

6

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

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

2023.07.05

6722

9

java自学难吗
java自学难吗

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

2023.07.31

5952

8

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

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

2023.08.01

1044

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

2509

5

java在线网站
java在线网站

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

2023.08.03

19851

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人学习