如何在Jackson的json序列化过程中向对象添加额外字段？

Question

在序列化为JSON时，我需要向对象添加新属性。该属性的值是在运行时计算的，在对象中不存在。同样，同一个对象也可以用于创建具有不同集合ot字段的不同JSON（有点像是有一个带有子类的基类，但我不想创建一个只用于JSON生成的基类）。

最好的方法是什么，它不涉及创建自定义序列化器类，它将处理整个对象字段集的序列化？或者可能继承一些“基本”序列化器，然后简单地获取它的输出并以某种方式添加新字段？

我了解了mixin，看起来可以重命名/隐藏一些字段，但是似乎不可能添加额外的字段。

Answer 1

2021年来电...

我发现最简单的方法是@JsonUnwrapped：

public class Envelope<T> {
  @JsonUnwrapped // content's fields are promoted alongside the envelope's
  public T content;
  // Transmission specific fields
  public String url;
  public long timestamp;
}

只要Envelope的字段名称与Content字段名称不冲突，就可以（双向）工作。还有一个很好的特性是在序列化JSON的末尾保留传输属性。

Answer 2

一个选项是为该属性添加一个字段，并在写入JSON之前在对象上设置它。第二个选项，如果属性可以从其他对象属性计算，你可以为它添加一个getter，例如：

public String getFullName() {
  return getFirstName() + " " + getLastName();
}

即使没有匹配的字段，Jackson在编写JSON时也会自动调用这个getter，并在JSON输出中显示为fullName。如果这不起作用，第三个选项是将对象转换为贴图，然后根据需要对其进行操作：

ObjectMapper mapper //.....
MyObject o //.....
long specialValue //.....
Map<String, Object> map = mapper.convertValue(o, new TypeReference<Map<String, Object>>() { });
map.put("specialValue", specialValue);

你的问题没有提到解组，但是如果你也需要这样做，那么第一个选项会很好，但是第二个选项需要一些调整。

至于编写同一对象的不同字段，这听起来像是@JsonView

Answer 3

你能不能在value类中添加一个方法？注意，它不必是公共的，也不必使用getter命名约定；你可以这样做：

public class MyStuff {
   // ... the usual fields, getters and/or setters

   @JsonProperty("sum") // or whatever name you need in JSON
   private int calculateSumForJSON() {
        return 42; // calculate somehow
   }
}

否则，您可以将POJO转换为JSON树值：

JsonNode tree = mapper.valueToTree(value);

然后通过添加属性等方式对其进行修改。