JSON Jackson 将不同的键解析到同一个字段中

Question

我有一个 POJO，它有一个字段：

public class Media {
 private Asset asset;
}

将 json 响应解析为该资产 POJO 时，一切正常。但是，该资产附带的密钥略有不同。它可以是：

  @JsonProperty("cover_asset")

或

  @JsonProperty("asset")

有没有办法注释 POJO 以识别这种情况并反序列化到同一字段中。他们不可能出现在同一个响应中。

Answer 1

好吧，由于您只关心反序列化，因此2.9 中引入的@JsonAlias 非常适合这种情况。你可以这样做：

@JsonAlias({"cover_asset", "asset"})
private Asset asset;

@JsonAlias docs:

可用于定义一个或多个替代名称的注解 对于一个属性，在反序列化过程中被接受作为替代 官方名字。 POJO期间也暴露了别名信息 内省，但在主要的序列化过程中没有影响 名称总是被使用。

注意：如果您正在使用它们，请确保更新所有相关的依赖项（annotations、core、databind）。在没有其他人的情况下仅更新 annotations 会引发运行时错误。

Answer 2

更简洁地说，我建议为此使用两个单独的 @JsonSetter 注释。这是一个工作示例。这意味着您的 java 类将只有一个用于属性的 getter 方法，而不是两个。您还可以将不希望向 Media 客户端公开的 setter 设为私有，并以特殊方式处理其中一个 json 键。

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.databind.ObjectMapper;

@SuppressWarnings("unused")
public class Media {

    private Asset asset;

    @JsonGetter("asset")
    public Asset getAsset() {
        return asset;
    }

    @JsonSetter("asset")
    public void setAsset(Asset asset) {
        this.asset = asset;
    }

    @JsonSetter("cover_asset")
    private void setMediaAsset(Asset asset) {
        if (this.asset == null) {
            setAsset(asset);
        }
    }


    private static class Asset {
        @JsonProperty("foo")
        private String foo;
    }

    public static void main(String[] args) throws Exception {
        String withAsset = "{'asset': {'foo':'bar'}}";
        String withCoverAsset = "{'cover_asset': {'foo':'bar'}}";

        ObjectMapper mapper = new ObjectMapper();
        Media mediaFromAsset = mapper.readValue(withAsset.replace('\'','"'), Media.class);
        Media mediaFromCoverAsset = mapper.readValue(withCoverAsset.replace('\'','"'), Media.class);

        System.out.println(mediaFromAsset.asset.foo.equals(mediaFromCoverAsset.asset.foo));

    }
}

Answer 3

我建议对引用同一个 POJO 字段的两个属性名称使用 getter/setter。

public class Media {
    private Asset asset;

    @JsonProperty("cover_asset")
    public Asset getCoverAsset() {
      return asset;
    }

    public void setCoverAsset(Asset asset) {
      this.asset= asset;
    }

    @JsonProperty("asset")
    public Asset getAsset() {
      return asset;
    }

    public void setAsset(Asset asset) {
      this.asset= asset;
    }
}

另请参阅我对可能重复问题的回答： Different names of JSON property during serialization and deserialization

Answer 4

Vikas 与 JsonAlias 的精彩回答。

只是补充一点，您也可以从这两个世界中受益（JsonProperty&Alias）[自杰克逊 2.9 起]：

@JsonProperty("cover_asset")    
@JsonAlias({"asset", "cover_asset","amazing_asset"})
private Asset asset; 

Reference.