Java 中怎么使用 @RestController 快速开发 REST 接口

风涛大大_3374

风涛大大_3374

2026-10-20

709人浏览

原创

@restcontroller是@controller与@responsebody的组合注解,用于标识rest控制器,其方法返回值自动序列化为json写入响应体,无需额外配置,专为前后端分离场景设计。

java 中怎么使用 @restcontroller 快速开发 rest 接口

@RestController 是 Spring Boot 中最常用的注解之一,它本质是 @Controller 和 @ResponseBody 的组合,表示这个类中所有方法的返回值都会被自动转为 JSON(或其他媒体类型),直接写入 HTTP 响应体,无需额外配置。

一、基础用法:定义一个 REST 控制器

只需在类上添加 @RestController,再配合 @RequestMapping 或更具体的 @GetMapping、@PostMapping 等即可:

<font size="2">@RestController<br>public class UserController {<br><br>    @GetMapping("/users/{id}")<br>    public User getUserById(@PathVariable Long id) {<br>        return new User(id, "张三", 25);<br>    }<br><br>    @PostMapping("/users")<br>    public User createUser(@RequestBody User user) {<br>        // 保存逻辑...<br>        return user;<br>    }<br>}</font>

Spring Boot 会自动将 User 对象序列化为 JSON,响应头设为 Content-Type: application/json。

二、配合 @RequestBody 接收 JSON 请求体

前端发送 POST/PUT 请求时,若 Content-Type 是 application/json,用 @RequestBody 可直接绑定 JSON 数据到 Java 对象:

JavaStoryDevelop
JavaStoryDevelop

你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在

下载
  • 确保实体类有无参构造器和 getter/setter 方法(Lombok 的 @Data 可简化)
  • 字段名需与 JSON key 一致,或用 @JsonProperty 显式映射
  • 如 JSON 中有缺失字段,对应 Java 字段为 null(基本类型需用包装类,如 Integer)

三、统一返回结构(推荐实践)

实际项目中不建议直接返回原始对象,而是封装成统一格式(如 { "code": 200, "data": {}, "msg": "success" })。可定义通用响应类:

<font size="2">public class Result<t> {<br>    private int code;<br>    private String msg;<br>    private T data;<br>    // 构造方法、getter/setter 省略<br>}</t></font>

然后控制器中返回 Result<user></user>,既规范又便于前端处理错误和加载状态。

四、异常统一处理(避免暴露堆栈)

使用 @RestControllerAdvice + @ExceptionHandler 捕获全局异常,返回友好 JSON 错误信息:

<font size="2">@RestControllerAdvice<br>public class GlobalExceptionHandler {<br><br>    @ExceptionHandler(UserNotFoundException.class)<br>    public Result<string> handleUserNotFound(UserNotFoundException e) {<br>        return Result.fail(404, e.getMessage());<br>    }<br>}</string></font>

这样即使业务抛出异常,接口仍返回标准 JSON,不会因未捕获异常导致 500 响应体是 HTML 或空内容。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10797

6

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

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

2023.07.05

7922

9

java自学难吗
java自学难吗

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

2023.07.31

6892

8

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

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

2023.08.01

1164

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

1416

5

java有什么用
java有什么用

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

2023.08.02

2849

5

java在线网站
java在线网站

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

2023.08.03

20131

3

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

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

2023.08.03

1255

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习