Різні назви властивості JSON під час серіалізації та десеріалізації

Чи можливо: мати одне поле в класі, але різні назви для нього під час серіалізації / десеріалізації в бібліотеці Джексона?

Наприклад, у мене клас "Coordiantes".

class Coordinates{
  int red;
}

Для десеріалізації від JSON хочемо мати такий формат:

{
  "red":12
}

Але коли я серіалізую об'єкт, результат повинен бути таким:

{
  "r":12
}

Я спробував реалізувати це, застосувавши @JsonPropertyанотацію як на getter, так і на 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;
    }
}

Ідея полягає в тому, що назви методів повинні бути різними, тому Джексон аналізує їх як різні поля, а не як одне поле.

Ось код тесту:

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

Ви можете використовувати те, @jsonAliasщо було введено в jackson 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;
    }
}

Я би прив’язав два різні геттери / сетери до однієї змінної:

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якою я ознайомився з Джексоном 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);