`@RestController` 是 Spring Framework 中的注解,用于标记一个类,表示这个类是一个 RESTful Web 服务的控制器(Controller)。它是 `@Controller` 注解和 `@ResponseBody` 注解的组合,意味着被 `@RestController` 标记的类的所有方法的返回值都会以 JSON 或 XML 格式直接写入 HTTP 响应体中,而不是返回一个视图。
主要的特点包括:
1. **简化了开发RESTful Web服务的控制器**:通过使用 `@RestController` 注解,你不需要在每个处理方法上再添加 `@ResponseBody` 注解来指示方法的返回值直接写入响应体中。
2. **返回 JSON 或 XML 格式的数据**:由于 `@RestController` 注解会将方法的返回值直接写入响应体中,因此返回的数据通常是 JSON 或 XML 格式的,而不是视图页面。
示例代码:
```java
@RestController
public class MyRestController {
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
@GetMapping("/user")
public User getUser() {
User user = new User();
user.setName("John");
user.setAge(30);
return user;
}
}
```
在上面的示例中,`MyRestController` 类被 `@RestController` 注解标记,表示这是一个 RESTful Web 服务的控制器。`hello()` 方法返回一个字符串 "Hello, World!",而 `getUser()` 方法返回一个 User 对象,Spring Boot 会自动将其转换为 JSON 格式并写入 HTTP 响应体中。
拓展
@Controller
@ResponseBody
- `@ResponseBody` 注解用于标记一个方法,表示该方法的返回值直接写入 HTTP 响应体中,而不是返回一个视图。通常用于 RESTful Web 服务的控制器中,将处理方法的返回值转换为 JSON、XML 等格式的数据并返回给客户端。
- `@Controller` 注解用于标记一个类,表示该类是一个控制器(Controller)。它通常结合请求映射方法(如 `@GetMapping`、`@PostMapping` 等)一起使用,用于处理客户端的 HTTP 请求,并返回相应的数据或视图。在 Spring MVC 中,`@Controller` 通常处理传统的页面导航和视图渲染。
举例来说,假设有一个简单的控制器:
```java
@Controller
public class MyController {
@GetMapping("/hello")
@ResponseBody
public String hello() {
return "Hello, World!";
}
}
```在这个例子中,`MyController` 类被 `@Controller` 注解标记,表示这是一个控制器。`hello()` 方法被 `@GetMapping` 注解标记,表示该方法处理 GET 请求,并且使用 `@ResponseBody` 注解,表示该方法的返回值直接写入 HTTP 响应体中,因此 "Hello, World!" 字符串将直接返回给客户端。
`@ResponseBody` 注解确实表示方法的返回值直接写入 HTTP 响应体中,但并不一定要求返回 JSON 格式的数据。它可以处理多种类型的返回值,包括:
1. **字符串**:返回的字符串会直接写入 HTTP 响应体中。
2. **对象**:Spring 会自动将对象转换为 JSON 或 XML 格式(取决于配置),然后写入 HTTP 响应体中。
3. **字节数组**:返回的字节数组会直接作为响应的内容发送给客户端。
4. **InputStream**:返回的 InputStream 会直接作为响应的内容发送给客户端。
5. **void**:如果方法的返回值是 void,则响应体为空。所以,虽然在大多数情况下 `@ResponseBody` 会将 Java 对象转换为 JSON 格式返回给客户端,但这并不是其唯一的功能。它的作用主要是告诉 Spring 将方法的返回值直接写入 HTTP 响应体中,而不是将其视为一个视图返回。因此,你可以根据需要返回不同类型的数据。