Jackson枚举序列化和反序列化器

我正在使用JAVA 1.6和Jackson 1.9.9我有一个枚举

public enum Event {
    FORGOT_PASSWORD("forgot password");

    private final String value;

    private Event(final String description) {
        this.value = description;
    }

    @JsonValue
    final String value() {
        return this.value;
    }
}

我添加了一个@JsonValue，这似乎可以将对象序列化为：

{"event":"forgot password"}

但是当我尝试反序列化时，我得到了

Caused by: org.codehaus.jackson.map.JsonMappingException: Can not construct instance of com.globalrelay.gas.appsjson.authportal.Event from String value 'forgot password': value not one of declared Enum instance names

我在这里想念什么？

如果您希望将枚举类与其JSON表示完全脱钩，则@xbakesx指出的序列化器/反序列化器解决方案是一个很好的解决方案。

另外，如果您希望使用独立的解决方案，则基于@JsonCreator和@JsonValue注释的实现会更方便。

因此，利用@Stanley的示例，以下是一个完整的自包含解决方案（Java 6，Jackson 1.9）：

public enum DeviceScheduleFormat {

    Weekday,
    EvenOdd,
    Interval;

    private static Map<String, DeviceScheduleFormat> namesMap = new HashMap<String, DeviceScheduleFormat>(3);

    static {
        namesMap.put("weekday", Weekday);
        namesMap.put("even-odd", EvenOdd);
        namesMap.put("interval", Interval);
    }

    @JsonCreator
    public static DeviceScheduleFormat forValue(String value) {
        return namesMap.get(StringUtils.lowerCase(value));
    }

    @JsonValue
    public String toValue() {
        for (Entry<String, DeviceScheduleFormat> entry : namesMap.entrySet()) {
            if (entry.getValue() == this)
                return entry.getKey();
        }

        return null; // or fail
    }
}

请注意，自2015年6月提交此内容（杰克逊2.6.2及更高版本）起，您现在可以简单地编写：

public enum Event {
    @JsonProperty("forgot password")
    FORGOT_PASSWORD;
}

您应该创建一个静态工厂方法，该方法采用单个参数并用对其进行注释@JsonCreator（自Jackson 1.2起可用）。

@JsonCreator
public static Event forValue(String value) { ... }

在此处阅读有关JsonCreator注释的更多信息。

实际答案：

枚举的默认反序列化器用于.name()反序列化，因此不使用@JsonValue。因此，正如@OldCurmudgeon指出的那样，您需要传递{"event": "FORGOT_PASSWORD"}以匹配该.name()值。

另一个选项（假设您希望写入和读取json值相同）...

更多信息：

还有（另一种）使用Jackson来管理序列化和反序列化过程的方法。您可以指定以下批注以使用自己的自定义序列化器和反序列化器：

@JsonSerialize(using = MySerializer.class)
@JsonDeserialize(using = MyDeserializer.class)
public final class MyClass {
    ...
}

那你得写 MySerializer和MyDeserializer它看起来像这样：

MySerializer

public final class MySerializer extends JsonSerializer<MyClass>
{
    @Override
    public void serialize(final MyClass yourClassHere, final JsonGenerator gen, final SerializerProvider serializer) throws IOException, JsonProcessingException
    {
        // here you'd write data to the stream with gen.write...() methods
    }

}

MyDeserializer

public final class MyDeserializer extends org.codehaus.jackson.map.JsonDeserializer<MyClass>
{
    @Override
    public MyClass deserialize(final JsonParser parser, final DeserializationContext context) throws IOException, JsonProcessingException
    {
        // then you'd do something like parser.getInt() or whatever to pull data off the parser
        return null;
    }

}

最后一点，特别是对于对JsonEnum使用该方法进行序列化的枚举执行此操作时getYourValue()，您的序列化器和反序列化器可能如下所示：

public void serialize(final JsonEnum enumValue, final JsonGenerator gen, final SerializerProvider serializer) throws IOException, JsonProcessingException
{
    gen.writeString(enumValue.getYourValue());
}

public JsonEnum deserialize(final JsonParser parser, final DeserializationContext context) throws IOException, JsonProcessingException
{
    final String jsonValue = parser.getText();
    for (final JsonEnum enumValue : JsonEnum.values())
    {
        if (enumValue.getYourValue().equals(jsonValue))
        {
            return enumValue;
        }
    }
    return null;
}

我找到了一个非常简洁的解决方案，当您无法修改枚举类时尤其有用。然后，您应该提供一个启用了某些功能的自定义ObjectMapper。这些功能自Jackson 1.6开始可用。因此，您只需要toString()在枚举中编写方法。

public class CustomObjectMapper extends ObjectMapper {
    @PostConstruct
    public void customConfiguration() {
        // Uses Enum.toString() for serialization of an Enum
        this.enable(WRITE_ENUMS_USING_TO_STRING);
        // Uses Enum.toString() for deserialization of an Enum
        this.enable(READ_ENUMS_USING_TO_STRING);
    }
}

还有更多与枚举相关的功能，请参见此处：

https://github.com/FasterXML/jackson-databind/wiki/Serialization-Features https://github.com/FasterXML/jackson-databind/wiki/Deserialization-Features

试试这个。

public enum Event {

