Jackson enum Serializing and DeSerializer

Używam JAVA 1.6 i Jackson 1.9.9 Mam wyliczenie

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

Dodałem @JsonValue, wydaje się, że wykonuje to zadanie, w którym serializuje obiekt do:

{"event":"forgot password"}

ale kiedy próbuję deserializować, dostaję

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

Czego tu brakuje?

Rozwiązanie szeregujące / deserializujące wskazane przez @xbakesx jest doskonałe, jeśli chcesz całkowicie oddzielić swoją klasę enum od jej reprezentacji JSON.

Alternatywnie, jeśli wolisz samodzielne rozwiązanie, wygodniejsze byłoby wdrożenie oparte na adnotacjach @JsonCreatori @JsonValueadnotacjach.

Tak więc korzystając z przykładu @Stanley, poniższe jest kompletnym samodzielnym rozwiązaniem (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
    }
}

Zauważ, że od tego zatwierdzenia w czerwcu 2015 r. (Jackson 2.6.2 i wyżej) możesz teraz po prostu napisać:

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

Powinieneś stworzyć statyczną metodę fabryczną, która pobiera pojedynczy argument i adnotuje go @JsonCreator(dostępna od Jackson 1.2)

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

Przeczytaj więcej o adnotacjach JsonCreator tutaj .

Rzeczywista odpowiedź:

Domyślny deserializator dla wyliczeń używa .name()do deserializacji, więc nie używa @JsonValue. Tak jak wskazał @OldCurmudgeon, musisz przekazać, {"event": "FORGOT_PASSWORD"}aby dopasować .name()wartość.

Inna opcja (zakładając, że chcesz, aby zapis i odczyt wartości Json były takie same) ...

Więcej informacji:

Istnieje (jeszcze) inny sposób zarządzania procesem serializacji i deserializacji z Jacksonem. Możesz określić te adnotacje, aby użyć własnego niestandardowego serializatora i deserializatora:

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

Następnie musisz napisać MySerializeri MyDeserializerktóre wyglądają tak:

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

}

Na JsonEnumkoniec , szczególnie w przypadku wyliczenia szeregowego za pomocą metody getYourValue(), Twój serializator i deserializator mogą wyglądać następująco:

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

Znalazłem bardzo miłe i zwięzłe rozwiązanie, szczególnie przydatne, gdy nie możesz modyfikować klas enum, jak to było w moim przypadku. Następnie powinieneś dostarczyć niestandardowy ObjectMapper z włączoną określoną funkcją. Te funkcje są dostępne od wersji Jackson 1.6. Musisz tylko napisać toString()metodę w swoim wyliczeniu.

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

Dostępnych jest więcej funkcji związanych z wyliczaniem, patrz tutaj:

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

Spróbuj tego.

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

Możesz dostosować deserializację dla dowolnego atrybutu.

Zadeklaruj swoją deserializowaną klasę za pomocą adnotacjiJsonDeserialize ( import com.fasterxml.jackson.databind.annotation.JsonDeserialize) dla atrybutu, który zostanie przetworzony. Jeśli jest to Enum:

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

W ten sposób twoja klasa zostanie wykorzystana do deserializacji atrybutu. To jest pełny przykład:

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

Istnieją różne podejścia do deserializacji obiektu JSON do wyliczenia. Moim ulubionym stylem jest stworzenie klasy wewnętrznej:

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

Oto kolejny przykład, który używa wartości ciągu zamiast mapy.

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

W kontekście wyliczenia użycie @JsonValueteraz (od 2.0) działa na serializacji i deserializacji.

Według javadoc jackson-adnotations dla@JsonValue :

UWAGA: podczas korzystania z wyliczeń Java, jedną dodatkową cechą jest to, że wartość zwracana przez metodę z adnotacjami jest również uważana za wartość do deserializacji, a nie tylko ciąg JSON do serializacji. Jest to możliwe, ponieważ zestaw wartości Enum jest stały i możliwe jest zdefiniowanie odwzorowania, ale ogólnie nie można tego zrobić dla typów POJO; jako taki nie jest wykorzystywany do deserializacji POJO.

Tak więc Eventwyliczanie adumacji tak jak powyżej działa (zarówno w przypadku serializacji, jak i deserializacji) z jacksonem 2.0+.

Oprócz używania @JsonSerialize @JsonDeserialize, możesz również użyć SerializationFeature i DeserializationFeature (powiązanie Jacksona) w maperze obiektów.

Takie jak DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE, które dają domyślny typ wyliczenia, jeśli podany nie jest zdefiniowany w klasie wyliczania.

Najprostszym sposobem, jaki znalazłem, jest użycie adumacji @ JsonFormat.Shape.OBJECT dla wyliczenia.

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

W moim przypadku to rozwiązało:

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

Serializuje i deserializuje następujący plik Json:

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

Mam nadzieję, że to pomoże!