json转对象忽略属性怎么办啊

JSON转对象时如何优雅地忽略属性？这些方法你必须！

在Java开发中，将JSON字符串转换为Java对象（反序列化）是非常常见的操作，我们通常会使用Jackson、Gson等库来完成这项任务，在实际开发中，经常会遇到这样的场景：JSON数据中包含一些当前Java对象并不需要的属性，或者Java对象中已经有一些被标记为过时（@Deprecated）的属性，我们希望在反序列化时自动忽略这些多余的属性，避免不必要的赋值操作，甚至可能因此产生的潜在错误，JSON转对象时忽略属性究竟该怎么办呢？本文将详细介绍几种主流且高效的处理方法。

使用Jackson库的注解（推荐）

Jackson是目前Java生态中最流行的JSON处理库之一，它提供了非常灵活的注解来控制序列化和反序列化的行为，忽略属性最常用的就是@JsonIgnoreProperties和@JsonIgnore这两个注解。

类级别忽略：@JsonIgnoreProperties

当你希望忽略一个类中所有在JSON中存在但Java类中不存在的属性，或者忽略多个特定的属性时，可以在类上使用@JsonIgnoreProperties注解。

• 忽略JSON中存在但Java类中不存在的所有未知属性：

  import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
  @JsonIgnoreProperties(ignoreUnknown = true)
  public class User {
      private String name;
      private int age;
      // getters and setters
  }

  这样，即使JSON字符串中除了name和age之外还有其他字段（如address, email），反序列化时也会被忽略,不会抛出异常。

• 忽略JSON中特定的多个属性（无论这些属性在Java类中是否存在）：

  import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
  @JsonIgnoreProperties({"prop1", "prop2", "internalId"})
  public class Product {
      private String id;
      private String productName;
      private double price;
      // 假设我们想忽略JSON中的 "prop1", "prop2" 和 "internalId"
      // getters and setters
  }

属性级别忽略：@JsonIgnore

如果你只想忽略Java类中的某一个或某几个特定属性，不希望它们参与序列化和反序列化，可以在这些属性的getter方法（或字段本身，或setter方法）上使用@JsonIgnore注解。

import com.fasterxml.jackson.annotation.JsonIgnore;
public class Employee {
    private String employeeId;
    private String name;
    @JsonIgnore
    private String temporaryPassword; // 不希望这个字段被JSON填充或取出
    private String department;
    // getters and setters
    // 注意：@JsonIgnore 可以加在字段上，也可以加在getter或setter方法上
}

这样，在将JSON转换为Employee对象时，temporaryPassword字段不会被赋值；在将Employee对象转换为JSON时，temporaryPassword字段也不会被包含。

忽略未知属性（全局配置）

如果你不想在每个类上都加上@JsonIgnoreProperties(ignoreUnknown = true),也可以通过ObjectMapper进行全局配置：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.DeserializationFeature;
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 之后使用这个objectMapper进行反序列化，就会自动忽略未知属性

使用Gson库的注解

Gson是另一个广泛使用的JSON处理库,它也提供了相应的注解来忽略属性。

类级别忽略：@Expose

Gson的@Expose注解通常与GsonBuilder配合使用，来显式指定哪些字段应该被序列化/反序列化，默认情况下，所有@Expose注解的字段都会被处理，而没有注解的字段则会被忽略，如果你想忽略某些字段，可以不给它们加@Expose，或者通过GsonBuilder的excludeFieldsWithoutExposeAnnotation()方法来实现。

import com.google.gson.annotations.Expose;
public class User {
    @Expose
    private String name;
    @Expose
    private int age;
    private String internalData; // 这个字段不会被Gson处理，因为没有@Expose
    // getters and setters
}

使用时：

Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
User user = gson.fromJson(jsonString, User.class);

属性级别忽略：@Transient

或者，你可以使用Java标准的@Transient注解来标记那些不需要被序列化的字段。

import java.io.Serializable;
import java.beans.Transient;
public class User implements Serializable {
    private String name;
    private int age;
    @Transient
    private String temporaryPassword; // 会被Gson和Jackson等忽略（在默认配置下）
    // getters and setters
}

忽略未知属性

Gson默认情况下会忽略JSON中存在但Java对象中没有的字段，不会抛出异常，这与Jackson的默认行为（FAIL_ON_UNKNOWN_PROPERTIES = true）不同,所以Gson在这方面通常不需要特殊配置。

其他注意事项

1. 选择合适的粒度：

   • 如果是临时性的、一次性的忽略，或者针对某个特定类的特殊处理，使用类级别的@JsonIgnoreProperties或属性级别的@JsonIgnore/@Expose更直接。
   • 如果希望整个应用都具有忽略未知属性的行为，通过ObjectMapper进行全局配置会更合适,避免在每个类上重复添加注解。

2. 版本控制与向后兼容：

   • 当API版本升级，JSON结构新增了字段，但旧的Java类尚未更新时，使用ignoreUnknown = true可以保证旧代码仍能正常解析新JSON,提高了系统的健壮性和向后兼容性。

3. 安全性考虑：

   忽略敏感属性（如密码、内部ID等）是防止意外数据泄露的重要手段，确保这些敏感字段被正确标记为忽略，无论是在反序列化（从JSON填充对象）还是序列化（从对象生成JSON）时。

JSON转对象时忽略属性是开发中的常见需求，通过合理使用Jackson或Gson提供的注解及配置,可以非常优雅地解决这个问题：

• Jackson：
  • 类级别忽略未知或特定属性：@JsonIgnoreProperties(ignoreUnknown = true) 或 @JsonIgnoreProperties({"attr1", "attr2"})
  • 属性级别忽略：@JsonIgnore
  • 全局配置忽略未知属性：objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
• Gson：
  • 显式处理包含@Expose的字段，忽略其他：@Expose + GsonBuilder().excludeFieldsWithoutExposeAnnotation()
  • 使用标准@Transient注解忽略字段。

这些方法，能让你在处理JSON数据时更加得心应手，编写出更健壮、更易维护的代码,选择哪种方式取决于你使用的JSON库以及具体的业务场景需求。