使用 Kotlin 数据区分 Jackson 中 null 和缺失的属性类

Question

我想使用 Jackson 反序列化，然后使用 Kotlin 的数据 classes 序列化 jsons。重要的是我要保持显式空属性和属性之间的区别，后者在原始 json.

中被省略

我有一个大型领域模型（50+ classes）几乎完全由 Kotlin 数据 classes 构建。 Kotlin 的数据 classes 提供了很多有用的功能，我需要在我的程序的其他地方使用它们，因此我想保留它们而不是转换我的模型。

我目前可以使用此代码，但仅适用于 Java classes 或使用在 Kotlin class 主体中声明的 Kotlin 属性，不适用于属性在构造函数中声明。要使 Kotlin 的数据 class 实用函数起作用，必须在构造函数中声明所有属性。

这是我的对象映射器设置代码：

val objectMapper = ObjectMapper()

objectMapper.registerModule(KotlinModule())
objectMapper.registerModule(Jdk8Module())

objectMapper.setSerializationInclusion(JsonInclude.Include.ALWAYS)
objectMapper.configOverride(Optional::class.java).includeAsProperty =
    JsonInclude.Value.construct(JsonInclude.Include.NON_NULL, null)

objectMapper.configure(DeserializationFeature.FAIL_ON_NULL_FOR_PRIMITIVES, true)

objectMapper.configure(JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN, true)

objectMapper.configure(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS, true)
objectMapper.nodeFactory = JsonNodeFactory.withExactBigDecimals(true)

这是我的测试 classes:

TestClass1.java

public class TestClass1 {
    public TestClass1() {}
    public TestClass1(int intVal, Optional<Double> optDblVal) {
        this.intVal = intVal;
        this.optDblVal = optDblVal;
    }
    public Integer intVal;
    public Optional<Double> optDblVal;
}

TestClasses.kt

data class TestClass2(val intVal: Int?, val optDblVal: Optional<Double>?)

class TestClass3(val intVal: Int?, val optDblVal: Optional<Double>?)

class TestClass4 {
    val intVal: Int? = null
    val optDblVal: Optional<Double>? = null
}

这是我的测试：

JsonReserializationTests.kt

@Test
fun `Test 1 - Explicit null Double reserialized as explicit null`() {
    val inputJson = """
        {
          "intVal" : 7,
          "optDblVal" : null
        }
        """.trimIndent()

    val intermediateObject = handler.objectMapper.readValue(inputJson, TestClassN::class.java)
    val actualJson = handler.objectMapper
        .writerWithDefaultPrettyPrinter()
        .writeValueAsString(intermediateObject)
        .replace("\r", "")

    assertEquals(inputJson, actualJson)
}

@Test
fun `Test 2 - Missing Double not reserialized`() {
    val inputJson = """
        {
          "intVal" : 7
        }
        """.trimIndent()

    val intermediateObject = handler.objectMapper.readValue(inputJson, TestClassN::class.java)
    val actualJson = handler.objectMapper
        .writerWithDefaultPrettyPrinter()
        .writeValueAsString(intermediateObject)
        .replace("\r", "")

    assertEquals(inputJson, actualJson)
}

每个 class

的测试结果

Answer 1

我们来谈谈TestClass2。

如果将Kotlin代码转换成Java代码，就可以找到原因。

Intellij 为 Kotlin 提供了一个转换工具。您可以从菜单中找到它 Tools -> Kotlin -> Show Kotlin Bytecode.

这是来自 TestClass2 Kotlin 代码的 Java 代码。

public final class TestClass2 {
   @Nullable
   private final Integer intVal;
   @Nullable
   private final Optional optDblVal;

   @Nullable
   public final Integer getIntVal() {
      return this.intVal;
   }

   @Nullable
   public final Optional getOptDblVal() {
      return this.optDblVal;
   }

   public TestClass2(@Nullable Integer intVal, @Nullable Optional optDblVal) {
      this.intVal = intVal;
      this.optDblVal = optDblVal;
   }

   @Nullable
   public final Integer component1() {
      return this.intVal;
   }

   @Nullable
   public final Optional component2() {
      return this.optDblVal;
   }

   @NotNull
   public final TestClass2 copy(@Nullable Integer intVal, @Nullable Optional optDblVal) {
      return new TestClass2(intVal, optDblVal);
   }

