当前位置： 首页 > news >正文

Spring Boot 中修改 HTTP 响应状态码（即 `response.status`）可以通过以下几种方式实现

news 来源：原创 2025/5/25 5:30:45

以下是不同场景下的具体方法：

方法 1：直接使用 @ResponseStatus 注解

在 Controller 方法或异常类上使用 @ResponseStatus 注解，直接指定返回的状态码。

场景示例：固定返回指定状态码
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyController {// 成功创建资源时返回 201@PostMapping("/create")@ResponseStatus(HttpStatus.CREATED) // 状态码 201public String createResource() {return "Resource created";}
}

方法 2：动态返回 ResponseEntity 对象

通过 ResponseEntity 对象在代码中动态控制状态码，适用于需要根据业务逻辑返回不同状态码的场景。

场景示例：根据条件返回不同状态码
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyController {@GetMapping("/user/{id}")public ResponseEntity<String> getUser(@PathVariable Long id) {if (id == 1) {return ResponseEntity.ok("User found"); // 默认 200} else {return ResponseEntity.status(HttpStatus.NOT_FOUND).body("User not found"); // 404}}
}

方法 3：通过全局异常处理统一修改状态码

使用 @ControllerAdvice 和 @ExceptionHandler 拦截异常并统一设置状态码。

场景示例：资源不存在时返回 404
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import javax.persistence.EntityNotFoundException;@ControllerAdvice
public class GlobalExceptionHandler {// 捕获 EntityNotFoundException 并返回 404@ExceptionHandler(EntityNotFoundException.class)@ResponseStatus(HttpStatus.NOT_FOUND)public String handleEntityNotFound() {return "Resource not found";}
}

方法 4：直接操作 HttpServletResponse

在 Controller 方法中注入 HttpServletResponse 对象，直接设置状态码。

场景示例：手动设置状态码
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class MyController {@GetMapping("/manual")public String manualStatus(HttpServletResponse response) {response.setStatus(HttpStatus.ACCEPTED.value()); // 状态码 202return "Status manually set";}
}

常见场景与状态码对照表

场景推荐状态码说明
成功200 OK默认成功状态码
创建资源成功201 Created配合 @PostMapping 使用
请求参数错误400 Bad Request客户端请求错误
未授权访问401 Unauthorized需要身份验证
禁止访问403 Forbidden无权限访问资源
资源不存在404 Not Found请求的资源不存在
服务器内部错误500 Internal Error未捕获的异常导致服务器错误

注意事项

  1. 优先级问题
    ResponseEntity 的优先级高于 @ResponseStatus，如果二者同时存在，以 ResponseEntity 为准。

  2. 直接操作 HttpServletResponse 的限制
    如果在设置状态码后修改响应体，可能导致 IllegalStateException，建议优先使用 Spring 提供的抽象（如 ResponseEntity）。

  3. 全局异常处理的覆盖范围
    通过 @ControllerAdvice 可以统一处理所有 Controller 抛出的异常，适合集中管理错误状态码。

通过上述方法，你可以根据具体场景灵活控制 HTTP 响应的状态码。推荐优先使用 ResponseEntity 或 @ResponseStatus 保持代码简洁。
以下是结合自定义返回工具类与 Spring Boot 状态码控制的详细方案，提供代码示例和分步说明：

1. 定义统一返回结果工具类

public class ApiResponse<T> {private int code;       // 业务状态码（非 HTTP 状态码）private String message; // 提示信息private T data;         // 返回数据// 快速创建成功响应（静态工厂方法）public static <T> ApiResponse<T> success(T data) {return new ApiResponse<>(200, "Success", data);}// 快速创建失败响应（链式调用支持）public static ApiResponse<Void> failure(int code, String message) {return new ApiResponse<>(code, message, null);}public ApiResponse<T> code(int code) {this.code = code;return this;}public ApiResponse<T> message(String message) {this.message = message;return this;}// 构造方法、Getter 省略...
}

2. 与状态码控制方法结合使用

场景 1：固定状态码 + 统一数据结构（@ResponseStatus）
@PostMapping("/users")
@ResponseStatus(HttpStatus.CREATED) // 强制 HTTP 201
public ApiResponse<User> createUser(@RequestBody User user) {User savedUser = userService.save(user);return ApiResponse.success(savedUser).message("User created successfully");
}
场景 2：动态状态码 + 统一数据结构（ResponseEntity）
@GetMapping("/products/{id}")
public ResponseEntity<ApiResponse<Product>> getProduct(@PathVariable Long id) {return productService.findById(id).map(product -> ResponseEntity.ok(ApiResponse.success(product)) // HTTP 200).orElseGet(() -> ResponseEntity.status(HttpStatus.NOT_FOUND).body(ApiResponse.failure(404, "Product not found")));
}

3. 全局异常处理统一包装结果

@ControllerAdvice
public class GlobalExceptionHandler {// 处理业务异常（HTTP 400 + 自定义错误码）@ExceptionHandler(BusinessException.class)public ResponseEntity<ApiResponse<Void>> handleBusinessException(BusinessException ex) {return ResponseEntity.badRequest() // HTTP 400.body(ApiResponse.failure(ex.getCode(), ex.getMessage()));}// 处理资源不存在（HTTP 404）@ExceptionHandler(ResourceNotFoundException.class)public ResponseEntity<ApiResponse<Void>> handleResourceNotFound(ResourceNotFoundException ex) {return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ApiResponse.failure(404, ex.getMessage()));}// 兜底异常处理（HTTP 500）@ExceptionHandler(Exception.class)public ResponseEntity<ApiResponse<Void>> handleGlobalException(Exception ex) {return ResponseEntity.internalServerError().body(ApiResponse.failure(500, "Internal server error"));}
}

4. 进阶工具类（支持链式设置 HTTP 状态码）

public class ApiResponseBuilder<T> {private HttpStatus httpStatus = HttpStatus.OK; // 默认 200private ApiResponse<T> apiResponse;private ApiResponseBuilder(ApiResponse<T> apiResponse) {this.apiResponse = apiResponse;}public static <T> ApiResponseBuilder<T> success(T data) {return new ApiResponseBuilder<>(ApiResponse.success(data));}public ApiResponseBuilder<T> httpStatus(HttpStatus status) {this.httpStatus = status;return this;}public ResponseEntity<ApiResponse<T>> build() {return ResponseEntity.status(httpStatus).body(apiResponse);}
}// 使用示例
@PostMapping("/orders")
public ResponseEntity<ApiResponse<Order>> createOrder() {Order newOrder = orderService.create();return ApiResponseBuilder.success(newOrder).httpStatus(HttpStatus.CREATED) // 设置 HTTP 201.build();
}

5. 关键注意事项

  1. 明确区分两类状态码

    • HTTP 状态码：描述网络请求结果（200/404/500）
    • 业务状态码：描述业务逻辑结果（如 1001=库存不足）

  2. 推荐优先级

    • 优先使用 ResponseEntity 控制 HTTP 状态码
    • 使用工具类封装业务状态码

  3. 保持响应结构一致性

    // 成功示例
{"code": 200,"message": "Success","data": { "id": 1, "name": "test" }
}// 错误示例（HTTP 404）
{"code": 40401,"message": "Product not found","data": null
}

通过这种方式，您既可以精准控制 HTTP 协议层的状态码，又能通过工具类统一业务响应格式，同时保持代码的高度可维护性。

相关文章：

  • 新能源产业破局之道：达索 3DE（PLM）系统重构数据管理与工程变更效率
  • 什么是数据分析
  • 2025年 中青杯A题论文发布
  • Redis学习打卡-Day6-Redis 高可用（上）
  • linux debug技术
  • el-form 使用el-row el-col对齐 注意事项
  • 后端开发概念
  • 【MPC控制 - 从ACC到自动驾驶】车辆纵向动力学建模与离散化：MPC的“数字蓝图”
  • 微前端架构：从单体到模块化的前端新革命
  • 【C++】C++异步编程四剑客：future、async、promise和packaged_task详解
  • 使用 CodeBuddy 实现视频合并工具：解决本地视频处理痛点
  • 可增添功能的鼠标右键优化工具
  • LumaDot （亮度可调的屏幕圆点）
  • 【Linux仓库】权限的量子纠缠：用户/组/other如何编织Linux访问控制网？
  • uniapp+ts 多环境编译
  • WebSockets 在实时通信中的应用与优化
  • H3C-W2000-G2【透明反代理】
  • 【Linux网络篇】：Socket网络套接字以及简单的UDP网络程序编写
  • 【如何做好一份技术文档？】用Javadoc与PlantUML构建高质量技术文档（API文档自动化部署）
  • 贪心介绍 LeetCode 455.分发饼干 LeetCode 376. 摆动序列 LeetCode 53. 最大子序和
  • 帮别人做钓鱼网站/网店网络推广方案
  • 本溪市建设委员会网站/武汉seo 网络推广
  • 网站怎么做分类聚合/关键词优化策略有哪些
  • 医院网站建设好处/如何在百度推广
  • csgo翻硬币网站开发/百度指数搜索指数的数据来源
  • 58同城有做网站/seo方法