Jackson教程：如何跳过JSON特定字段

本文深入探讨在 Jackson 中如何实现 JSON 属性的选择性处理：即在将 JSON 反序列化为 Java 对象时读取特定属性，但在将 Java 对象序列化为 JSON 响应时忽略该属性。通过运用 `@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)` 注解或在 getter 方法上使用 `@JsonIgnore`，开发者可以灵活且精确地控制 JSON 属性的读写行为，从而优化数据处理流程并确保响应内容的安全性与简洁性。

在现代的 Web 应用开发中，数据传输通常以 JSON 格式进行。Jackson 是一个功能强大的 Java 库，用于处理 JSON 数据的序列化（Java 对象转 JSON）和反序列化（JSON 转 Java 对象）。然而，在某些场景下，我们可能需要读取一个 JSON 属性并将其用于内部业务逻辑，但在将处理后的 Java 对象作为 API 响应返回时，却不希望该属性出现在最终的 JSON 响应中。例如，一个 Person 对象可能包含一个 balance 字段，我们需要读取它来计算 inCredit 状态，但出于安全或隐私考虑，不希望在响应中直接暴露 balance。

场景分析与问题阐述

考虑以下 Person 类定义，其中 balance 字段用于计算 inCredit：

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnore; // 注意：这里是尝试过但未成功的注解

public class Person {

  @JsonProperty("id")
  private Integer id;

  // 目标：需要读取 balance，但不在响应中返回
  @JsonProperty("balance")
  private Integer balance; 

  @JsonProperty("inCredit")
  private Boolean inCredit;

  // 构造函数、其他字段、getter 和 setter 方法
  public Person() {}

  public Person(Integer id, Integer balance, Boolean inCredit) {
    this.id = id;
    this.balance = balance;
    this.inCredit = inCredit;
  }

  public Integer getId() { return id; }
  public void setId(Integer id) { this.id = id; }

  public Integer getBalance() { return balance; }
  public void setBalance(Integer balance) { this.balance = balance; }

  public Boolean getInCredit() { return inCredit; }
  public void setInCredit(Boolean inCredit) { this.inCredit = inCredit; }

  @Override
  public String toString() {
    return "Person{" +
           "id=" + id +
           ", balance=" + balance +
           ", inCredit=" + inCredit +
           '}';
  }
}

当从外部（如 S3）获取 JSON 字符串并反序列化为 Person 对象时：

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JsonProcessor {

    public static Person processPersonJson(String jsonString) throws JsonProcessingException {
        ObjectMapper mapper = new ObjectMapper();
        JsonNode actualObj = mapper.readTree(jsonString);
        Person person = mapper.treeToValue(actualObj, Person.class);

        if (person.getBalance() != null && person.getBalance() > 0) {
           person.setInCredit(true);
        } else {
           person.setInCredit(false); // 确保初始化
        }
        return person;
    }

    public static void main(String[] args) throws JsonProcessingException {
        String s3Json = "{\"id\":1,\"balance\":100,\"inCredit\":false}";
        Person person = processPersonJson(s3Json);
        System.out.println("Processed Person: " + person); // balance 已经被读取

        // 目标：将 person 对象序列化为 JSON 响应，但不包含 balance 字段
        ObjectMapper responseMapper = new ObjectMapper();
        String responseJson = responseMapper.writeValueAsString(person);
        System.out.println("Response JSON: " + responseJson); 
        // 期望输出：{"id":1,"inCredit":true}
        // 实际输出（不加处理）：{"id":1,"balance":100,"inCredit":true}
    }
}

直接在 balance 字段上使用 @JsonIgnore 会导致该字段在反序列化和序列化时都被忽略，这与我们的需求（反序列化时读取，序列化时忽略）不符。

解决方案

Jackson 提供了多种灵活的方式来控制属性的序列化和反序列化行为。以下是两种常用的解决方案。

方案一：使用 @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)

这是推荐且最直接的解决方案。@JsonProperty 注解有一个 access 属性，可以精确控制属性的读写行为：

• READ_ONLY: 仅在序列化时包含（Java 对象到 JSON），反序列化时忽略（JSON 到 Java 对象）。
• WRITE_ONLY: 仅在反序列化时包含（JSON 到 Java 对象），序列化时忽略（Java 对象到 JSON）。
• READ_WRITE: 默认值，读写都包含。
• AUTO: 根据是否存在 getter/setter 自动判断。

将 balance 字段的注解修改为 WRITE_ONLY 即可满足需求：

import com.fasterxml.jackson.annotation.JsonProperty;

public class Person {

  @JsonProperty("id")
  private Integer id;

  @JsonProperty(access = JsonProperty.Access.WRITE_ONLY, value = "balance")
  private Integer balance; // 仅用于写入（反序列化），不用于读取（序列化）

  @JsonProperty("inCredit")
  private Boolean inCredit;

  // 构造函数、其他字段、getter 和 setter 方法保持不变
  // ...
}

使用此方案后，当执行 responseMapper.writeValueAsString(person) 时，balance 字段将不再出现在生成的 JSON 字符串中。

方案二：在 Getter 方法上使用 @JsonIgnore

另一种方法是利用 Jackson 注解的优先级和作用域。@JsonIgnore 可以应用于字段、getter 方法或 setter 方法。当它应用于字段时，会影响整个属性的读写。但如果仅应用于 getter 方法，则表示在序列化时（Jackson 通过 getter 获取属性值）忽略该属性，而反序列化时（Jackson 通常通过 setter 或构造函数设置字段）则不受影响。

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnore;

public class Person {

  @JsonProperty("id")
  private Integer id;

  // 字段本身可以不加 @JsonProperty，或者加上但没有 access 属性
  private Integer balance; 

  @JsonProperty("inCredit")
  private Boolean inCredit;

  // 构造函数、其他字段、setter 方法保持不变
  // ...

  // Getter 方法上添加 @JsonIgnore，使其在序列化时被忽略
  @JsonIgnore 
  public Integer getBalance() { return balance; }
  public void setBalance(Integer balance) { this.balance = balance; } // Setter 正常工作，用于反序列化

  // ...
}

在这种情况下，Jackson 在反序列化时会查找 balance 字段或 setBalance 方法来设置值。而在序列化时，由于 getBalance() 方法被 @JsonIgnore 标记，Jackson 将不会调用它来获取 balance 的值，从而将其从 JSON 响应中排除。

总结与注意事项

• @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)：
  • 优点：语义清晰，直接作用于字段，控制粒度精确。是处理这种“只写不读”场景的首选方案。
  • 适用场景：需要从 JSON 中读取数据用于内部处理，但绝不希望在输出 JSON 中暴露该数据（如敏感信息、临时计算字段）。
• @JsonIgnore 在 Getter 方法上：
  • 优点：同样能达到目的，在某些情况下可能更灵活（例如，字段本身没有 @JsonProperty 注解，或者希望通过方法级别控制）。
  • 注意事项：确保存在一个可用的 setter 方法或构造函数参数来在反序列化时设置该字段的值。如果字段没有对应的 setter 且没有合适的构造函数，反序列化可能会失败。

在实际开发中，应根据具体需求和团队编码规范选择最合适的方案。对于大多数情况，@JsonProperty(access = JsonProperty.Access.WRITE_ONLY) 提供了最简洁和直观的解决方案，因为它明确地表达了属性的预期行为。通过这些 Jackson 注解，开发者可以精细地控制 JSON 数据的流向，确保应用程序的数据处理既高效又安全。