如何使用JsonCreator对具有重载构造函数的类进行反序列化

时间:2013-04-10 16:12:25

标签: java json jackson

我正在尝试使用Jackson 1.9.10反序列化此类的实例:

public class Person {

@JsonCreator
public Person(@JsonProperty("name") String name,
        @JsonProperty("age") int age) {
    // ... person with both name and age
}

@JsonCreator
public Person(@JsonProperty("name") String name) {
    // ... person with just a name
}
}

当我尝试这个时,我得到以下

  

冲突的基于属性的创建者:已经有... {interface org.codehaus.jackson.annotate.JsonCreator @ org.codehaus.jackson.annotate.JsonCreator()}],遇到...,注释:{interface org .codehaus.jackson.annotate.JsonCreator @ org.codehaus.jackson.annotate.JsonCreator()}]

有没有办法使用Jackson对带有重载构造函数的类进行反序列化?

由于

4 个答案:

答案 0 :(得分:100)

虽然没有正确记录,但每种类型只能有一个创建者。您可以在类型中包含任意数量的构造函数,但只有其中一个构造函数应该有@JsonCreator注释。

答案 1 :(得分:50)

对于Jackson databind 2.7.0,这仍然适用。

杰克逊@JsonCreator annotation 2.5 javadocJackson annotations documentation语法(构造函数 s 和工厂方法 s )让我们相信一个人可以标记多个构造函数。

  

标记注释,可用于将构造函数和工厂方法定义为用于实例化关联类的新实例的注释。

查看识别创建者的代码,看起来杰克逊CreatorCollector忽略重载构造函数,因为它只有checks the first argument of the constructor

Class<?> oldType = oldOne.getRawParameterType(0);
Class<?> newType = newOne.getRawParameterType(0);

if (oldType == newType) {
    throw new IllegalArgumentException("Conflicting "+TYPE_DESCS[typeIndex]
           +" creators: already had explicitly marked "+oldOne+", encountered "+newOne);
}
  • oldOne是第一个确定的构造函数创建者。
  • newOne是重载的构造函数创建者。

这意味着像这样的代码

@JsonCreator
public Phone(@JsonProperty("value") String value) {
    this.value = value;
    this.country = "";
}

@JsonCreator
public Phone(@JsonProperty("country") String country, @JsonProperty("value") String value) {
    this.value = value;
    this.country = country;
}

assertThat(new ObjectMapper().readValue("{\"value\":\"+336\"}", Phone.class).value).isEqualTo("+336"); // raise error here
assertThat(new ObjectMapper().readValue("{\"value\":\"+336\"}", Phone.class).value).isEqualTo("+336");

但是这段代码可行:

@JsonCreator
public Phone(@JsonProperty("value") String value) {
    this.value = value;
    enabled = true;
}

@JsonCreator
public Phone(@JsonProperty("enabled") Boolean enabled, @JsonProperty("value") String value) {
    this.value = value;
    this.enabled = enabled;
}

assertThat(new ObjectMapper().readValue("{\"value\":\"+336\"}", Phone.class).value).isEqualTo("+336");
assertThat(new ObjectMapper().readValue("{\"value\":\"+336\",\"enabled\":true}", Phone.class).value).isEqualTo("+336");

这有点hacky,可能不会成为未来的证据

关于对象创建如何工作的文档很模糊;从我从代码中收集的内容来看,可以混合使用不同的方法:

例如,可以使用带有@JsonCreator

的静态工厂方法注释
@JsonCreator
public Phone(@JsonProperty("value") String value) {
    this.value = value;
    enabled = true;
}

@JsonCreator
public Phone(@JsonProperty("enabled") Boolean enabled, @JsonProperty("value") String value) {
    this.value = value;
    this.enabled = enabled;
}

@JsonCreator
public static Phone toPhone(String value) {
    return new Phone(value);
}

assertThat(new ObjectMapper().readValue("\"+336\"", Phone.class).value).isEqualTo("+336");
assertThat(new ObjectMapper().readValue("{\"value\":\"+336\"}", Phone.class).value).isEqualTo("+336");
assertThat(new ObjectMapper().readValue("{\"value\":\"+336\",\"enabled\":true}", Phone.class).value).isEqualTo("+336");

它有效,但并不理想。最后它可能有意义,例如如果json是 dynamic 那么可能应该使用委托构造函数来处理有效负载变化,而不是使用多个带注释的构造函数。

另请注意杰克逊orders creators by priority,例如在此代码中:

// Simple
@JsonCreator
public Phone(@JsonProperty("value") String value) {
    this.value = value;
}

// more
@JsonCreator
public Phone(Map<String, Object> properties) {
    value = (String) properties.get("value");

    // more logic
}

assertThat(new ObjectMapper().readValue("\"+336\"", Phone.class).value).isEqualTo("+336");
assertThat(new ObjectMapper().readValue("{\"value\":\"+336\"}", Phone.class).value).isEqualTo("+336");
assertThat(new ObjectMapper().readValue("{\"value\":\"+336\",\"enabled\":true}", Phone.class).value).isEqualTo("+336");

这次杰克逊不会引发错误,但Jackson只会使用委托构造函数Phone(Map<String, Object> properties),这意味着永远不会使用Phone(@JsonProperty("value") String value)

答案 2 :(得分:5)

如果我做对了你想要达到的目标,你可以解决它没有构造函数重载

如果您只想将空值放在JSON或Map中不存在的属性中,您可以执行以下操作:

@JsonIgnoreProperties(ignoreUnknown = true)
public class Person {
    private String name;
    private Integer age;
    public static final Integer DEFAULT_AGE = 30;

    @JsonCreator
    public Person(
        @JsonProperty("name") String name,
        @JsonProperty("age") Integer age) 
        throws IllegalArgumentException {
        if(name == null)
            throw new IllegalArgumentException("Parameter name was not informed.");
        this.age = age == null ? DEFAULT_AGE : age;
        this.name = name;
    }
}

当我找到你的问题时,这就是我的情况。我花了一些时间来弄清楚如何解决它,也许这就是你要做的事情。 @Brice solution对我不起作用。

答案 3 :(得分:2)

如果您不介意多做一些工作,可以手动反序列化实体:

@JsonDeserialize(using = Person.Deserializer.class)
public class Person {

    public Person(@JsonProperty("name") String name,
            @JsonProperty("age") int age) {
        // ... person with both name and age
    }

    public Person(@JsonProperty("name") String name) {
        // ... person with just a name
    }

    public static class Deserializer extends StdDeserializer<Person> {
        public Deserializer() {
            this(null);
        }

        Deserializer(Class<?> vc) {
            super(vc);
        }

        @Override
        public Person deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException {
            JsonNode node = jp.getCodec().readTree(jp);
            if (node.has("name") && node.has("age")) {
                String name = node.get("name").asText();
                int age = node.get("age").asInt();
                return new Person(name, age);
            } else if (node.has("name")) {
                String name = node.get("name").asText();
                return new Person("name");
            } else {
                throw new RuntimeException("unable to parse");
            }
        }
    }
}