シリアライゼーションとデシリアライゼーション中のJSONプロパティの異なる名前

可能ですか：クラスに1つのフィールドがありますが、Jacksonライブラリでのシリアル化/逆シリアル化中にフィールドの名前が異なりますか？

たとえば、「Coordiantes」というクラスがあります。

class Coordinates{
  int red;
}

JSONからの逆シリアル化では、次のような形式にする必要があります。

{
  "red":12
}

しかし、オブジェクトをシリアル化すると、結果は次のようになります。

{
  "r":12
}

@JsonPropertyゲッターとセッターの両方にアノテーションを適用して（異なる値で）これを実装しようとしました：

class Coordiantes{
    int red;

    @JsonProperty("r")
    public byte getRed() {
      return red;
    }

    @JsonProperty("red")
    public void setRed(byte red) {
      this.red = red;
    }
}

しかし、私は例外を得ました：

org.codehaus.jackson.map.exc.UnrecognizedPropertyException：認識されないフィールド「赤」

ちょうどテストされ、これは動作します：

public class Coordinates {
    byte red;

    @JsonProperty("r")
    public byte getR() {
      return red;
    }

    @JsonProperty("red")
    public void setRed(byte red) {
      this.red = red;
    }
}

つまり、メソッド名は異なるはずなので、Jacksonはそれを1つのフィールドとしてではなく、異なるフィールドとして解析します。

ここにテストコードがあります：

Coordinates c = new Coordinates();
c.setRed((byte) 5);

ObjectMapper mapper = new ObjectMapper();
System.out.println("Serialization: " + mapper.writeValueAsString(c));

Coordinates r = mapper.readValue("{\"red\":25}",Coordinates.class);
System.out.println("Deserialization: " + r.getR());

結果：

Serialization: {"r":5}
Deserialization: 25

@jsonAliasjackson 2.9.0で導入されたものを使用できます。

例：

public class Info {
  @JsonAlias({ "red" })
  public String r;
}

これはシリアライズ中にr使用しますredが、デシリアライズ中にエイリアスとして使用できます。rただし、これでもデシリアライズは可能です。

@JsonSetterと@JsonGetterの組み合わせを使用して、プロパティの逆シリアル化とシリアル化をそれぞれ制御できます。これにより、実際のフィールド名に対応する標準化されたゲッターおよびセッターメソッド名を保持することもできます。

import com.fasterxml.jackson.annotation.JsonSetter;    
import com.fasterxml.jackson.annotation.JsonGetter;

class Coordinates {
    private int red;

    //# Used during serialization
    @JsonGetter("r")
    public int getRed() {
        return red;
    }

    //# Used during deserialization
    @JsonSetter("red")
    public void setRed(int red) {
        this.red = red;
    }
}

2つの異なるゲッター/セッターのペアを1つの変数にバインドします。

class Coordinates{
    int red;

    @JsonProperty("red")
    public byte getRed() {
      return red;
    }

    public void setRed(byte red) {
      this.red = red;
    }

    @JsonProperty("r")
    public byte getR() {
      return red;
    }

    public void setR(byte red) {
      this.red = red;
    }
}

通常のゲッター/セッターのペアを使用することが可能です。あなただけでアクセスモードを指定する必要があります@JsonProperty

これはそのための単体テストです：

public class JsonPropertyTest {

  private static class TestJackson {

    private String color;

    @JsonProperty(value = "device_color", access = JsonProperty.Access.READ_ONLY)
    public String getColor() {
      return color;
    };

    @JsonProperty(value = "color", access = JsonProperty.Access.WRITE_ONLY)
    public void setColor(String color) {
      this.color = color;
    }

  }

  @Test
  public void shouldParseWithAccessModeSpecified() throws Exception {
    String colorJson = "{\"color\":\"red\"}";
    ObjectMapper mapper = new ObjectMapper();
    TestJackson colotObject = mapper.readValue(colorJson, TestJackson.class);

    String ser = mapper.writeValueAsString(colotObject);
    System.out.println("Serialized colotObject: " + ser);
  }
}

次のような出力が得られました。

Serialized colotObject: {"device_color":"red"}

これは、私が解決策として期待していたものではありませんでした（ただし、これは正当な使用例です）。私の要件は、既存のバグの多いクライアント（既にリリースされているモバイルアプリ）が代替名を使用できるようにすることでした。

解決策は、次のような個別のセッターメソッドを提供することです。

@JsonSetter( "r" )
public void alternateSetRed( byte red ) {
    this.red = red;
}

使用後、私はその古い質問を知っているが、私はあなたがGsonを使用しているので、もしそのはGsonライブラリと競合することを考え出したときに私のために私はそれが働いてしまった@SerializedName("name")のではなく、@JsonProperty("name")このことができます希望

@JsonAlias言及せずに、Jackson 2.9以降で導入された注釈@JsonProperty、複数のエイリアス（jsonプロパティの異なる名前）でデシリアライズされるアイテム機能します。

私はユースケースcom.fasterxml.jackson.annotation.JsonAliasとのパッケージの一貫性のcom.fasterxml.jackson.databind.ObjectMapperために使用しました。

たとえば：

@Data
@Builder
public class Chair {

    @JsonAlias({"woodenChair", "steelChair"})
    private String entityType;

}


@Test
public void test1() {

   String str1 = "{\"woodenChair\":\"chair made of wood\"}";
   System.out.println( mapper.readValue(str1, Chair.class));
   String str2 = "{\"steelChair\":\"chair made of steel\"}";
   System.out.println( mapper.readValue(str2, Chair.class));

}

正常に動作します。

@JsonPropertyゲッターとセッターに異なる値を設定すると、期待どおりの結果が得られるため（同じフィールドでのシリアル化と逆シリアル化の際のプロパティ名が異なるため）、これを機能として含める必要があります。ジャクソンバージョン2.6.7

それを行うためにシリアライズクラスを書くことができます：

public class Symbol

{
     private String symbol;

     private String name;

     public String getSymbol() {
        return symbol;
    }
    public void setSymbol(String symbol) {
        this.symbol = symbol;
    }    
    public String getName() {
        return name;
    }    
    public void setName(String name) {
        this.name = name;
    }
}

public class SymbolJsonSerializer extends JsonSerializer<Symbol> {

    @Override
    public void serialize(Symbol symbol, JsonGenerator jgen, SerializerProvider serializers) throws IOException, JsonProcessingException {
        jgen.writeStartObject();

        jgen.writeStringField("symbol", symbol.getSymbol());
         //Changed name to full_name as the field name of Json string
        jgen.writeStringField("full_name", symbol.getName());
        jgen.writeEndObject(); 
    }
}

            ObjectMapper mapper = new ObjectMapper();

            SimpleModule module = new SimpleModule();
            module.addSerializer(Symbol.class, new SymbolJsonSerializer());
            mapper.registerModule(module); 

            //only convert non-null field, option...
            mapper.setSerializationInclusion(Include.NON_NULL); 

            String jsonString = mapper.writeValueAsString(symbolList);