使用 Jackson 反序列化枚举字段

Question

我有一个简单的枚举Days

public enum Days {
    @JsonProperty("Monday")
    MONDAY("Monday"),
    @JsonProperty("Tuesday")
    TUESDAY("Tuesday");

    private String day;

    Days(String day) {
        this.day = day;
    }

    @JsonValue
    public String getDay() {
        return day;
    }
}

和一个班级Event

public class Event {
    private Days day;
    private String name;


    @JsonCreator
    public Event(@JsonProperty("day") Days day,
             @JsonProperty("name") String name) {
    this.day = day;
    this.name = name;
}

    public Days getDay() {
        return day;
    }

    public String getName() {
        return name;
    }
}

我正在使用 Jackson 2.9，这个答案表明使用@JsonProperty应该就足够了，但是我很难反序列化：

public static void main(String[] args) throws JsonProcessingException {
    ObjectMapper objectMapper = new ObjectMapper();
    Event event = new Event(Days.MONDAY, "Birthday");

    String serialisedEvent = objectMapper.writeValueAsString(event);
    System.out.println(serialisedEvent);
    // {"day":"Monday","name":"Birthday"}

    Event deserialisedEvent = objectMapper.convertValue(serialisedEvent, Event.class);
    // Exception in thread "main" java.lang.IllegalArgumentException: Cannot construct instance of `xyz.blabla.Event` (although at least one Creator exists): no String-argument constructor/factory method to deserialize from String value ('{"day":"Monday","name":"Birthday"}')
    // at [Source: UNKNOWN; line: -1, column: -1]
    // at com.fasterxml.jackson.databind.ObjectMapper._convert(ObjectMapper.java:3750)
    System.out.println(deserialisedEvent.getDay());
}

我在 Spring Boot 2 项目中使用 Java 11 和 Jackson 2.9。 我怎样才能使这项工作？

Answer 1

Jackson 反序列化方法称为readValue 。

convertValue的目的是不同的——它首先序列化一个对象（可能是一个字符串——然后它会变成一个 JSON-string-literal），然后将结果反序列化为目标类型的对象。

以下应该工作：

Event deserialisedEvent = objectMapper.readValue(serialisedEvent, Event.class);

Answer 2

您没有默认构造函数，而是一个 arg 构造函数。

您必须使用@JsonCreator进行注释，以便 Jackson 使用它来反序列化 JSON ：

@JsonCreator 
public Event(Days day, String name) {
    this.day = day;
    this.name = name;
}

要将 Java 对象序列化为 JSON，Jackson 不使用构造函数，因为它不创建 Java 实例，而只是使用 getter 来检索它的属性。 所以它奏效了。 但是要将 JSON 反序列化为 Java 对象，Jackson 需要实例化目标类。 默认情况下，它会查找 no arg 构造函数。

另请注意，如果您使用ParameterNamesModule ，则不需要使用@JsonProperty("...")注释构造函数参数，例如：

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new ParameterNamesModule());

Spring Boot 2 为您提供了它，因为您依赖于 Jackson。
在这里您需要它，因为您不使用 Spring Boot 的 Mapper 接线，而是您自己实例化它。

以及位于枚举中的@JsonProperty注释也不需要：

public enum Days {
    @JsonProperty("Monday")
    MONDAY("Monday"),
    @JsonProperty("Tuesday")
    TUESDAY("Tuesday");
    //...
}

它允许更改枚举的序列化输出，但实际上您不需要更改它，因为您将其映射到当前用于枚举 Jackson 映射的day字段值...

Answer 3

为了补充这个答案，我在互联网上搜索，寻找如何将 ONE-TIME 添加为枚举值（并将其与破折号一起保存）。 注意：枚举不允许有破折号。 我通过简单地添加来解决这个问题

@JsonProperty("ONE-TIME")

在枚举字段声明之上。