@ResponseBody注解的作用和示例

@ResponseBody注解是Spring框架中常用的注解之一,用于指定方法返回的数据直接作为HTTP响应的主体内容,而不是渲染一个模板视图。通过使用@ResponseBody注解,可以返回JSON/XML等格式的数据,或直接返回字符串、数字等类型的数据。

下面是一个使用@ResponseBody注解的示例:

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/get/{id}")
    public User getUser(@PathVariable Long id) {
        return userService.findById(id);
    }

    @GetMapping("/all")
    public List<User> getAllUsers() {
        return userService.findAll();
    }
}

在上面的示例中,使用@RestController注解声明了一个名为UserController的类,并使用@RequestMapping注解标记了类级别的请求路径为”/user”。接着,在方法getUser()上使用@GetMapping注解,定义了一个GET请求的URL路径为”/get/{id}”。当请求该路径时,会调用getUser()方法,并返回一个User对象,该对象会自动转换为JSON格式的数据,并作为HTTP响应的主体内容进行返回。在方法getAllUsers()上,使用@GetMapping注解定义了一个GET请求的URL路径为”/all”。当请求该路径时,会调用getAllUsers()方法,并返回一个List对象,该对象也会自动转换为JSON格式的数据,并作为HTTP响应的主体内容进行返回。

需要注意的是,@ResponseBody注解只有在使用@RestController注解声明Controller类时才会生效,如果使用@Controller注解声明Controller类,则需要在方法上使用@ResponseBody注解才能将方法返回的数据作为HTTP响应的主体内容返回。