@RestController
是 Spring MVC 中的一个注解,它结合了 @Controller
和 @ResponseBody
两个注解的功能。这意味着,当你在一个类上使用 @RestController
注解时,该类下的所有方法都会默认将返回的数据直接写入 HTTP 响应体中(即作为响应体返回),并且这些方法的返回值通常会自动转换成 JSON 或 XML 等格式(这取决于配置的 HttpMessageConverters
)。
@RestController
的用途
- RESTful Web 服务:主要用于构建 RESTful Web 服务,使得返回的数据能够直接作为 JSON 或 XML 等格式被前端或其他服务消费。
- 简化配置:不需要在每个方法上都使用
@ResponseBody
注解,减少了代码的冗余。 - 自动转换:Spring MVC 会根据配置和请求头(如
Accept
)自动选择合适的HttpMessageConverter
来转换方法的返回值。
示例
下面是一个使用 @RestController
的简单示例,它展示了如何创建一个返回 JSON 数据的 RESTful API。
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class GreetingController {
@GetMapping("/greeting")
public String greeting() {
return "Hello, World!";
}
// 更复杂的示例,返回一个对象,Spring MVC 会自动将其转换为 JSON
@GetMapping("/user")
public User getUser() {
return new User("John Doe", 30);
}
// User 类定义
public static class User {
private String name;
private int age;
// 构造器、getter 和 setter 省略
public User(String name, int age) {
this.name = name;
this.age = age;
}
// getter 和 setter 省略
}
}
在上面的示例中,当访问 /greeting
时,将直接返回字符串 "Hello, World!"
。当访问 /user
时,User
对象会被自动转换为 JSON 格式并返回。这种转换是透明的,由 Spring MVC 框架内部处理。
注意事项
- 使用
@RestController
时,返回值通常不应该是视图名或ModelAndView
对象,因为这些不会被作为响应体返回。 - 如果你需要在控制器中处理视图(即返回 HTML 页面),则应该使用
@Controller
注解,并在需要返回视图的方法上使用@ResponseBody
(如果需要的话)。