Serializacja wyliczeń z Jacksonem

90

Mam Enum opisane poniżej:

public enum OrderType {

  UNKNOWN(0, "Undefined"),
  TYPEA(1, "Type A"),
  TYPEB(2, "Type B"),
  TYPEC(3, "Type C");

  private Integer id;
  private String name;

  private WorkOrderType(Integer id, String name) {
    this.id = id;
    this.name = name;
  }

  //Setters, getters....
}

Zwracam tablicę wyliczeń z moim kontrolerem ( new OrderType[] {UNKNOWN,TYPEA,TYPEB,TYPEC};), a Spring serializuje ją do następującego ciągu json:

["UNKNOWN", "TYPEA", "TYPEB", "TYPEC"]

Jakie jest najlepsze podejście, aby zmusić Jacksona do serializacji wyliczeń, tak jak POJO? Na przykład:

[
  {"id": 1, "name": "Undefined"},
  {"id": 2, "name": "Type A"},
  {"id": 3, "name": "Type B"},
  {"id": 4, "name": "Type C"}
]

Bawiłem się różnymi adnotacjami, ale nie udało mi się uzyskać takiego wyniku.

java  json  spring  spring-mvc  jackson 
— Nofate
źródło
1
Wygląda na to, że już znalazłeś rozwiązanie; świetny! Byłeś ciekawy, dlaczego tego potrzebujesz?
— StaxMan
Rozwijam aplikację GWT, która komunikuje się z serwerem za pomocą JSON. To wyliczenie zapewni wartości opcji dla combobox.
— Nofate
Ach ok. Taka krótka ręka dla zestawu wartości ... interesująca.
— StaxMan

Odpowiedzi:

87

W końcu sam znalazłem rozwiązanie.

Musiałem dodać adnotacje do wyliczenia @JsonSerialize(using = OrderTypeSerializer.class)i zaimplementować niestandardowy serializator:

public class OrderTypeSerializer extends JsonSerializer<OrderType> {

  @Override
  public void serialize(OrderType value, JsonGenerator generator,
            SerializerProvider provider) throws IOException,
            JsonProcessingException {

    generator.writeStartObject();
    generator.writeFieldName("id");
    generator.writeNumber(value.getId());
    generator.writeFieldName("name");
    generator.writeString(value.getName());
    generator.writeEndObject();
  }
}
— Nofate
źródło
4
Zauważ, że aby skonfigurować Jacksona do korzystania z przetwarzania (de) serializacji niestandardowej, alternatywą dla używania adnotacji jest zarejestrowanie (de) serializatorów za pomocą modułu konfiguracyjnego. wiki.fasterxml.com/JacksonHowToCustomSerializers
— Programmer Bruce
1
To nie zadziałało w przypadku mnie przy użyciu Spring 3.1.1. Mój @Controller nadal zwraca json bez moich atrybutów.
— Dave
Mam kilka wyliczeń i chcę uzyskać wszystkie wyliczenia z jedną funkcją. Jak mogę to zrobić?
— Morteza Malvandi,
Dla jednego typu wyliczenia muszę zdefiniować niestandardowy deserializator. Czy jest jakieś ogólne rozwiązanie?
— Chao,
78 
@JsonFormat(shape= JsonFormat.Shape.OBJECT)
public enum SomeEnum

dostępne od https://github.com/FasterXML/jackson-databind/issues/24

właśnie przetestowałem, że działa z wersją 2.1.2

odpowiedź na TheZuck :

Próbowałem twojego przykładu, dostałem Json: 

{"events":[{"type":"ADMIN"}]}

Mój kod:

@RequestMapping(value = "/getEvent") @ResponseBody
  public EventContainer getEvent() {
    EventContainer cont = new EventContainer();
    cont.setEvents(Event.values());
    return cont;
 }

class EventContainer implements Serializable {

  private Event[] events;

  public Event[] getEvents() {
    return events;
 }

 public void setEvents(Event[] events) {
   this.events = events;
 }
}

a zależności to:

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-annotations</artifactId>
  <version>${jackson.version}</version>
</dependency>

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-core</artifactId>
  <version>${jackson.version}</version>
