📣前言

  随着Web开发模式的演进，RESTful架构风格因其简洁性和灵活性而广受欢迎。Spring框架作为Java开发中的佼佼者，通过其@RestController注解，为开发者提供了一种高效的方式来构建RESTful Web服务。本文将深入探讨@RestController的使用，以及如何利用它简化REST开发。
  那么，具体如何实现呢？这将又会是干货满满的一期，全程无尿点不废话只抓重点教，具有非常好的学习效果，拿好小板凳准备就坐！希望学习的过程中大家认真听好好学，学习的途中有任何不清楚或疑问的地方皆可评论区留言或私信，bug菌将第一时间给予解惑，那么废话不多说，直接开整！Fighting！！

🌊环境说明

开发工具：IDEA 2021.3
JDK版本： JDK 1.8
Spring Boot版本：2.3.1 RELEASE
Maven版本：3.8.2

🏆本文收录于《Spring Boot从入门到精通》，专门攻坚指数提升，2024 年国内最系统+最强（更新中）。

本专栏致力打造最硬核 Spring Boot 从零基础到进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中…欢迎大家订阅持续学习。 如果想快速定位学习，可以看这篇【SpringBoot教程导航帖】,你想学习的都被收集在内，快速投入学习！！两不误。

正文

摘要

  @RestController是Spring 4引入的一个类级别的注解，它结合了@Controller和@ResponseBody的功能，使得开发者可以更加专注于业务逻辑的实现，而无需关心视图的渲染。本文将从基本概念、源代码解析、应用案例、优缺点分析、类代码方法介绍、测试用例等方面，全面介绍@RestController的使用。

简介

  @RestController注解是Spring MVC中用于简化RESTful Web服务开发的一个特性。它不仅声明了该类是一个控制器，而且其所有方法的返回值都将直接作为HTTP响应的正文返回，无需通过视图解析器。

源代码解析

以下是一个简单的@RestController使用示例：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, RESTful World!";
    }
}

  在这个例子中，@RestController应用于HelloController类上，而@GetMapping("/hello")注解定义了一个处理HTTP GET请求的端点。

  并附上其源码：

代码解析

  根据如上代码进行分析，在Spring框架中，@RestController是一个用于创建RESTful Web服务的类级别的注解。它结合了@Controller和@ResponseBody的功能，使得类中的所有方法都自动将返回值作为HTTP响应的正文返回，而不需要额外的配置。下面是对上述代码的详细解析：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

// 1. 类定义和注解
@RestController
public class HelloController {
    // 2. 方法定义和注解
    @GetMapping("/hello")
    public String sayHello() {
        // 3. 方法实现
        return "Hello, RESTful World!";
    }
}

1. 类定义和注解

• @RestController：这个注解是@Controller和@ResponseBody的组合，它表明HelloController类是一个控制器，并且其所有方法的返回值都将直接写入HTTP响应体中。这使得开发者可以专注于业务逻辑的实现，而不需要关心视图的渲染。

2. 方法定义和注解

• @GetMapping("/hello")：这是@RequestMapping的一个特化版本，专门用于处理HTTP GET请求。它将/hello路径映射到sayHello方法上。当客户端发起到/hello的GET请求时，sayHello方法将被调用。

3. 方法实现

• public String sayHello()：这是一个公共方法，它返回一个String类型的值。在RESTful服务中，这个返回值将作为HTTP响应的正文发送给客户端。
• return "Hello, RESTful World!";：这是方法的返回语句，它返回一个字符串，这个字符串是响应给客户端的内容。

源码讲解

• @RestController：这个注解背后的实现是通过Spring的组件扫描机制，自动检测到类上的@RestController注解，并将这个类注册为Spring应用上下文中的一个Bean。同时，Spring MVC框架会识别到@GetMapping注解，并将其与HTTP请求路径关联起来。

• @GetMapping：这个注解背后的实现是通过方法的参数和返回值来定义请求的映射。当HTTP GET请求到达服务器时，Spring MVC会根据注解中的路径参数查找对应的处理器方法，并执行它。

