在空构造函数上使用 Jackson 的`@JsonCreator` 是一种反模式吗？

Question

我反复看到类似下面的代码，其中空的构造函数被好心的开发人员删除（因为它似乎未使用），然后破坏了 Jackson 序列化（后来被测试捕获）：

public class Person {
  private String name;
  private int age;
  
  // appears unused – only used by Jackson
  public Person() {}

  // used in code
  public Person(String name, int age) {
    this.name = name;
    this.age = age;
  }

  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }

  public int getAge() {
    return age;
  }
  public void setAge(int age) {
    this.age = age;
  }
}

我正在考虑在空构造函数中添加@JsonCreator 注释，以更清楚地表明Jackson 使用构造函数来防止开发人员将其删除：

public class Person {
  private String name;
  private int age;
  
  @JsonCreator // <--------
  public Person() {}

  // used in code
  public Person(String name, int age) {
    this.name = name;
    this.age = age;
  }

  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }

  public int getAge() {
    return age;
  }
  public void setAge(int age) {
    this.age = age;
  }
}

这是一个好主意还是会产生意想不到的后果（即，与无注释情况相比，语义发生了变化）？

或者@JsonCreator 的这种使用是一种反模式，并且有更好的方法来实现这一点（没有将类转换为记录）？

Answer 1

阅读更多关于此的文档以及关于问题和其他答案的所有 cmets，我得出的结论是，使用 @JsonCreator 作为默认构造函数确实是一种反模式。

Javadoc（例如from version 2.13）指定使用该注解注解的 ctor 应该至少有一个参数。 （它没有明确说明，但是没有参数的 ctor 或多或少是没用的。）

注意：注释创建者方法（构造函数、工厂方法）时，方法必须是：

• 单参数构造函数/工厂方法没有参数的 JsonProperty 注释：如果是这样，这就是所谓的“委托创建者”，在这种情况下，杰克逊首先将 JSON 绑定到参数的类型，然后调用创建者。这通常与 JsonValue 结合使用（用于序列化）。
• 构造函数/工厂方法，其中每个参数都使用 JsonProperty 或 JacksonInject 进行注释，以指示要绑定到的属性名称

因此，对于您的问题，我建议您摆脱默认 ctor，而是正确注释代码中使用的至少一个剩余 ctor。 Jackson 可以使用它，IDE 不会将其标记为未使用。

它还可以帮助您避免未正确或完全初始化对象的变通方法。

在您的示例中，这可能是

public class Person {
  private String name;
  private int age;

  @JsonCreator
  public Person(@JsonProperty("name") String name, @JsonProperty("age") int age) {
    this.name = name;
    this.age = age;
  }

  // other getters / setters / business logic come here

}

Answer 2

这是一种反模式，因为默认构造函数是@JsonCreator 默认值，每个人都知道 - 这是无用的代码。

您不需要阻止开发人员删除它，因为如果他们这样做，您的功能测试将会失败。