जैक्सन के साथ सीरियल्स को सीरियस करना

Question 1

मेरे पास एक एनुम है जो नीचे दिया गया है:

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};) के साथ एनम ऐरे वापस करता हूं , और स्प्रिंग इसे निम्नलिखित जॉगन स्ट्रिंग में क्रमबद्ध करता है:

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

POJOs की तरह ही जैम को सीरियसली लेने के लिए मजबूर करने के लिए सबसे अच्छा तरीका क्या है? उदाहरण के लिए:

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

मैंने विभिन्न एनोटेशनों के साथ खेला, लेकिन ऐसा परिणाम प्राप्त करने का प्रबंधन नहीं कर सका।

Question 2

अंत में मैंने स्वयं समाधान पाया।

मुझे @JsonSerialize(using = OrderTypeSerializer.class)कस्टम धारावाहिक के साथ एनम को एनोटेट करना और लागू करना था:

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

Question 3

@JsonFormat(shape= JsonFormat.Shape.OBJECT)
public enum SomeEnum

https://github.com/FasterXML/jackson-databind/issues/24 से उपलब्ध है

अभी परीक्षण किया यह संस्करण 2.1.2 के साथ काम करता है

TheZuck का जवाब :

मैंने आपके उदाहरण की कोशिश की, जोसन को मिला:

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

मेरा कोड:

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

और निर्भरताएं हैं:

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

Question 4

मुझे एक बहुत अच्छा और संक्षिप्त समाधान मिला है, विशेष रूप से उपयोगी है जब आप एनम वर्गों को संशोधित नहीं कर सकते हैं जैसा कि मेरे मामले में था। फिर आपको एक निश्चित सुविधा सक्षम के साथ एक कस्टम ObjectMapper प्रदान करना चाहिए। वे सुविधाएँ जैक्सन 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);
    }
}

अधिक एनुम से संबंधित सुविधाएँ उपलब्ध हैं, यहाँ देखें:

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

Question 5

यहाँ मेरा समाधान है। मैं एनम को {id: ..., name: ...}रूप में बदलना चाहता हूं ।

जैक्सन के साथ 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);
    }
}

जैक्सन के साथ 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.CLOSEDका अनुवाद किया {id: "CLOSED", name: "closed rule"}।

Question 6

Enum को क्रमबद्ध करने का एक आसान तरीका @JsonFormat एनोटेशन का उपयोग करना है। @JsonFormat एक Enum के क्रमांकन को तीन तरीकों से कॉन्फ़िगर कर सकता है।

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

क्रम विधि के रूप में क्रम :: नाम का उपयोग करता है। OrderType.TypeA का क्रमांकन है“TYPEA”

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

क्रम-निर्धारण :: क्रमिक पद्धति के रूप में क्रमिक का उपयोग करता है। OrderType.TypeA का क्रमांकन है1

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

एक POJO के रूप में OrderType व्यवहार करता है। OrderType.TypeA का क्रमांकन है{"id":1,"name":"Type A"}

JsonFormat.Shape.OBJECT आप अपने मामले में क्या जरूरत है।

थोड़ा और अधिक जटिल तरीका है आपका समाधान, एनम के लिए एक धारावाहिक को निर्दिष्ट करना।

इस संदर्भ को देखें: https://fasterxml.github.io/jackson-annotations/javadoc/2.2.0/com/fasterxml/jackson/annotation/JsonFormat.html

Question 7

@JsonCreator एनोटेशन का उपयोग करें, विधि getType बनाएं (), स्ट्रींग या ऑब्जेक्ट के काम करने के साथ क्रमबद्ध करें

{"ATIVO"}

या

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

}

Question 8

स्प्रिंग बूट 2 में, आपके एप्लिकेशन को घोषित करने का सबसे आसान तरीका है।

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

और अपने एनमों की स्ट्रैसिंग () विधि को परिभाषित करें।