• 方法的返回值：在@RestController注解的类中，方法的返回值直接作为HTTP响应体返回。这意味着Spring MVC会自动将返回的字符串转换为适当的HTTP响应格式（通常是text/plain或application/json），并发送给客户端。

应用场景

  这种模式非常适合构建轻量级的Web服务，特别是那些不需要渲染复杂视图的RESTful API。例如，一个返回JSON数据的API，或者一个简单的文本响应服务。

优缺点总结

• 优点：简化配置，提高开发效率，增强代码的可读性和维护性。
• 缺点：不适用于需要返回HTML视图的场景，可能会限制某些类型的Web应用开发。

  通过上述代码和源码讲解，我们可以看到@RestController和@GetMapping注解是如何协同工作，以简化RESTful Web服务的开发流程的。

应用场景案例

  考虑一个需要返回用户信息的RESTful服务，以下是使用@RestController实现的示例：

import org.springframework.web.bind.annotation.*;

import java.util.List;
import java.util.Arrays;

@RestController
public class UserController {

    @GetMapping("/users")
    public List<String> getUsers() {
        return Arrays.asList("Alice", "Bob", "Charlie");
    }
}

代码解析

  这段代码展示了如何使用Spring框架中的@RestController注解来创建一个简单的RESTful控制器，用于处理对"/users"路径的HTTP GET请求，并返回一个用户列表。下面是对代码的详细解析：

import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Arrays;

// 类定义和RestController注解
@RestController
public class UserController {

    // 使用GetMapping注解来处理"/users"路径的GET请求
    @GetMapping("/users")
    public List<String> getUsers() {
        // 返回一个包含用户名称的列表
        return Arrays.asList("Alice", "Bob", "Charlie");
    }
}

类定义和RestController注解

• @RestController：这个注解表明UserController类是一个控制器，并且其所有方法的返回值都将直接写入HTTP响应体中。它是一个组合注解，相当于@Controller和@ResponseBody的结合。

使用GetMapping注解

• @GetMapping("/users")：这个注解是@RequestMapping的特化版本，专门用于映射HTTP GET请求。它将"/users"路径映射到getUsers方法上，这意味着当客户端发起到"/users"的GET请求时，getUsers方法将被调用。

方法实现

• public List<String> getUsers()：这是一个公共方法，返回一个List<String>类型的值。在RESTful服务中，这个返回值将作为HTTP响应的正文发送给客户端。
• return Arrays.asList("Alice", "Bob", "Charlie");：这是方法的返回语句，它使用Arrays.asList方法创建并返回一个包含字符串"Alice"、"Bob"和"Charlie"的列表。这个列表代表了一个简单的用户集合。

源码讲解

• @RestController：当Spring框架检测到类上带有@RestController注解时，它会将该类的所有公共方法暴露为RESTful端点。这意味着Spring MVC会自动处理HTTP请求和响应的映射。

• @GetMapping：这个注解是Spring MVC提供的用于简化请求映射的注解之一。它告诉Spring MVC，当接收到对应路径的GET请求时，应该调用标记的这个方法。

• 返回值处理：在@RestController注解的类中，方法的返回值不需要通过视图解析器进行处理，而是直接作为HTTP响应的正文返回。这通常用于返回JSON、XML或其他格式的数据。

优缺点分析

优点

• 简化配置：减少代码冗余，提高开发效率。
• 增强可读性：通过注解清晰地表明了控制器的用途。
• 易于维护：集中管理返回值的格式，便于后续修改。

缺点

• 限制性：不适用于需要返回HTML视图的场景。
• 可能的误解：初学者可能会误以为所有方法都自动支持RESTful风格。

类代码方法介绍

@RestController通常与以下HTTP方法注解结合使用：

• @GetMapping：处理GET请求。
• @PostMapping：处理POST请求。
• @PutMapping：处理PUT请求。
• @DeleteMapping：处理DELETE请求。

测试用例

  以下是使用JUnit和Spring Boot测试@RestController的一个简单示例：

import org.springframework.boot.test.context.SpringBootTest;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

