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

REST接口开发中怎么使用 @RestController 编写控制器

酷杰姑娘_9936

酷杰姑娘_9936

发布时间:2026-10-03 11:48:17

|

677人浏览过

|

来源于php中文网

原创

@RestController 是 Spring Boot 中用于构建 REST 接口的核心注解,等价于 @Controller + @ResponseBody,自动将返回值序列化为 JSON 响应,不支持视图跳转,配合 @GetMapping 等派生注解和 ResponseEntity 可精准控制 HTTP 状态码与响应头。

rest接口开发中怎么使用 @restcontroller 编写控制器

@RestController 是 Spring Boot 开发 REST 接口最核心的注解,它的作用就是让一个类专用于返回数据(比如 JSON),而不是跳转页面。

直接用 @RestController 声明控制器类

加在类上,表示这个类里所有方法的返回值都会自动序列化成 JSON,写进 HTTP 响应体,不用再每个方法都加 @ResponseBody。

  • 它本质是 @Controller + @ResponseBody 的组合,Spring 会自动选用 Jackson 把对象转成 JSON
  • 返回 String、List、Map、自定义对象等,都会被处理;返回 null 则响应体为空
  • 不支持返回视图名(比如 "index" 或 "home.html"),那样会报错或返回字符串字面量

配合 @RequestMapping 或更具体的映射注解

路径映射建议优先用 @GetMapping、@PostMapping 这类派生注解,语义更清晰,也避免手写 RequestMethod 枚举。

Java Maven Code Review
Java Maven Code Review

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

下载
  • 类上用 @RequestMapping("/api") 可设公共前缀,比如所有接口都以 /api 开头
  • 方法上用 @GetMapping("/users") 表示只响应 GET /api/users
  • @PostMapping("/users") 处理新增,请求体通常用 @RequestBody 接收 JSON 数据
  • 路径变量用 @PathVariable(如 /users/{id}),查询参数用 @RequestParam(如 ?page=1)

返回值类型推荐用法

不只是返回普通对象,还可以灵活控制状态码和响应头。

  • 直接返回 User、List<User> 等:自动 200 OK + JSON
  • 返回 ResponseEntity<User>:可手动设状态码(如 CREATED)、Location 头、自定义响应体
  • 返回 void 或 ResponseEntity<Void>:适合不需要响应体的 DELETE 或异步操作
  • 统一异常处理建议搭配 @ControllerAdvice,避免每个方法都 try-catch

注意几个常见误区

看似简单,但容易踩坑。

  • 别在 @RestController 类里返回字符串模板名(如 "user/list"),它不会走 Thymeleaf 或 JSP 解析
  • @RequestBody 只能用一次,且要求请求头是 application/json;表单提交要用 @RequestParam 或 DTO 封装
  • 如果接口要同时支持 JSON 和 XML,得加上 produces 属性并引入 JAXB 依赖
  • 路径中含斜杠或特殊字符时,用 @PathVariable 配合正则表达式更安全(如 @PathVariable("name") String name)

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

PixTV
PixTV Hot

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

WorkBuddy

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

DeepSeek

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

豆包大模型

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

相关专题

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

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

2311

2025.08.06

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

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

437

2026.01.26

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

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

571

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应用程序等。

1435

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

4346

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开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

620

2025.12.24

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

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

365

2026.02.11

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

40

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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