接受json用什么注解

解密Java接收JSON：常用注解全解析

在现代Web开发中，JSON（JavaScript Object Notation）已成为前后端数据交换的事实标准，当后端服务（尤其是基于Java的服务）需要接收来自客户端的JSON数据时，如何将一串格式化的文本字符串自动、高效地转换为一个Java对象（即反序列化）是开发者必须的核心技能，幸运的是，Spring Boot等框架通过集成Jackson、Gson等库，并辅以一系列强大的注解,极大地简化了这一过程。

本文将探讨在Java中接收JSON时最常用、最关键的几个注解,帮助你彻底理解它们的使用场景和最佳实践。

核心依赖：Jackson

在Spring Boot项目中，我们通常不需要手动添加Jackson依赖。spring-boot-starter-web依赖已经为我们自动包含了jackson-databind，这是处理JSON的核心库,我们只需关注如何使用注解来引导Jackson完成工作。

基础注解：定义映射规则

这些注解是接收JSON的基石,它们定义了JSON字段与Java对象属性之间的对应关系。

@RequestBody

这是最外层、也是最重要的注解，没有它,一切都无从谈起。

• 作用：位于Spring MVC的控制器方法参数上，用于指示Spring框架将HTTP请求体中的内容（通常是JSON字符串）自动绑定到对应的Java对象上。

• 工作原理：Spring会使用配置好的HttpMessageConverter（默认就是MappingJackson2HttpMessageConverter）来读取请求流,并调用Jackson库将其反序列化为一个指定类型的Java对象。

• 示例：

  import org.springframework.web.bind.annotation.PostMapping;
  import org.springframework.web.bind.annotation.RequestBody;
  import org.springframework.web.bind.annotation.RestController;
  @RestController
  public class UserController {
      @PostMapping("/users")
      public String createUser(@RequestBody User user) {
          // 这里的 user 对象已经自动填充了来自请求体的JSON数据
          System.out.println("Received user: " + user.getName());
          return "User created successfully: " + user.getName();
      }
  }

  当一个POST请求发送到/users，其请求体为{"name":"Alice", "age":30}时，@RequestBody会确保这个JSON被转换成一个User类的实例。

@JsonProperty

当JSON中的字段名与Java对象的属性名不一致时,这个注解就派上用场了。

• 作用：用于将JSON中的属性名映射到Java对象的字段上。

• 常用场景：

  • JSON字段名包含下划线（如user_name），而Java属性名使用驼峰命名法（如userName）。
  • JSON字段名是保留关键字（如class）,不能直接用作Java属性名。

• 示例：

  public class User {
      // 将JSON中的 "name" 字段映射到这个 "name" 属性
      @JsonProperty("name")
      private String name;
      // 将JSON中的 "user_age" 字段映射到这个 "age" 属性
      @JsonProperty("user_age")
      private int age;
      // Getters and Setters...
  }

  JSON {"name":"Bob", "user_age":25} 会被正确地填充到上述User对象中。

@JsonIgnore

我们希望Java对象中的某个字段不参与JSON序列化或反序列化。

• 作用：用于标记在JSON处理过程中需要忽略的字段。

• 示例：

  public class User {
      private String name;
      private String password; // 不希望接收或发送密码
      @JsonIgnore
      public String getPassword() {
          return password;
      }
      // ... 其他属性和方法
  }

  即使JSON中包含"password":"secret"，在反序列化为User对象时，password字段也会被忽略，同样，在将User对象序列化为JSON时，password字段也不会被包含在内。

进阶注解：处理复杂结构与数据

当JSON结构变得复杂，或者需要更精细的控制时,就需要用到以下进阶注解。

@JsonFormat

用于处理日期和时间类型的格式化问题。

• 作用：指定Java中的Date、Calendar或LocalDate等类型如何与JSON字符串进行相互转换。

• 示例：

  import com.fasterxml.jackson.annotation.JsonFormat;
  import java.util.Date;
  public class Event {
      private String name;
      // 指定JSON中日期的格式为 "yyyy-MM-dd HH:mm:ss"
      @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
      private Date eventDate;
      // Getters and Setters...
  }

  当JSON为{"name":"Conference", "eventDate":"2023-10-27 14:30:00"}时，eventDate字段会被正确解析为Date对象。

@JsonCreator

当JSON是一个简单的键值对，但你想用它的值来构造一个更复杂的对象时（使用一个工厂方法）,这个注解非常有用。

• 作用：标记一个静态工厂方法或构造函数,用于在反序列化时创建对象。

• 示例：

  import com.fasterxml.jackson.annotation.JsonCreator;
  import com.fasterxml.jackson.annotation.JsonProperty;
  public class Product {
      private final String id;
      private final String name;
      // 不使用全参构造函数，而是使用这个带有 @JsonCreator 的静态方法
      @JsonCreator
      public static Product createProduct(
              @JsonProperty("productId") String id,
              @JsonProperty("productName") String name) {
          Product product = new Product();
          product.id = id;
          product.name = name;
          return product;
      }
      // ... Getters and Setters...
  }

@JsonView

在同一个对象中，你可能需要根据不同的场景（如创建、更新、查询）返回或接收不同的字段集合。@JsonView为此而生。

• 作用：提供一种在序列化和反序列化时动态选择包含或忽略哪些字段的能力。

• 实现步骤：

  1. 定义一个或多个空接口作为视图。
  2. 在模型的字段或getter方法上使用@JsonView注解,指定它属于哪个视图。
  3. 在控制器方法上使用@JsonView注解,指定当前操作激活哪个视图。

• 示例：

  // 1. 定义视图
  public class Views {
      public interface Public {}
      public interface Internal extends Public {}
  }
  // 2. 在模型上使用
  public class User {
      @JsonView(Views.Public.class)
      private String name;
      @JsonView(Views.Internal.class)
      private String email;
      // ...
  }
  // 3. 在控制器上使用
  @RestController
  public class UserController {
      @GetMapping("/users/{id}")
      @JsonView(Views.Public.class) // 只返回 name
      public User getUser(@PathVariable String id) {
          // ...
      }
      @GetMapping("/admin/users/{id}")
      @JsonView(Views.Internal.class) // 返回 name 和 email
      public User getUserForAdmin(@PathVariable String id) {
          // ...
      }
  }

这些注解，你就能游刃有余地处理各种复杂的JSON接收场景，从简单的字段映射，到复杂的日期格式化和多视图控制，它们共同构成了Java世界与JSON世界之间强大而灵活的桥梁，在实际开发中，根据业务需求灵活组合使用它们，是编写健壮、可维护后端API的关键一环。