Java 中怎么在 REST 接口中使用 @ResponseStatus 声明特定业务状态码

雨敏同学_3874

雨敏同学_3874

2026-11-06

885人浏览

原创

@ResponseStatus用于声明式指定HTTP状态码,适用于状态码固定场景:可标注在控制器方法(如201创建成功)或自定义异常类上,配合@ExceptionHandler统一处理响应体;不支持动态状态码,此时应使用ResponseEntity。

java 中怎么在 rest 接口中使用 @responsestatus 声明特定业务状态码

在 Java 的 Spring REST 接口中,@ResponseStatus 可用于直接为控制器方法或异常类指定 HTTP 状态码,无需手动设置 ResponseEntity 或操作 HttpServletResponse。它简洁、声明式,适合业务逻辑明确、状态码固定的场景。

在 Controller 方法上直接标注状态码

适用于成功响应中需返回非 200 的标准状态码(如创建成功用 201、无内容用 204):

  • 方法返回值可以是 void、对象或 ResponseEntity(但若用了 @ResponseStatus,再返回 ResponseEntity 会以后者为准,前者被忽略)
  • 状态码必须是 HttpStatus 枚举中的合法值,推荐使用枚举而非数字,提升可读性与类型安全

示例:

Java调试
Java调试

通过 JDWP 实现 Java 远程调试:连接远程 JVM、设置断点、单步执行代码、查看变量值、获取调用栈。适用于需要调试远程 Java 应用、排查运行时状态、追踪代码执行流程的场景。 术语注解 JDWP:Java Debug Wire Protocol,Java 调试有线协议(Java 远程调试底层通信协议) remote JVM:远程 Java 虚拟机 step through code:代码单步调试(步入 / 步过 / 步出调试) inspect variables:变量查看 / 变量检视 stac

下载
@PostMapping("/users")
@ResponseStatus(HttpStatus.CREATED)
public User createUser(@RequestBody User user) {
    return userService.save(user);
}

配合自定义业务异常统一返回错误码

更常见也更推荐的做法:将 @ResponseStatus 标在自定义异常类上,再在控制器中抛出该异常。Spring 会自动将其映射为对应状态码的响应,并可结合 @ExceptionHandler 增强响应体(如添加错误信息):

  • 异常类本身不处理响应体,只负责“声明状态码”
  • 实际响应内容(JSON 错误结构)由全局异常处理器(@ControllerAdvice + @ExceptionHandler)统一组织

示例:

@ResponseStatus(HttpStatus.BAD_REQUEST)
public class InvalidUserException extends RuntimeException {
    public InvalidUserException(String message) {
        super(message);
    }
}

@RestController
public class UserController {
    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        if (user.getEmail() == null) {
            throw new InvalidUserException("Email is required");
        }
        return userService.save(user);
    }
}

注意与 @ExceptionHandler 的协作关系

@ResponseStatus 和 @ExceptionHandler 可共存,但作用不同:

  • @ResponseStatus 在异常类上:告诉 Spring “这个异常默认应返回什么 HTTP 状态码”
  • @ExceptionHandler 在处理器方法中:决定“这个异常具体返回什么响应体(如 JSON 字段、日志、兜底逻辑)”
  • 若两者都存在,状态码以异常类上的 @ResponseStatus 为准;响应体以 @ExceptionHandler 返回的内容为准

典型组合:

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(InvalidUserException.class)
    public ResponseEntity<errorresponse> handleInvalidUser(InvalidUserException e) {
        ErrorResponse error = new ErrorResponse("VALIDATION_FAILED", e.getMessage());
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(error);
    }
}</errorresponse>

不适用的场景要避免

@ResponseStatus 是静态声明,无法动态计算状态码(比如根据参数值返回 404 或 409)。此时必须改用 ResponseEntity:

  • 需要根据运行时条件选择不同状态码
  • 需要同时设置状态码、响应头和响应体(如带 Location 头的 201 响应)
  • 需要覆盖默认状态码(例如某个异常通常 500,但某次调用想返回 409)

替代写法示例:

@GetMapping("/users/{id}")
public ResponseEntity<user> getUser(@PathVariable Long id) {
    User user = userService.findById(id);
    if (user == null) {
        return ResponseEntity.notFound().build();
    }
    return ResponseEntity.ok(user);
}</user>

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

相关专题

更多
java
java

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

2023.06.15

12017

6

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

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

2023.07.05

9102

9

java自学难吗
java自学难吗

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

2023.07.31

7792

8

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

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

2023.08.01

1264

3

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

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

2023.08.02

1028

3

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

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

2023.08.02

1516

5

java有什么用
java有什么用

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

2023.08.02

3149

5

java在线网站
java在线网站

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

2023.08.03

20391

3

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

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

2023.08.03

1375

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习