    FORGOT_PASSWORD("forgot password");

    private final String value;

    private Event(final String description) {
        this.value = description;
    }

    private Event() {
        this.value = this.name();
    }

    @JsonValue
    final String value() {
        return this.value;
    }
}

您可以为任何属性定制反序列化。

使用注解JsonDeserialize（import com.fasterxml.jackson.databind.annotation.JsonDeserialize）声明将要反序列化的类的属性。如果这是一个枚举：

@JsonDeserialize(using = MyEnumDeserialize.class)
private MyEnum myEnum;

这样，您的类将用于反序列化属性。这是一个完整的示例：

public class MyEnumDeserialize extends JsonDeserializer<MyEnum> {

    @Override
    public MyEnum deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException {
        JsonNode node = jsonParser.getCodec().readTree(jsonParser);
        MyEnum type = null;
        try{
            if(node.get("attr") != null){
                type = MyEnum.get(Long.parseLong(node.get("attr").asText()));
                if (type != null) {
                    return type;
                }
            }
        }catch(Exception e){
            type = null;
        }
        return type;
    }
}

您可以采用多种方法来将JSON对象反序列化为枚举。我最喜欢的样式是制作内部类：

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.hibernate.validator.constraints.NotEmpty;

import java.util.Arrays;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;

import static com.fasterxml.jackson.annotation.JsonFormat.Shape.OBJECT;

@JsonFormat(shape = OBJECT)
public enum FinancialAccountSubAccountType {
  MAIN("Main"),
  MAIN_DISCOUNT("Main Discount");

  private final static Map<String, FinancialAccountSubAccountType> ENUM_NAME_MAP;
  static {
    ENUM_NAME_MAP = Arrays.stream(FinancialAccountSubAccountType.values())
      .collect(Collectors.toMap(
        Enum::name,
        Function.identity()));
  }

  private final String displayName;

  FinancialAccountSubAccountType(String displayName) {
    this.displayName = displayName;
  }

  @JsonCreator
  public static FinancialAccountSubAccountType fromJson(Request request) {
    return ENUM_NAME_MAP.get(request.getCode());
  }

  @JsonProperty("name")
  public String getDisplayName() {
    return displayName;
  }

  private static class Request {
    @NotEmpty(message = "Financial account sub-account type code is required")
    private final String code;
    private final String displayName;

    @JsonCreator
    private Request(@JsonProperty("code") String code,
                    @JsonProperty("name") String displayName) {
      this.code = code;
      this.displayName = displayName;
    }

    public String getCode() {
      return code;
    }

    @JsonProperty("name")
    public String getDisplayName() {
      return displayName;
    }
  }
}

这是另一个使用字符串值而不是映射的示例。

public enum Operator {
    EQUAL(new String[]{"=","==","==="}),
    NOT_EQUAL(new String[]{"!=","<>"}),
    LESS_THAN(new String[]{"<"}),
    LESS_THAN_EQUAL(new String[]{"<="}),
    GREATER_THAN(new String[]{">"}),
    GREATER_THAN_EQUAL(new String[]{">="}),
    EXISTS(new String[]{"not null", "exists"}),
    NOT_EXISTS(new String[]{"is null", "not exists"}),
    MATCH(new String[]{"match"});

    private String[] value;

    Operator(String[] value) {
        this.value = value;
    }

    @JsonValue
    public String toStringOperator(){
        return value[0];
    }

    @JsonCreator
    public static Operator fromStringOperator(String stringOperator) {
        if(stringOperator != null) {
            for(Operator operator : Operator.values()) {
                for(String operatorString : operator.value) {
                    if (stringOperator.equalsIgnoreCase(operatorString)) {
                        return operator;
                    }
                }
            }
        }
        return null;
    }
}

在枚举的上下文中，使用@JsonValuenow（从2.0开始）可进行序列化和反序列化。

根据javason的jackson-annotations@JsonValue：

注意：当用于Java枚举时，一个附加功能是带注释的方法返回的值也被视为要反序列化的值，而不仅仅是序列化为JSON字符串的值。这是可能的，因为Enum值的集合是恒定的，并且可以定义映射，但是通常不能对POJO类型执行此操作。因此，这不适用于POJO反序列化。

因此，对Event杰克逊2.0+ 的枚举进行上述注释（适用于序列化和反序列化）。

除了使用@JsonSerialize @JsonDeserialize，您还可以在对象映射器中使用SerializationFeature和DeserializationFeature（杰克逊绑定）。

如DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE，如果未在枚举类中定义提供的枚举类型，则将提供默认枚举类型。

我发现的最简单的方法是对枚举使用@ JsonFormat.Shape.OBJECT批注。

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum MyEnum{
    ....
}

就我而言，这是解决的方法：

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonProperty;

@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum PeriodEnum {

    DAILY(1),
    WEEKLY(2),
    ;

    private final int id;

    PeriodEnum(int id) {
        this.id = id;
    }

    public int getId() {
        return id;
    }

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

    @JsonCreator
    public static PeriodEnum fromJson(@JsonProperty("name") String name) {
        return valueOf(name);
    }
}

序列化和反序列化以下json：

{
  "id": 2,
  "name": "WEEKLY"
}

希望对您有所帮助！