Jackson enum сериализация и десериализатор

обратите внимание, что с этот коммит в июне 2015 (Джексон 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 были одинаковыми)...

Подробнее:

существует (еще) другой способ управления сериализацией и процесс десериализации с Джексоном. Вы можете указать эти примечания, чтобы использовать собственный сериализатор и десериализатор:

@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 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;
    }
}

существуют различные подходы, которые можно использовать для десериализации объекта 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;
    }
  }
}

вы можете настроить десериализацию для любого атрибута.

объявите свой класс десериализации, используя annotationJsonDeserialize (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;
    }
}

в контексте перечисления, используя @JsonValue теперь (начиная с 2.0) работает для сериализации и десериализации.

По словам Джексон-аннотации javadoc для @JsonValue:

Примечание: при использовании для перечислений Java одной дополнительной особенностью является то, что значение, возвращаемое аннотированным методом, также считается значением для десериализации, а не только строкой JSON для сериализации как. Это возможно, так как набор значений перечисления является постоянным и можно определить отображение, но не может быть сделано вообще для типов POJO; как таковой, это не используется для десериализации POJO.

поэтому Event перечисление аннотированный просто как выше (для сериализации и десериализации) с Джексоном 2.0+.