Java 中 REST 接口开发怎么使用 @RestController 注解

浅浩吖_8431

浅浩吖_8431

2026-10-02

528人浏览

原创

@restcontroller 是 spring boot 中用于构建 rest api 的注解,等价于 @controller + @responsebody,使类中所有方法默认返回 json/xml 数据而非视图;需配合 @getmapping 等映射注解使用,不支持页面渲染。

java 中 rest 接口开发怎么使用 @restcontroller 注解

@RestController 是 Spring Boot 中构建 REST 接口最直接、最常用的注解,它的核心作用是:让类中所有方法的返回值自动序列化为 JSON(或 XML),并直接写入 HTTP 响应体,无需额外配置或注解。

它本质上是 @Controller + @ResponseBody 的组合

传统 @Controller 用于返回视图(如 HTML 页面),需配合 @ResponseBody 才能返回 JSON;而 @RestController 天然自带 @ResponseBody 效果,整个类的方法默认都走数据响应路径。

这意味着你不用在每个方法上重复加 @ResponseBody,代码更干净,语义更明确——这个类只对外提供 API,不渲染页面。

基本用法:标注类 + 配合请求映射注解

只需两步:

Java Maven Code Review
Java Maven Code Review

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

下载
  • 在类上添加 @RestController
  • 在方法上使用 @GetMapping、@PostMapping 等映射注解,并返回 Java 对象或基础类型

例如:

```java
@RestController
@RequestMapping("/api/users")
public class UserController {
@GetMapping("/{id}")
public User findById(@PathVariable Long id) {
return new User("Alice", 30); // 自动转为 JSON:
// {"name":"Alice","age":30}
}

@PostMapping
public String create(@RequestBody User user) {
return "Created: " + user.getName(); // 字符串也直接返回,不走模板
}
}

支持常见参数绑定方式

你可以自然使用各类 Spring MVC 参数注解,框架会自动解析:

  • @PathVariable:提取 URL 路径中的变量(如 /users/123 中的 123)
  • @RequestParam:获取查询参数(如 ?name=Tom&page=1)
  • @RequestBody:接收 JSON 请求体并绑定为 Java 对象(常用于 POST/PUT)
  • @RequestHeader、@CookieValue 等也可按需使用

注意它不处理视图,也不兼容模板引擎

如果你需要返回 HTML 页面(比如 Thymeleaf 或 JSP),就不能用 @RestController,而应改用 @Controller,否则模板不会被解析,客户端只会收到原始字符串或报错。

简单判断标准:
– 返回 User、List<product></product>、Map<string object></string>?→ 用 @RestController
– 返回 "index"、"admin/dashboard" 这类逻辑视图名?→ 必须用 @Controller

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

9497

6

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

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

2023.07.05

6662

9

java自学难吗
java自学难吗

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

2023.07.31

5912

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2489

5

java在线网站
java在线网站

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

2023.08.03

19831

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习