</dependency>

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>${jackson.version}</version>
  <exclusions>
    <exclusion>
      <artifactId>jackson-annotations</artifactId>
      <groupId>com.fasterxml.jackson.core</groupId>
    </exclusion>
    <exclusion>
      <artifactId>jackson-core</artifactId>
      <groupId>com.fasterxml.jackson.core</groupId>
    </exclusion>
  </exclusions>
</dependency>

<jackson.version>2.1.2</jackson.version>
— Vecnas
źródło
2
Podoba mi się ta alternatywa, jest czystsza, jednak wypróbowałem ją z tą klasą i typ nie jest serializowany, czy wiesz, co się stało? @JsonFormat (shape = JsonFormat.Shape.OBJECT) @JsonAutoDetect () publiczne wyliczenie Zdarzenie {VISIT_WEBSITE (Type.ADMIN); @JsonProperty public Type type; public Type getType () {return type; } Zdarzenie (typ typu) {this.type = typ; } public enum Type {ADMIN, CONSUMER,}} Używam Jackson 2.1.2
— TheZuck,
Dodałem dodatkowe szczegóły do ​​treści odpowiedzi
— Vecnas
dowiedziałem się, co jest nie tak, używałem Jacksona 2.1.2, ale moja wersja Spring nadal była 3.1, dlatego nie obsługuje tej wersji. Zaktualizowano do wersji 3.2.1 i wszystko jest teraz dobrze. Dzięki!
— TheZuck
@Vecnas Czy mogę zastąpić domyślne @JsonFormatwyliczenie, gdy jest używane w innej encji? na przykład jednostka, w której chcę, aby wyliczenie było serializowane jako ciąg znaków zamiast obiektu. próbuję dodać kolejny @JsonFormatw polu w klasie, która używa wyliczenia, ale zawsze jest on serializowany jako obiekt.
— herau
Co znalazłem, użyj - @JsonSerialize (using = ToStringSerializer.class) dla pola, używa toString (). Nie jest to ścisłe rozwiązanie, ale działa
— Vecnas,
25

Znalazłem bardzo ładne i zwięzłe rozwiązanie, szczególnie przydatne, gdy nie można modyfikować klas wyliczeniowych, jak to było w moim przypadku. Następnie należy zapewnić niestandardowy ObjectMapper z włączoną określoną funkcją. Te funkcje są dostępne od wersji Jackson 1.6.

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 wyliczeniami, zobacz tutaj:

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

— lagivan
źródło
4
Zgadzam się. Co więcej, w Jackson 2.5 nie potrzebujesz niestandardowego mapowania obiektów. Po prostu zrób to: objMapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);i to:objMapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING);
— Jake Toronto,
14

Oto moje rozwiązanie. Chcę przekształcić wyliczenie do {id: ..., name: ...}postaci.

Z Jacksonem 1.x :

pom.xml:

<properties>
    <jackson.version>1.9.13</jackson.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.codehaus.jackson</groupId>
        <artifactId>jackson-core-asl</artifactId>
        <version>${jackson.version}</version>
    </dependency>
    <dependency>
        <groupId>org.codehaus.jackson</groupId>
        <artifactId>jackson-mapper-asl</artifactId>
        <version>${jackson.version}</version>
    </dependency>
</dependencies>

Rule.java:

import org.codehaus.jackson.map.annotate.JsonSerialize;
import my.NamedEnumJsonSerializer;
import my.NamedEnum;

@Entity
@Table(name = "RULE")
public class Rule {
    @Column(name = "STATUS", nullable = false, updatable = true)
    @Enumerated(EnumType.STRING)
    @JsonSerialize(using = NamedEnumJsonSerializer.class)
    private Status status;
    public Status getStatus() { return status; }
    public void setStatus(Status status) { this.status = status; }

