Serializzare le enumerazioni con Jackson

Ho un enumerato qui sotto:

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

new OrderType[] {UNKNOWN,TYPEA,TYPEB,TYPEC}; enum array con il mio controller ( new OrderType[] {UNKNOWN,TYPEA,TYPEB,TYPEC}; ), e Spring lo serializza nella seguente stringa json:

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

Qual è l’approccio migliore per costringere Jackson a serializzare enumerazioni come i POJO? Per esempio:

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

Ho giocato con annotazioni diverse ma non sono riuscito a ottenere un risultato simile.

Finalmente ho trovato la soluzione da solo.

Ho dovuto annotare enum con @JsonSerialize(using = OrderTypeSerializer.class) e implementare serializzatore personalizzato:

 public class OrderTypeSerializer extends JsonSerializer { @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(); } } 
 @JsonFormat(shape= JsonFormat.Shape.OBJECT) public enum SomeEnum 

disponibile da https://github.com/FasterXML/jackson-databind/issues/24

appena testato funziona con la versione 2.1.2

rispondi a TheZuck :

Ho provato il tuo esempio, ho Json:

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

Il mio codice:

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

e le dipendenze sono:

  com.fasterxml.jackson.core jackson-annotations ${jackson.version}   com.fasterxml.jackson.core jackson-core ${jackson.version}   com.fasterxml.jackson.core jackson-databind ${jackson.version}   jackson-annotations com.fasterxml.jackson.core   jackson-core com.fasterxml.jackson.core    2.1.2 

Ho trovato una soluzione molto bella e concisa, particolarmente utile quando non è ansible modificare le classi enum come nel mio caso. Quindi devi fornire un ObjectMapper personalizzato con una determinata funzione abilitata. Quelle funzionalità sono disponibili da 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); } } 

Ci sono più funzionalità enum disponibili, vedi qui:

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

Ecco la mia soluzione. Voglio trasformare enum in {id: ..., name: ...} form.

Con Jackson 1.x :

pom.xml:

  1.9.13    org.codehaus.jackson jackson-core-asl ${jackson.version}   org.codehaus.jackson jackson-mapper-asl ${jackson.version}   

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 { @Override public void serialize(NamedEnum value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException { Map map = new HashMap<>(); map.put("id", value.name()); map.put("name", value.getName()); jgen.writeObject(map); } } 

Con Jackson 2.x :

pom.xml:

  2.3.3    com.fasterxml.jackson.core jackson-core ${jackson.version}   com.fasterxml.jackson.core jackson-databind ${jackson.version}   

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.CLOSED tradotto in {id: "CLOSED", name: "closed rule"} .

Un modo semplice per serializzare Enum è l’utilizzo dell’annotazione @JsonFormat. @JsonFormat può configurare la serializzazione di un Enum in tre modi.

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

usa OrderType :: name come metodo di serializzazione. La serializzazione di OrderType.TypeA è “TYPEA”

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

usa OrderType :: ordinal come metodo di serializzazione. La serializzazione di OrderType.TypeA è 1

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

tratta OrderType come POJO. La serializzazione di OrderType.TypeA è {"id":1,"name":"Type A"}

JsonFormat.Shape.OBJECT è ciò di cui hai bisogno nel tuo caso.

Un modo un po ‘più complicato è la soluzione, specificando un serializzatore per l’Enum.

Dai un’occhiata a questo riferimento: https://fasterxml.github.io/jackson-annotations/javadoc/2.2.0/com/fasterxml/jackson/annotation/JsonFormat.html

Utilizzare l’annotazione @JsonCreator, creare il metodo getType (), serializzare con toString o object funzionante

 {"ATIVO"} 

o

 {"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 aplicocoa, * 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 dynamicmente 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); } }