Jacksonを使用した列挙型のシリアル化

90

以下に列挙されたEnumがあります。

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};）で列挙配列を返し、Springはそれを次のjson文字列にシリアル化します。

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

JacksonにPOJOと同じように列挙型のシリアル化を強制する最善の方法は何ですか？例えば：

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

私はさまざまな注釈で遊んだが、そのような結果を得ることができなかった。

java  json  spring  spring-mvc  jackson 
— ノーフェイト
ソース
1
すでに解決策を見つけたようです。すごい！なぜそれが必要なのか知りたいですか？
— StaxMan、2011年
JSONを介してサーバー側と通信するGWTアプリケーションを開発しています。この列挙型は、コンボボックスのオプション値を提供します。
— Nofate、2011年
ああ。値のセットの略語のように...興味深いです。
— StaxMan 2011年

回答:

87

最後に私は自分で解決策を見つけました。

enumに注釈を付け@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();
  }
}
— ノーフェイト
ソース
4
カスタム（非）シリアライゼーション処理を使用するようにJacksonを構成するには、アノテーションを使用する代わりに、構成モジュールに（デ）シリアライザーを登録します。wiki.fasterxml.com/JacksonHowToCustomSerializers
— プログラマBruce
1
これは、Spring 3.1.1を使用している場合は機能しませんでした。私の@Controllerは私の属性なしでjsonを返します。
— Dave、
いくつかの列挙型があり、1つの関数ですべての列挙型を取得したいと考えています。どうすればできますか？
— Morteza Malvandi
列挙型の1つとして、カスタムデシリアライザーを定義する必要があります。一般的な解決策はありますか？
— Chao
78 
@JsonFormat(shape= JsonFormat.Shape.OBJECT)
public enum SomeEnum

https://github.com/FasterXML/jackson-databind/issues/24以降で利用可能

テスト済みで、バージョン2.1.2で動作します

TheZuckへの回答：

私はあなたの例を試しました、Jsonを得ました： 

{"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>
— ベクナス
ソース
2
私はこの代替案が好きです、それはよりきれいですが、このクラスで試してみましたが、タイプがシリアル化されません、何が悪いのでしょうか？@JsonFormat（shape = JsonFormat.Shape.OBJECT）@JsonAutoDetect（）public enum Event {VISIT_WEBSITE（Type.ADMIN）; @JsonProperty publicタイプタイプ。public Type getType（）{戻り値のタイプ。} Event（Type type）{this.type = type; } public enum Type {ADMIN、CONSUMER、}}私はJackson 2.1.2を使用しています
— TheZuck
回答の本文に追加の詳細を追加しました
— Vecnas 2013年
私はジャクソン2.1.2を使用していましたが、何が問題なのかを見つけましたが、私のスプリングバージョンはまだ3.1だったため、このバージョンをサポートしていませんでした。3.2.1にアップグレードしましたが、すべて順調です。ありがとう！
— TheZuck 2013年
@Vecnas @JsonFormat別のエンティティで使用されている列挙型のデフォルトをオーバーライドできますか？たとえば、列挙型をオブジェクトではなく文字列としてシリアル化する必要があるエンティティ。@JsonFormatenumを使用するクラスのフィールドに別のものを追加しようとしますが、常にオブジェクトとしてシリアル化されます。
— herau 2014年
私が見つけたものを使用します-フィールドに対して@JsonSerialize（using = ToStringSerializer.class）、それはtoString（）を使用します。厳密な解決策ではありませんが、機能します
— Vecnas 2014年
25

私の場合のように列挙型クラスを変更できない場合に特に便利な、非常に優れた簡潔なソリューションを見つけました。次に、特定の機能を有効にしたカスタムObjectMapperを提供する必要があります。これらの機能は、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);
    }
}

利用可能な列挙型関連の機能が他にもあります。ここを参照してください。

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

— ラギバン
ソース
4
同意する。さらに、Jackson 2.5では、カスタムオブジェクトマッパーは必要ありません。これをしてください：objMapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING);そしてこれ：objMapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING);
— ジェイクトロント
14

これが私の解決策です。enumを{id: ..., name: ...}フォームに変換したい。

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

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.CLOSEDに翻訳されました{id: "CLOSED", name: "closed rule"}。

— ジヴェンコア
ソース
優れた。あなたは私の日を救いました:-)
— スリラム
4

Enumをシリアル化する簡単な方法は、@ JsonFormatアノテーションを使用することです。@JsonFormatは、3つの方法でEnumのシリアル化を構成できます。

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

OrderType :: nameをシリアル化メソッドとして使用します。OrderType.TypeAのシリアル化は“TYPEA”

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

OrderType :: ordinalをシリアル化メソッドとして使用します。OrderType.TypeAのシリアル化は1

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

OrderTypeをPOJOとして扱います。OrderType.TypeAのシリアル化は{"id":1,"name":"Type A"}

JsonFormat.Shape.OBJECTは、ケースで必要なものです。

もう少し複雑な方法は、Enumのシリアライザーを指定するソリューションです。

このリファレンスを確認してください：https : //fasterxml.github.io/jackson-annotations/javadoc/2.2.0/com/fasterxml/jackson/annotation/JsonFormat.html

— レイ
ソース
3

@JsonCreatorアノテーションを使用し、メソッドgetType（）を作成し、toStringまたはオブジェクトの動作でシリアル化します 

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

}
— グライドスン
ソース
0

Spring Boot 2では、最も簡単な方法は、application.propertiesで宣言することです。

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

列挙型のtoString（）メソッドを定義します。

— JRA_TLL
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.