    public static enum Status implements NamedEnum {
        OPEN("open rule"),
        CLOSED("closed rule"),
        WORKING("rule in work");

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

NamedEnum.java:

package my;

public interface NamedEnum {
    String name();
    String getName();
}

NamedEnumJsonSerializer.java:

package my;

import my.NamedEnum;
import java.io.IOException;
import java.util.*;
import org.codehaus.jackson.JsonGenerator;
import org.codehaus.jackson.JsonProcessingException;
import org.codehaus.jackson.map.JsonSerializer;
import org.codehaus.jackson.map.SerializerProvider;

public class NamedEnumJsonSerializer extends JsonSerializer<NamedEnum> {
    @Override
    public void serialize(NamedEnum value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
        Map<String, String> map = new HashMap<>();
        map.put("id", value.name());
        map.put("name", value.getName());
        jgen.writeObject(map);
    }
}

Z Jackson 2.x :

pom.xml:

<properties>
    <jackson.version>2.3.3</jackson.version>
</properties>

<dependencies>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-core</artifactId>
        <version>${jackson.version}</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>${jackson.version}</version>
    </dependency>
</dependencies>

Rule.java:

import com.fasterxml.jackson.annotation.JsonFormat;

@Entity
@Table(name = "RULE")
public class Rule {
    @Column(name = "STATUS", nullable = false, updatable = true)
    @Enumerated(EnumType.STRING)
    private Status status;
    public Status getStatus() { return status; }
    public void setStatus(Status status) { this.status = status; }

    @JsonFormat(shape = JsonFormat.Shape.OBJECT)
    public static enum Status {
        OPEN("open rule"),
        CLOSED("closed rule"),
        WORKING("rule in work");

        private String name;
        Status(String name) { this.name = name; }
        public String getName() { return this.name; }
        public String getId() { return this.name(); }
    };
}

Rule.Status.CLOSEDprzetłumaczone na {id: "CLOSED", name: "closed rule"}.

— gavenkoa
źródło
Świetny. Uratowałeś mi dzień :-)
— sriram
4

Łatwym sposobem serializacji Enum jest użycie adnotacji @JsonFormat. @JsonFormat może skonfigurować serializację Enum na trzy sposoby.

@JsonFormat.Shape.STRING
public Enum OrderType {...}

używa OrderType :: name jako metody serializacji. Serializacja OrderType.TypeA to“TYPEA”

@JsonFormat.Shape.NUMBER
Public Enum OrderTYpe{...}

używa OrderType :: ordinal jako metody serializacji. Serializacja OrderType.TypeA to1

@JsonFormat.Shape.OBJECT
Public Enum OrderType{...}

traktuje OrderType jako POJO. Serializacja OrderType.TypeA to{"id":1,"name":"Type A"}

JsonFormat.Shape.OBJECT jest tym, czego potrzebujesz w swoim przypadku.

Twoje rozwiązanie jest nieco bardziej skomplikowane, określając serializator dla Enum.

Sprawdź to odniesienie: https://fasterxml.github.io/jackson-annotations/javadoc/2.2.0/com/fasterxml/jackson/annotation/JsonFormat.html

— promień
źródło
3

Użyj adnotacji @JsonCreator, utwórz metodę getType (), jest serializowany z toString lub działającym obiektem 

{"ATIVO"}

lub

{"type": "ATIVO", "descricao": "Ativo"}

...

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.JsonNodeType;

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

    ATIVO("Ativo"),
    PENDENTE_VALIDACAO("Pendente de Validação"),
    INATIVO("Inativo"),
    BLOQUEADO("Bloqueado"),
    /**
     * Usuarios cadastrados pelos clientes que não possuem acesso a aplicacao,
     * caso venham a se cadastrar este status deve ser alterado
     */
    NAO_REGISTRADO("Não Registrado");

    private SituacaoUsuario(String descricao) {
        this.descricao = descricao;
    }

    private String descricao;

    public String getDescricao() {
        return descricao;
    }

    // TODO - Adicionar metodos dinamicamente
    public String getType() {
        return this.toString();
    }

    public String getPropertieKey() {
        StringBuilder sb = new StringBuilder("enum.");
        sb.append(this.getClass().getName()).append(".");
        sb.append(toString());
        return sb.toString().toLowerCase();
    }

    @JsonCreator
    public static SituacaoUsuario fromObject(JsonNode node) {
        String type = null;
        if (node.getNodeType().equals(JsonNodeType.STRING)) {
            type = node.asText();
        } else {
            if (!node.has("type")) {
                throw new IllegalArgumentException();
            }
            type = node.get("type").asText();
        }
        return valueOf(type);
    }

}
— Gleidosn
źródło
0

W Spring Boot 2 najłatwiej jest zadeklarować w pliku application.properties:

spring.jackson.serialization.WRITE_ENUMS_USING_TO_STRING=true
spring.jackson.deserialization.READ_ENUMS_USING_TO_STRING=true

i zdefiniuj metodę toString () swoich wyliczeń.

— JRA_TLL
źródło
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.