Java 中 Spring MVC 怎么使用 @RestController 统一声明符合 RESTful 规范的轻量级后端控制器

老墨君_9363

老墨君_9363

2026-07-24

383人浏览

原创

@restcontroller 是 spring mvc 中用于构建 restful api 的注解,等价于 @controller + @responsebody,使类中所有方法默认返回 json/xml;配合 @requestmapping 和 http 方法注解定义资源路径,返回对象自动序列化为 json,并推荐统一响应结构与异常处理。

java 中 spring mvc 怎么使用 @restcontroller 统一声明符合 restful 规范的轻量级后端控制器

@RestController 是 Spring MVC 中专为构建 RESTful 风格 Web API 而设计的注解,它本质是 @Controller 和 @ResponseBody 的组合,让每个方法默认返回 JSON/XML 数据而非视图页面。

用 @RestController 替代 @Controller + @ResponseBody

传统控制器需在每个方法上加 @ResponseBody 才能返回 JSON;而 @RestController 声明在类上后,所有方法自动具备该行为,无需重复标注。

  • 错误写法(冗余):

@Controller
public class UserController {
  @ResponseBody
  @GetMapping("/users")
  public List list() { ... }
}

  • 正确写法(简洁统一):

@RestController
@RequestMapping("/api/users")
public class UserController {
  @GetMapping
  public List list() { ... }
  @PostMapping
  public User create(@RequestBody User user) { ... }
}

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载

配合 @RequestMapping 和 HTTP 方法注解定义资源路径

RESTful 强调“资源”与“操作”的分离。推荐在类上用 @RequestMapping 定义基础路径,在方法上用 @GetMapping、@PostMapping 等明确语义。

  • @GetMapping("/users") → 查询全部用户(GET)
  • @GetMapping("/users/{id}") → 查询单个用户(GET)
  • @PostMapping("/users") → 创建用户(POST)
  • @PutMapping("/users/{id}") → 全量更新(PUT)
  • @PatchMapping("/users/{id}") → 局部更新(PATCH)
  • @DeleteMapping("/users/{id}") → 删除用户(DELETE)

返回值自动序列化为 JSON

Spring Boot 默认集成 Jackson,只要返回对象(如 User、List<user></user> 或 Map<string object></string>),框架会自动转成 JSON 并设置 Content-Type: application/json。

  • 确保实体类有无参构造器和 getter 方法
  • 可使用 @JsonInclude(JsonInclude.Include.NON_NULL) 控制空字段是否输出
  • 需要自定义序列化逻辑时,可添加 @JsonSerialize 或配置 ObjectMapper

统一处理异常与返回结构(增强 REST 规范性)

真实项目中建议封装标准响应体(如 { "code": 200, "data": ..., "msg": "success" }),并用 @ControllerAdvice 统一捕获异常。

  • 定义通用响应类:Result<t></t>,含 code、msg、data 字段
  • 用 @ExceptionHandler 拦截 RuntimeException 等,返回 Result.error(...)
  • 避免在每个 Controller 方法里手动包装 Result.success(user),可考虑 AOP 或自定义 @ResponseBodyAdvice

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

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2503

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6430

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5846

10

java
java

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

2023.06.15

10617

6

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

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

2023.07.05

7762

9

java自学难吗
java自学难吗

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

2023.07.31

6752

8

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

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

2023.08.01

1144

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1396

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习