杰克逊何时需要无参数构造函数进行反序列化？

Question

在我的Spring开机项目中，我注意到了杰克逊奇怪的行为。我在网上搜索了一下，找到了该做什么，但还没找到原因。

用户收件人：

@Setter
@Getter
@AllArgsConstructor
public class UserDto {

    private String username;

    private String email;

    private String password;

    private String name;

    private String surname;

    private UserStatus status;

    private byte[] avatar;

    private ZonedDateTime created_at;
}

添加新用户效果很好。

TagDto：

@Setter
@Getter
@AllArgsConstructor
public class TagDto {

    private String tag;
}

尝试添加新标记以错误结束：

com.fasterxml.jackson.databind.exc.MismatchedInputException：无法构造TagDto的实例（尽管至少存在一个创建者）：无法从对象值反序列化（没有基于委托或属性的创建者）

该问题的解决方案是向TagDto类添加零参数构造函数。

为什么Jackson在TagDto中进行反序列化时不需要arg构造函数，而在UserDto中工作得很好？

使用相同的方法添加两者。我的标签和用户实体都用

@Entity
@Setter
@Getter
@NoArgsConstructor

并具有所有args构造函数：

@Entity
@Setter
@Getter
@NoArgsConstructor
public class User extends AbstractModel {

    private String username;

    private String password;

    private String email;

    private String name;

    private String surname;

    private UserStatus status;

    @Lob
    private byte[] avatar;

    @Setter(AccessLevel.NONE)
    private ZonedDateTime created_at;

    public User(final String username, final String password, final String email, final String name, final String surname) {
        this.username = username;
        this.password = password;
        this.email = email;
        this.name = name;
        this.surname = surname;
        this.created_at = ZonedDateTime.now();
    }
}

@Entity
@Setter
@Getter
@NoArgsConstructor
@AllArgsConstructor
public class Tag extends AbstractModel {

    private String tag;
}

@MappedSuperclass
@Getter
public abstract class AbstractModel {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private Integer id;
}

实体生成：

    @PostMapping(path = "/add")
    public ResponseEntity<String> add(@Valid @RequestBody final D dto) {
        this.abstractModelService.add(dto);
        return new ResponseEntity<>("Success", HttpStatus.CREATED);
    }
    
    public void add(final D dto) {
    //CRUD repository save method
        this.modelRepositoryInterface.save(this.getModelFromDto(dto));
    }

    @Override
    protected Tag getModelFromDto(final TagDto tagDto) {
        return new Tag(tagDto.getTag());
    }

    @Override
    protected User getModelFromDto(final UserDto userDto) {
        return new User(userDto.getUsername(), userDto.getPassword(), userDto.getEmail(), userDto.getName(), userDto.getSurname());
    }

解析JSON时出错

{"tag":"example"}

通过邮递员localhost:8081/tag/add，返回

{
    "timestamp": "2020-09-26T18:50:39.974+00:00",
    "status": 400,
    "error": "Bad Request",
    "message": "",
    "path": "/tag/add"
}

我正在使用Lombok v1.18.12和Spring boot 2.3.3。Jackson v2.11.2的发布。

Answer 1

TL；DR：解决方案已经结束。

Jackson支持多种创建Pojo的方法。以下列出了最常见的方法，但可能不是一个完整的列表：

>

不使用参数构造函数创建实例，然后调用setter方法来分配属性值。

public class Foo {
    private int id;

    public int getId() { return this.id; }

    @JsonProperty
    public void setId(int id) { this.id = id; }
}

指定JsonProperty是可选的，但可以用于微调映射，以及诸如JsonIgnore、JsonAnyGetter等注释。。。

使用带参数的构造函数创建实例。

public class Foo {
    private int id;

    @JsonCreator
    public Foo(@JsonProperty("id") int id) {
        this.id = id;
    }

    public int getId() {
        return this.id;
    }
}

为构造函数指定@JsonCreator是可选的，但我认为如果有多个构造函数，则需要指定。为参数指定@JsonProperty是可选的，但如果类文件中不包括参数名，则需要指定属性（-parameters编译器选项）。

参数意味着属性是必需的。可以使用setter方法设置可选属性。

使用工厂方法创建实例。

public class Foo {
    private int id;

    @JsonCreator
    public static Foo create(@JsonProperty("id") int id) {
        return new Foo(id);
    }

    private Foo(int id) {
        this.id = id;
    }

    public int getId() {
        return this.id;
    }
}

使用String构造函数从文本值创建实例。

public class Foo {
    private int id;

    @JsonCreator
    public Foo(String str) {
        this.id = Integer.parseInt(id);
    }

    public int getId() {
        return this.id;
    }

    @JsonValue
    public String asJsonValue() {
        return Integer.toString(this.id);
    }
}

当POJO具有简单的文本表示时，这很有用，例如，局部日期是具有3个属性（年、月、月）的POJO，但通常最好序列化为单个字符串（yyyy-MM-dd格式）@JsonValue标识序列化期间要使用的方法，而@JsonCreator标识反序列化期间要使用的构造函数/工厂方法。

注意：这也可以用于使用JSON值而不是字符串的单值构造，但这种情况非常罕见。

好的，这就是背景信息。对于问题中的示例来说，UserDto之所以有效，是因为只有一个构造函数（因此不需要JsonCreator）和许多参数（因此不需要JsonProperty）。

但是，对于TagDto，只有一个没有任何注释的单参数构造函数，因此Jackson将该构造函数分类为类型#4（来自我上面的列表），而不是类型#2。

这意味着它期望POJO是一个值类，其中封闭对象的JSON将是{...，"tag"："value"，...}，而不是{...，"tag"：{"tag"："example"}，...}。

为了解决这个问题，您需要通过在构造函数参数上指定@JsonProperty来告诉Jackson构造函数是属性初始化构造函数（#2），而不是值类型构造函数（#4）。

这意味着您不能让Lombok为您创建构造函数：

@Setter
@Getter
public class TagDto {

    private String tag;

    public TagDto(@JsonProperty("tag") String tag) {
        this.tag = tag;
    }
}