직렬화 및 역 직렬화 중에 다른 JSON 속성 이름

가능합니까 : Jackson 라이브러리에서 직렬화 / 직렬화 해제 중에 클래스에 하나의 필드를 가지고 있지만 다른 이름을 갖는 것이 가능합니까?

예를 들어 클래스 "Coordiantes"가 있습니다.

class Coordinates{
  int red;
}

JSON에서 직렬화 해제하려면 다음과 같은 형식을 원합니다.

{
  "red":12
}

그러나 객체를 직렬화 할 때 결과는 다음과 같아야합니다.

{
  "r":12
}

@JsonPropertygetter와 setter (다른 값으로)에 주석 을 적용하여 이것을 구현하려고했습니다 .

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은이를 하나의 필드가 아니라 다른 필드로 구문 분석합니다.

테스트 코드는 다음과 같습니다.

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 조합을 사용 하여 속성의 역 직렬화 및 직렬화를 각각 제어 할 수 있습니다. 또한 실제 필드 이름에 해당하는 표준화 된 getter 및 setter 메소드 이름을 유지할 수 있습니다.

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

두 개의 다른 getter / setter 쌍을 하나의 변수에 바인딩합니다.

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

이것은 솔루션으로 기대했던 것이 아닙니다 (합법적 인 사용 사례 임에도 불구하고). 내 요구 사항은 기존 버기 클라이언트 (이미 출시 된 모바일 앱)가 대체 이름을 사용하도록 허용하는 것이 었습니다.

해결책은 다음과 같은 별도의 setter 방법을 제공하는 것입니다.

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

나는 오래된 질문을 알고 있지만 Gson 라이브러리와 충돌한다는 것을 알았을 때 효과가 있었으므로 Gson을 사용 @SerializedName("name")하는 경우 @JsonProperty("name")희망 대신 사용 하면 도움이됩니다.

@JsonAliasJackson 2.9 이상에서 소개 된 주석은 @JsonProperty둘 이상의 별칭 (json 속성의 다른 이름)으로 deserialize 될 항목에 대한 언급없이 잘 작동합니다.

내가 사용 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));

}

잘 작동합니다.

이제 @JsonPropertygetter 및 setter에 대해 다르게 설정하면 예상 한 것과 정확히 일치하게됩니다 (동일한 필드에 대해 직렬화 및 직렬화 해제 중에 다른 특성 이름). 잭슨 버전 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);