   // $FF: synthetic method
   public static TestClass2 copy$default(TestClass2 var0, Integer var1, Optional var2, int var3, Object var4) {
      if ((var3 & 1) != 0) {
         var1 = var0.intVal;
      }

      if ((var3 & 2) != 0) {
         var2 = var0.optDblVal;
      }

      return var0.copy(var1, var2);
   }

   @NotNull
   public String toString() {
      return "TestClass2(intVal=" + this.intVal + ", optDblVal=" + this.optDblVal + ")";
   }

   public int hashCode() {
      Integer var10000 = this.intVal;
      int var1 = (var10000 != null ? var10000.hashCode() : 0) * 31;
      Optional var10001 = this.optDblVal;
      return var1 + (var10001 != null ? var10001.hashCode() : 0);
   }

   public boolean equals(@Nullable Object var1) {
      if (this != var1) {
         if (var1 instanceof TestClass2) {
            TestClass2 var2 = (TestClass2)var1;
            if (Intrinsics.areEqual(this.intVal, var2.intVal) && Intrinsics.areEqual(this.optDblVal, var2.optDblVal)) {
               return true;
            }
         }

         return false;
      } else {
         return true;
      }
   }

原代码太长，这里只给出构造函数

public TestClass2(@Nullable Integer intVal, @Nullable Optional optDblVal) {
      this.intVal = intVal;
      this.optDblVal = optDblVal;
}

由于Jackson库无法创建无参数实例，因为没有无参数构造函数，它会尝试创建一个带有一些参数的新实例。对于测试用例2，JSON只有一个参数，所以它会寻找一个单参数的构造函数，但是没有，它会抛出异常。这也是测试用例1通过的原因。

因此，您需要做的是，您必须为 data class 的所有参数提供所有默认值，以创建如下代码的无参数构造函数。

data class TestClass2(val intVal: Int? = null, val optDblVal: Optional<Double>? = null)

然后，如果您在 Java 代码中看到，class 将有一个无参数构造函数。

   public TestClass2(@Nullable Integer intVal, @Nullable Optional optDblVal) {
      this.intVal = intVal;
      this.optDblVal = optDblVal;
   }

   // $FF: synthetic method
   public TestClass2(Integer var1, Optional var2, int var3, DefaultConstructorMarker var4) 
   {
      if ((var3 & 1) != 0) {
         var1 = (Integer)null;
      }

      if ((var3 & 2) != 0) {
         var2 = (Optional)null;
      }

      this(var1, var2);
   }

   public TestClass2() {
      this((Integer)null, (Optional)null, 3, (DefaultConstructorMarker)null);
   }

因此，如果您仍想使用 Kotlin 数据 class，则必须为所有变量提供默认值。

Answer 2

我刚刚找到了 Kotiln 插件，它可以自动为数据 class 创建 no-argument 构造函数。这应该可以帮助您，而无需进行太多编辑。但是，这不是一个好的设计模式，所以我还是建议给所有成员默认值。

这是 Kotlin NoArg 插件link

https://kotlinlang.org/docs/reference/compiler-plugins.html#no-arg-compiler-plugin

Answer 3

data class Example(
  val greeting: Optional<String>? = null
)

这使您可以区分 JSON 中的所有三种情况：

non-null 值 ({"greeting":"hello"} → greeting.isPresent() == true)
空值 ({"greeting":null} → greeting.isPresent() == false)
不存在 ({ } → greeting == null)

这只是对@Pemassi 提供的内容的简要总结，关键见解是对可为空的 Optional<T> 成员进行默认 null 赋值。

请注意，.isPresent() 的语义可能会让不经意的观察者感到困惑，因为它 而不是 指的是 [=40= 中存在的值].

完整的单元测试演示是 here。

使用 Kotlin 数据区分 Jackson 中 null 和缺失的属性类

Distinguish null from missing properties in Jackson using Kotlin data classes

serialization

json

optional

jackson

kotlin

使用 Kotlin 数据区分 Jackson 中 null 和缺失的属性 类

Distinguish null from missing properties in Jackson using Kotlin data classes

serialization

json

optional

jackson

kotlin

使用 Kotlin 数据区分 Jackson 中 null 和缺失的属性类