杰克逊：如果财产丢失怎么办？

Question

如果我使用 @JsonProperty 注释构造函数参数但 Json 没有指定该属性会发生什么。构造函数得到什么值？

如何区分具有空值的属性与 JSON 中不存在的属性？

Answer 1

如果我使用 @JsonProperty 注释构造函数参数但 Json 没有指定该属性会发生什么。构造函数得到什么值？

对于这样的问题，我喜欢写一个示例程序，看看会发生什么。

下面是这样一个示例程序。

import org.codehaus.jackson.annotate.JsonProperty;
import org.codehaus.jackson.map.ObjectMapper;

public class JacksonFoo
{
  public static void main(String[] args) throws Exception
  {
    ObjectMapper mapper = new ObjectMapper();

    // {"name":"Fred","id":42}
    String jsonInput1 = "{\"name\":\"Fred\",\"id\":42}";
    Bar bar1 = mapper.readValue(jsonInput1, Bar.class);
    System.out.println(bar1);
    // output: 
    // Bar: name=Fred, id=42

    // {"name":"James"}
    String jsonInput2 = "{\"name\":\"James\"}";
    Bar bar2 = mapper.readValue(jsonInput2, Bar.class);
    System.out.println(bar2);
    // output:
    // Bar: name=James, id=0

    // {"id":7}
    String jsonInput3 = "{\"id\":7}";
    Bar bar3 = mapper.readValue(jsonInput3, Bar.class);
    System.out.println(bar3);
    // output:
    // Bar: name=null, id=7
  }
}

class Bar
{
  private String name = "BLANK";
  private int id = -1;

  Bar(@JsonProperty("name") String n, @JsonProperty("id") int i)
  {
    name = n;
    id = i;
  }

  @Override
  public String toString()
  {
    return String.format("Bar: name=%s, id=%d", name, id);
  }
}

结果是构造函数被传递了数据类型的默认值。

如何区分具有空值的属性与 JSON 中不存在的属性？

一种简单的方法是在反序列化处理后检查默认值，因为如果元素存在于 JSON 中但具有空值，那么空值将用于替换给定相应 Java 字段的任何默认值.例如：

import org.codehaus.jackson.annotate.JsonAutoDetect.Visibility;
import org.codehaus.jackson.annotate.JsonMethod;
import org.codehaus.jackson.map.ObjectMapper;

public class JacksonFooToo
{
  public static void main(String[] args) throws Exception
  {
    ObjectMapper mapper = new ObjectMapper().setVisibility(JsonMethod.FIELD, Visibility.ANY);

    // {"name":null,"id":99}
    String jsonInput1 = "{\"name\":null,\"id\":99}";
    BarToo barToo1 = mapper.readValue(jsonInput1, BarToo.class);
    System.out.println(barToo1);
    // output:
    // BarToo: name=null, id=99

    // {"id":99}
    String jsonInput2 = "{\"id\":99}";
    BarToo barToo2 = mapper.readValue(jsonInput2, BarToo.class);
    System.out.println(barToo2);
    // output:
    // BarToo: name=BLANK, id=99

    // Interrogate barToo1 and barToo2 for 
    // the current value of the name field.
    // If it's null, then it was null in the JSON.
    // If it's BLANK, then it was missing in the JSON.
  }
}

class BarToo
{
  String name = "BLANK";
  int id = -1;

  @Override
  public String toString()
  {
    return String.format("BarToo: name=%s, id=%d", name, id);
  }
}

另一种方法是实现一个自定义的反序列化器来检查所需的 JSON 元素。还有一种方法是在http://jira.codehaus.org/browse/JACKSON@Jackson 项目中记录增强请求

Answer 2

除了@Programmer_Bruce 的回答中解释的构造函数行为之外，区分空值和缺失值的一种方法是定义一个 setter：setter 只用显式的 null 值调用。 如果您想跟踪设置的值，自定义设置器可以设置一个私有布尔标志（“isValueSet”或其他）。

如果字段和设置器都存在，则设置器优先于字段，因此您也可以通过这种方式“覆盖”行为。

Answer 3

总结Programmer Bruce和StaxMan的优秀答案：

1. 构造函数引用的缺失属性被分配一个默认值as defined by Java。

2. 您可以使用 setter 方法来区分隐式或显式设置的属性。仅对具有显式值的属性调用 Setter 方法。 Setter 方法可以跟踪是否使用布尔标志（例如isValueSet）显式设置了属性。

Answer 4

我正在考虑使用 Option 类风格的东西，其中 Nothing 对象会告诉我是否存在这样的值。有没有人用 Jackson 做过类似的事情（用 Java，而不是 Scala 等）？

Answer 5

（我的回答可能对某些通过谷歌找到这个帖子的人有用，即使它没有回答 OP 问题）
如果您正在处理可省略的原始类型，并且您不想使用其他答案中描述的设置器（例如，如果您希望您的字段是最终的），您可以使用框对象：

public class Foo {
    private final int number;
    public Foo(@JsonProperty Integer number) {
        if (number == null) {
            this.number = 42; // some default value
        } else {
            this.number = number;
        }
    }
}

如果 JSON 实际包含 null，则此方法不起作用，但如果您知道它仅包含原语或不包含，则它就足够了

Answer 6

另一种选择是在反序列化后手动或通过框架（如 java bean 验证）验证对象，或者，如果您使用的是 spring，则支持 spring 验证。