反序列化时忽略属性

Question

我有一个简单的接口，其中包含属性的 getter 和 setter。

public interface HasMoney { 

      Money getMoney();

      void setMoney(Money money);

 }

我有另一个类 UserAccount 实现了这个接口。

public class UserAccount implements HasMoney {

       private Money money;

       @Override
       Money getMoney() // fill in the blanks

       @Override
       void setMoney(Money money) // fill in the blanks

}

我的问题是我想序列化货币属性，但在反序列化时忽略它，即不接受用户为这个属性提供的任何值。我已经在 setter 上尝试了 @JsonIgnore ，在 getter 上尝试了 @JsonIgnore(false) ，它确实忽略了它，但它在序列化它的同时也这样做了。

我在 setter 上尝试了@JsonIgnore，在 getter 上尝试了@JsonProperty，只是为了明确告诉 Jackson 我们打算跟踪这个属性，当金钱属性被发送到服务器并且 Jackson 试图反序列化它抛出时，这似乎会使应用程序崩溃up MalformedJsonException : 无法构造 Money 类型的对象。

最奇怪的是，将@JsonIgnore 放在setter 上，将@JsonProperty 放在setter 上适用于大多数情况下的原始属性。

Answer 1

版本 2.6.0+ 允许在类级别使用 @JsonIgnoreProperties 完成此操作。

@JsonIgnoreProperties(value={ "money" }, allowGetters=true)

看看这个已关闭的问题： https://github.com/FasterXML/jackson-databind/issues/95

Answer 2

好的，从 1.9 开始，@JsonIgnore 的行为发生了根本性的变化（更糟糕的是 imo）。无需详细说明为什么您的属性在反序列化期间没有被忽略，请尝试以下代码来修复它：

public class UserAccount implements HasMoney {
    @JsonIgnore
    private BigDecimal money;

    // Other variable declarations, constructors

    @Override
    @JsonProperty
    public BigDecimal getMoney() {
        return money;
    }

    @JsonIgnore
    @Override
    public void setMoney(final BigDecimal money) {
        this.money = money;
    }

    // Other getters/setters
}

注意在现场使用@JsonIgnore - 它是有效解决方案所必需的。

注意：根据您的环境和用例，您可能需要对 ObjectMapper 实例进行额外配置，例如， USE_GETTERS_AS_SETTERS、AUTO_DETECT_GETTERS、AUTO_DETECT_SETTERS 等。

Answer 3

如果您不拥有或无法通过添加 @JsonIgnore 注释来更改类，您将在您的实现中使用从版本 2.5 开始的 mixin 来获得预期的结果。

public abstract class HasMoneyMixin {
    @JsonIgnore
    public abstract Money getMoney();
}

配置映射器使用mixin，

ObjectMapper mapper = new ObjectMapper();
mapper.addMixIn(HasMoney.class, HasMoneyMixin.class);
// avoid failing if all properties are empty
mapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);

Answer 4

显然我的解决方案迟了，但肯定会对其他人有所帮助。

史前史： 在我的项目中，有一个类将 JSON 字符串直接读取到实体中。 JSON 包含一个不是类变量的属性。因为

objectMapper.enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

在反序列化期间不会创建实体的实例（在我们的项目中需要这种情况下的异常）。

解决方案：

objectMapper.addHandler(new DeserializationProblemHandler() {
    @Override
    public boolean handleUnknownProperty(DeserializationContext ctxt, JsonParser p, JsonDeserializer<?> deserializer, Object beanOrClass, String propertyName) throws IOException {
       if( (propertyName.equals("propertyToBeIgnored") && beanOrClass.getClass().equals(ClassOfTheProperty.class)) {
           p.skipChildren();
           return true;
       } else {
           return false;
       }
    }
});

Answer 5

使用 Jackson 2.10，您可以像这样实现只读字段：

一个真实的领域

public class UserAccount implements HasMoney {

   @JsonProperty(access = JsonProperty.Access.READ_ONLY)
   private Money money;
   
   // getter and setter

}

虚拟字段

@JsonIgnoreProperties(ignoreUnknown = true) // to ignore ALL unknown properties
// OR
@JsonIgnoreProperties(value = {"money"}, allowGetters = true) // to ignore only 'money' input
public class UserAccount implements HasMoney {

   @JsonProperty
   public Money getMoney() {
       // some calculation
   }

}

该值将被序列化，但在反序列化过程中被忽略。