讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot 中 REST 接口返回状态码怎么设

胖丽君_1648

胖丽君_1648

发布时间:2026-10-28 13:24:10

|

973人浏览过

|

来源于php中文网

原创

Spring Boot REST接口返回HTTP状态码应遵循语义化原则,推荐三种方式:1. @ResponseStatus用于固定状态码;2. ResponseEntity实现动态控制;3. @ControllerAdvice统一异常处理。

spring boot 中 rest 接口返回状态码怎么设

Spring Boot 中 REST 接口返回 HTTP 状态码,核心原则是:**状态码应反映真实语义,而非仅靠业务字段(如 `status: 1`)掩盖**。直接设对状态码,能让前端、网关、监控工具准确识别请求结果,也符合 RESTful 规范。 下面分三种常用且实用的方式说明,覆盖大多数开发场景:

用 @ResponseStatus 注解固定状态码

适合返回结果确定、无需动态判断的接口,比如创建资源固定返回 201,或某个方法明确表示“不支持”返回 405。

直接加在 Controller 方法或自定义异常类上:

  • 加在方法上:该接口每次调用都返回指定状态码,不管逻辑是否出错
  • 加在异常类上:抛出该异常时自动映射为对应状态码,推荐用于业务校验失败(如参数非法、权限不足)

示例(方法级):

@PostMapping("/order")
@ResponseStatus(HttpStatus.CREATED)
public Order createOrder(@RequestBody OrderRequest req) {
    return orderService.save(req);
}

注意:如果方法里实际抛了异常(比如空指针),@ResponseStatus 不会捕获它,最终仍可能返回 500 —— 所以它只适用于“正常流程下稳定返回某状态”的场景。

用 ResponseEntity 动态控制状态码

适合需要根据运行时条件返回不同状态码的接口,比如查用户:存在 → 200,不存在 → 404;或提交表单:校验通过 → 200,失败 → 400。

它把响应体、状态码、响应头全部封装进一个对象,灵活又直观:

java-api-doc-generator
java-api-doc-generator

分析 Java Spring Boot 后端 Controller 代码,自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。

下载
  • ResponseEntity.ok().body(x) → 默认 200
  • ResponseEntity.status(400).body("参数错误") → 自定义 400
  • ResponseEntity.badRequest().body(...) → 语义化写法,等价于 400

示例:

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

用 @ControllerAdvice + @ExceptionHandler 统一处理异常

这是最推荐的全局方案,尤其当项目中大量使用自定义异常(如 `UserNotFoundException`、`InsufficientBalanceException`)时。

好处是:一处定义,处处生效;避免每个接口重复 try-catch;还能统一记录日志、补全错误信息。

  • 拦截特定异常类型,返回对应状态码和结构化 JSON
  • 配合统一封装的响应体(如 Result),让 404/500 也返回和正常接口一致的格式
  • 别忘了在配置中启用 404 拦截:spring.mvc.throw-exception-if-no-handler-found=true 和 spring.resources.add-mappings=false

示例(处理未找到资源):

@ExceptionHandler(UserNotFoundException.class)
@ResponseBody
public Result<Void> handleUserNotFound(UserNotFoundException e) {
    return Result.error(404, "用户不存在");
}

这样,即使 URL 写错触发 404,也不会返回 Spring Boot 默认的 HTML 或原始 JSON,而是你定义的 {"code":404,"message":"用户不存在","data":null} 格式。

热门AI工具

更多
Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2711

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

497

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

671

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1455

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

5206

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

436

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

660

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

405

2026.02.11

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

0

2026.10.28

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn