Jackson enum การทำให้เป็นอันดับและ 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

ฉันหายไปนี่อะไร

โซลูชั่น serializer / deserializer ชี้โดย@xbakesxเป็นวิธีที่ยอดเยี่ยมหากคุณต้องการแยกคลาสenumของคุณออกจากการแสดง JSON

อีกทางเลือกหนึ่งถ้าคุณต้องการโซลูชันที่มีในตัวเองการติดตั้ง@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 (แจ็คสัน 2.6.2 ขึ้นไป) ตอนนี้คุณสามารถเพียงแค่เขียน:

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

คุณควรสร้างเมธอดสแตติกแฟคตอรีซึ่งรับอาร์กิวเมนต์เดี่ยวและใส่คำอธิบายประกอบ@JsonCreator(มีให้ตั้งแต่ Jackson 1.2)

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

อ่านเพิ่มเติมเกี่ยวกับ JsonCreator คำอธิบายประกอบที่นี่

คำตอบจริง:

deserializer เริ่มต้นสำหรับการใช้ enums .name()เพื่อ deserialize @JsonValueดังนั้นจึงไม่ได้ใช้ ดังนั้นเมื่อ @OldCurmudgeon ชี้ให้เห็นคุณจะต้องผ่าน{"event": "FORGOT_PASSWORD"}เพื่อให้ตรงกับ.name()ค่า

ตัวเลือกอื่น (สมมติว่าคุณต้องการให้ค่าการเขียนและอ่าน json เหมือนกัน) ...

ข้อมูลเพิ่มเติม:

ยังมีอีกวิธีหนึ่งในการจัดการกระบวนการทำให้เป็นอันดับและการดีซีเรียลไลเซชันด้วยแจ็คสัน คุณสามารถระบุคำอธิบายประกอบเหล่านี้เพื่อใช้ serializer และ deserializer ที่คุณกำหนดเอง:

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

}

สุดท้ายเล็กน้อยโดยเฉพาะอย่างยิ่งสำหรับการทำสิ่งนี้กับ enum JsonEnumที่ทำให้เป็นอนุกรมด้วยวิธีการgetYourValue()serializer และ deserializer ของคุณอาจมีลักษณะเช่นนี้:

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

ฉันพบโซลูชันที่ดีและรัดกุมมากโดยเฉพาะอย่างยิ่งมีประโยชน์เมื่อคุณไม่สามารถแก้ไขคลาส enum ได้เหมือนในกรณีของฉัน จากนั้นคุณควรจัดเตรียม ObjectMapper แบบกำหนดเองที่เปิดใช้งานคุณลักษณะบางอย่าง คุณสมบัติเหล่านี้มีให้บริการตั้งแต่ Jackson 1.6 ดังนั้นคุณจะต้องเขียนtoString()วิธีการใน enum ของคุณ

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

มีคุณสมบัติที่เกี่ยวข้องกับ enum เพิ่มเติมดูที่นี่:

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

คุณสามารถกำหนดการ deserialization สำหรับแอตทริบิวต์ใด ๆ

ประกาศคลาส deserialize ของคุณโดยใช้ annotationJsonDeserialize ( 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 เป็น enum ได้ สไตล์ที่ฉันชอบคือการทำให้ชั้นใน:

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

ในบริบทของ enum การใช้@JsonValuenow (ตั้งแต่ 2.0) ใช้งานได้สำหรับการทำให้เป็นอนุกรมและดีซีเรียลไลเซชัน

อ้างอิงจากแจ็คสัน - คำอธิบายประกอบ javadoc สำหรับ@JsonValue :

หมายเหตุ: เมื่อใช้สำหรับ Enums ของ Java หนึ่งคุณลักษณะเพิ่มเติมคือค่าที่ส่งคืนโดยวิธีการใส่คำอธิบายประกอบจะถูกพิจารณาว่าเป็นค่าที่จะทำการ deserialize จากไม่ใช่แค่ JSON String เพื่อทำให้เป็นอนุกรม สิ่งนี้เป็นไปได้เนื่องจากชุดของค่า Enum เป็นค่าคงที่และเป็นไปได้ที่จะกำหนดการแมป แต่ไม่สามารถทำได้โดยทั่วไปสำหรับประเภท POJO เช่นนี้ไม่ได้ใช้สำหรับการดีซีเรียลไลซ์เซชัน POJO

ดังนั้นการให้Eventenum มีคำอธิบายประกอบเหมือนกับงานด้านบน (สำหรับทั้งการทำให้เป็นอนุกรมและการดีซีเรียลไลเซชัน) ด้วยแจ็คสัน 2.0+

นอกเหนือจากการใช้ @JsonSerialize @JsonDeserialize คุณยังสามารถใช้ SerializationFeature และ DeserializationFeature (การเชื่อมต่อแจ็คสัน) ในตัวแม็ปวัตถุ

เช่น DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE ซึ่งให้ประเภท enum เริ่มต้นหากไม่ได้กำหนดไว้ใน enum class

วิธีที่ง่ายที่สุดที่ฉันพบคือใช้คำอธิบายประกอบ @ JsonFormat.Shape.OBJECT สำหรับ enum

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

ทำให้เป็นอนุกรมและ deserializes json ต่อไปนี้:

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

ฉันหวังว่ามันจะช่วย!