@SpringBootTest
public class UserControllerTest {

    @Test
    public void whenGetUsers_thenReturnsUserList() throws Exception {
        mockMvc.perform(get("/users"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$", hasSize(3)));
    }
}

示例演示

  同时也可以看下在实际项目中，它是如何系统被使用的，示例如下：

代码解析

  这段代码是一个使用Spring Boot测试模块编写的单元测试用例，用于验证UserController中的getUsers方法是否按预期工作。下面是对代码的详细解析：

import org.springframework.boot.test.context.SpringBootTest;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;

// 使用Spring Boot的@SpringBootTest注解来加载应用上下文
@SpringBootTest
public class UserControllerTest {

    // 定义一个测试方法，用于测试获取用户列表的逻辑
    @Test
    public void whenGetUsers_thenReturnsUserList() throws Exception {
        // 使用MockMvc来模拟一个GET请求到"/users"路径
        mockMvc.perform(get("/users"))
                // 断言HTTP响应状态码为200（OK）
                .andExpect(status().isOk())
                // 使用jsonPath断言来验证返回的JSON数组长度为3
                .andExpect(jsonPath("$", hasSize(3)));
    }
}

使用@SpringBootTest注解

• @SpringBootTest：这个注解用于指示Spring Boot测试框架加载完整的Spring应用上下文。这使得测试可以访问Spring管理的所有Bean，包括UserController。

MockMvc的使用

• mockMvc.perform(get("/users"))：MockMvc是Spring MVC测试框架的一部分，用于模拟HTTP请求。这里模拟了一个到"/users"路径的GET请求。

断言的使用

• .andExpect(status().isOk())：这个断言检查响应的状态码是否为200，即HTTP OK状态，表示请求成功。

• .andExpect(jsonPath("$", hasSize(3)))：这个断言使用jsonPath表达式来检查响应正文中的JSON数组长度是否为3。"$"是一个JSON路径表达式，代表整个响应体。

源码讲解

• @SpringBootTest：这个注解背后的实现是Spring Boot的测试上下文框架，它会为测试提供一个完整的Spring应用上下文，包括所有的自动配置和Bean。

• MockMvc：MockMvc是一个强大的工具，它允许开发者在不启动服务器的情况下模拟HTTP请求和响应。这对于编写快速、独立的单元测试非常有用。

• 断言：在测试中使用断言来验证代码的行为是否符合预期。Spring MVC测试框架提供了多种断言方法，如status和jsonPath，来检查响应的状态码和响应体。

应用场景

  这个测试用例适用于验证RESTful控制器中的方法是否正确返回预期的数据。在这个例子中，它验证了UserController的getUsers方法是否返回了一个包含3个元素的用户列表。

优缺点

• 优点：无需启动服务器即可进行测试，提高了测试的效率和速度；可以验证控制器的逻辑是否正确。
• 缺点：由于是模拟的请求，可能无法完全模拟真实的HTTP请求和响应环境，某些细节可能无法覆盖。

  通过上述代码和源码讲解，我们可以了解到如何使用Spring Boot的测试模块来编写单元测试，验证RESTful控制器的行为是否符合预期。

小结

  通过本文的学习，我们了解到@RestController是一个强大的工具，它极大地简化了RESTful服务的开发过程。从基本概念到实际应用，再到测试用例的编写，我们全面地掌握了如何使用@RestController。

总结

  @RestController注解是Spring框架中用于简化RESTful Web服务开发的利器。它通过减少配置和提高代码的可读性，帮助开发者更高效地构建RESTful应用。尽管存在一些限制，但在适当的场景下，它无疑是一个值得使用的注解。

… …

  ok，以上就是我这期的全部内容啦，如果还想学习更多，你可以看看如下的往期热文推荐哦，每天积累一个奇淫小知识，日积月累下去，你一定能成为令人敬仰的大佬。

「赠人玫瑰，手留余香」，咱们下期拜拜~~

🌊热文推荐

滴~如下推荐【Spring Boot 进阶篇】的学习大纲，请小伙伴们注意查收。

Spring Boot进阶(01)：Spring Boot 集成 Redis，实现缓存自由

Spring Boot进阶(02)：使用Validation进行参数校验

Spring Boot进阶(03)：如何使用MyBatis-Plus实现字段的自动填充

Spring Boot进阶(04)：如何使用MyBatis-Plus快速实现自定义sql分页

Spring Boot进阶(05)：Spring Boot 整合RabbitMq，实现消息队列服务

Spring Boot进阶(06)：Windows10系统搭建 RabbitMq Server 服务端

Spring Boot进阶(07)：集成EasyPoi，实现Excel/Word的导入导出

Spring Boot进阶(08)：集成EasyPoi，实现Excel/Word携带图片导出

Spring Boot进阶(09)：集成EasyPoi，实现Excel文件多sheet导入导出

Spring Boot进阶(10)：集成EasyPoi，实现Excel模板导出成PDF文件

Spring Boot进阶(11)：Spring Boot 如何实现纯文本转成.csv格式文件？

Spring Boot进阶(12)：Spring Boot 如何获取Excel sheet页的数量？

Spring Boot进阶(13)：Spring Boot 如何获取@ApiModelProperty(value = “序列号“, name = “uuid“)中的value值name值？

Spring Boot进阶(14)：Spring Boot 如何手动连接库并获取指定表结构？一文教会你

Spring Boot进阶(15)：根据数据库连接信息指定分页查询表结构信息

Spring Boot进阶(16)：Spring Boot 如何通过Redis实现手机号验证码功能？

Spring Boot进阶(17)：Spring Boot如何在swagger2中配置header请求头等参数信息

Spring Boot进阶(18)：SpringBoot如何使用@Scheduled创建定时任务？

Spring Boot进阶(19)：Spring Boot 整合ElasticSearch

Spring Boot进阶(20)：配置Jetty容器

Spring Boot进阶(21)：配置Undertow容器

Spring Boot进阶(22)：Tomcat与Undertow容器性能对比分析

Spring Boot进阶(23)：实现文件上传

Spring Boot进阶(24)：如何快速实现多文件上传？

Spring Boot进阶(25)：文件上传的单元测试怎么写?

Spring Boot进阶(26)：Mybatis 中 resultType、resultMap详解及实战教学

Spring Boot进阶(27)：Spring Boot 整合 kafka(环境搭建+演示)

Spring Boot进阶(28)：Jar包Linux后台启动部署及滚动日志查看，日志输出至实体文件保存

Spring Boot进阶(29)：如何正确使用@PathVariable，@RequestParam、@RequestBody等注解？不会我教你，结合Postman演示

Spring Boot进阶(30)：@RestController和@Controller 注解使用区别，实战演示

… …

  若想系统完整的从0到1的学习，可以参考这篇专栏总结《2023最新首发，全网最全 Spring Boot 学习宝典(附思维导图)》，本专栏致力打造最硬核 Spring Boot 进阶系列学习内容，🚀均为全网独家首发，打造精品专栏，专栏持续更新中。欢迎大家订阅持续学习。

  如果想快速定位学习，可以看这篇【教程导航帖】导航目录,你想学习的都被收集在内，快速投入学习！！两不误。

  在入门及进阶之途，我必助你一臂之力，系统性学习，从入门到精通，带你不走弯路，直奔终点；投资自己，永远性价比最高，都这么说了，你还不赶紧来学？？

  本文涉及所有源代码，均已上传至GitHub开源，供同学们一对一参考 GitHub传送门，同时，原创开源不易，欢迎给个star🌟，想体验下被🌟的感jio，非常感谢❗

📣文末

我是bug菌，CSDN | 阿里云 | 华为云 | 51CTO 等社区博客专家，历届博客之星Top30，掘金年度人气作者Top40，51CTO年度博主Top12，掘金 | InfoQ | 51CTO等社区优质创作者，全网粉丝合计15w+ ；硬核微信公众号「猿圈奇妙屋」，欢迎你的加入！免费白嫖最新BAT互联网公司面试题、4000G pdf电子书籍、简历模板等海量资料。