Serializando enums con Jackson

Tengo un Enum descrito a continuación:

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

Devuelvo matriz enum con mi controlador ( new OrderType[] {UNKNOWN,TYPEA,TYPEB,TYPEC}; ), y Spring lo serializa en la siguiente cadena json:

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

¿Cuál es el mejor enfoque para obligar a Jackson a serializar enums como POJOs? P.ej:

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

Jugué con diferentes anotaciones pero no pude obtener ese resultado.

Finalmente encontré la solución yo mismo.

Tuve que anotar enum con @JsonSerialize(using = OrderTypeSerializer.class) e implementar un serializador personalizado:

 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 

disponible desde https://github.com/FasterXML/jackson-databind/issues/24

acaba de probar que funciona con la versión 2.1.2

respuesta a TheZuck :

Intenté tu ejemplo, conseguí a Json:

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

Mi código:

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

y las dependencias son:

  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 

Encontré una solución muy agradable y concisa, especialmente útil cuando no se pueden modificar las clases enum como en mi caso. Luego debe proporcionar un ObjectMapper personalizado con una característica determinada habilitada. Esas características están disponibles desde 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); } } 

Hay más funciones relacionadas con enum disponibles, mira aquí:

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

Aquí está mi solución. Quiero transformar enum a {id: ..., name: ...} formulario.

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

Una forma fácil de serializar Enum es usar la anotación @JsonFormat. @JsonFormat puede configurar la serialización de un Enum de tres maneras.

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

usa OrderType :: name como el método de serialización. La serialización de OrderType.TypeA es “TYPEA”

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

usa OrderType :: ordinal como el método de serialización. La serialización de OrderType.TypeA es 1

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

trata a OrderType como un POJO. La serialización de OrderType.TypeA es {"id":1,"name":"Type A"}

JsonFormat.Shape.OBJECT es lo que necesitas en tu caso.

Una forma un poco más complicada es su solución, especificando un serializador para el Enum.

Mira esta referencia: https://fasterxml.github.io/jackson-annotations/javadoc/2.2.0/com/fasterxml/jackson/annotation/JsonFormat.html

Utilice la anotación @JsonCreator, cree el método getType (), serialice con toString u objete el trabajo

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