SpringMVC返回json数据的三种方式

在 Spring MVC 中，我们可以使用三种方式来返回 JSON 数据。本文将详细讲解这三种方式，包括使用 @ResponseBody 注解、使用 ResponseEntity 类和使用 MappingJackson2JsonView 视图，并提供两个示例说明。

使用 @ResponseBody 注解

在 Spring MVC 中，我们可以使用 @ResponseBody 注解来返回 JSON 数据。@ResponseBody 注解可以将方法的返回值转换为 JSON 格式，并将其写入 HTTP 响应中。下面是一个示例代码，演示如何使用 @ResponseBody 注解返回 JSON 数据：

@GetMapping("/user/{id}")
@ResponseBody
public User getUser(@PathVariable("id") String userId) {
  User user = userService.getUserById(userId);
  return user;
}

在上面的代码中，我们使用 @ResponseBody 注解来将 getUser 方法的返回值转换为 JSON 格式，并将其写入 HTTP 响应中。

使用 ResponseEntity 类

在 Spring MVC 中，我们也可以使用 ResponseEntity 类来返回 JSON 数据。ResponseEntity 类可以将方法的返回值封装为一个 HTTP 响应，并设置响应头和响应状态码。下面是一个示例代码，演示如何使用 ResponseEntity 类返回 JSON 数据：

@GetMapping("/user/{id}")
public ResponseEntity<User> getUser(@PathVariable("id") String userId) {
  User user = userService.getUserById(userId);
  return ResponseEntity.ok(user);
}

在上面的代码中，我们使用 ResponseEntity 类来将 getUser 方法的返回值封装为一个 HTTP 响应，并设置响应头和响应状态码。

使用 MappingJackson2JsonView 视图

在 Spring MVC 中，我们还可以使用 MappingJackson2JsonView 视图来返回 JSON 数据。MappingJackson2JsonView 视图可以将方法的返回值转换为 JSON 格式，并将其写入 HTTP 响应中。下面是一个示例代码，演示如何使用 MappingJackson2JsonView 视图返回 JSON 数据：

@GetMapping("/user/{id}")
public ModelAndView getUser(@PathVariable("id") String userId) {
  User user = userService.getUserById(userId);
  ModelAndView modelAndView = new ModelAndView(new MappingJackson2JsonView());
  modelAndView.addObject(user);
  return modelAndView;
}

在上面的代码中，我们使用 MappingJackson2JsonView 视图来将 getUser 方法的返回值转换为 JSON 格式，并将其写入 HTTP 响应中。

示例说明

示例1：使用 @ResponseBody 注解返回 JSON 数据

在 Spring MVC 中使用 @ResponseBody 注解返回 JSON 数据非常简单。下面是一个示例代码，演示如何使用 @ResponseBody 注解返回 JSON 数据：

1. 创建一个 UserController 类：

@RestController
public class UserController {
  @Autowired
  private UserService userService;

  @GetMapping("/user/{id}")
  @ResponseBody
  public User getUser(@PathVariable("id") String userId) {
    User user = userService.getUserById(userId);
    return user;
  }
}

在上面的代码中，我们创建了一个 UserController 类，用于处理用户相关的请求。其中，getUser 方法用于获取用户信息。

示例2：使用 ResponseEntity 类返回 JSON 数据

在 Spring MVC 中使用 ResponseEntity 类返回 JSON 数据也非常简单。下面是一个示例代码，演示如何使用 ResponseEntity 类返回 JSON 数据：

1. 创建一个 UserController 类：

@RestController
public class UserController {
  @Autowired
  private UserService userService;

  @GetMapping("/user/{id}")
  public ResponseEntity<User> getUser(@PathVariable("id") String userId) {
    User user = userService.getUserById(userId);
    return ResponseEntity.ok(user);
  }
}

在上面的代码中，我们创建了一个 UserController 类，用于处理用户相关的请求。其中，getUser 方法用于获取用户信息。

结论

在本文中，我们详细讲解了 Spring MVC 中返回 JSON 数据的三种方式，包括使用 @ResponseBody 注解、使用 ResponseEntity 类和使用 MappingJackson2JsonView 视图，并提供了两个示例说明。无论是使用哪种方式，Spring MVC 都提供了很多方便的功能来帮助我们开发 Web 项目。

阅读剩余 55%