Джексон переслідує серіалізацію та DeSerializer

Я використовую 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

Що я тут пропускаю?

Рішення серіалізатора / десеріалізатора, на яке вказує @xbakesx, є чудовим рішенням, якщо ви хочете повністю відключити свій клас enum від його представлення на JSON.

Крім того, якщо ви віддаєте перевагу автономному рішенню, більш зручною буде реалізація на основі @JsonCreatorта @JsonValueприміток.

Отже, використовуючи на прикладі @Stanley, наступне є повноцінним автономним рішенням (Java 6, Джексон 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 року (Джексон 2.6.2 і вище) тепер ви можете просто написати:

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

Вам слід створити статичний заводський метод, який бере єдиний аргумент та анотувати його @JsonCreator(доступний з Jackson 1.2)

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

Детальніше про анотацію JsonCreator читайте тут .

Фактична відповідь:

Десеріалізатор за замовчуванням для enums використовує для деріаріалізації .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 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) для атрибута, який буде оброблений. Якщо це Enum:

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

У контексті перерахунку, використовуючи @JsonValueзараз (з 2.0) працює для серіалізації та десеріалізації.

Відповідно до анотацій Джексона javadoc для@JsonValue :

ПРИМІТКА. При використанні для перерахунків Java, додатковою особливістю є те, що значення, повернене методом із зауваженнями, також вважається значенням, яке деріаріалізується з, а не лише JSON String для серіалізації як. Це можливо, оскільки набір значень Enum є постійним і можна визначити відображення, але загалом це не можна зробити для типів POJO; як такий, це не використовується для десеріалізації POJO.

Тож зазначення Eventперерахунків, як зазначено вище, працює як для серіалізації, так і для десеріалізації) з Джексоном 2.0+.

Крім використання @JsonSerialize @JsonDeserialize, ви можете також використовувати SerializationFeature та DeserializationFeature (прив'язка Джексона) у картографіці об'єктів.

Такі як DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE, які дають тип перерахунку за замовчуванням, якщо наданий не визначений у класі enum.

Найпростіший спосіб, який я знайшов - це використання анотації @ 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"
}

Я сподіваюся, що це допомагає!