Nomi diversi della proprietà JSON durante la serializzazione e la deserializzazione

È possibile: avere un campo in classe, ma nomi diversi durante la serializzazione / deserializzazione nella biblioteca di Jackson?

Ad esempio, ho classe "Coordiantes".

class Coordinates{
  int red;
}

Per la deserializzazione da JSON vuoi avere un formato come questo:

{
  "red":12
}

Ma quando serializzerò l'oggetto, il risultato dovrebbe essere come questo:

{
  "r":12
}

Ho provato a implementare questo applicando l' @JsonPropertyannotazione sia su getter che sul setter (con valori diversi):

class Coordiantes{
    int red;

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

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

ma ho ottenuto un'eccezione:

org.codehaus.jackson.map.exc.UnrecognizedPropertyException: campo non riconosciuto "rosso"

Appena testato e funziona:

public class Coordinates {
    byte red;

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

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

L'idea è che i nomi dei metodi dovrebbero essere diversi, quindi Jackson lo analizza come campi diversi, non come un campo.

Ecco il codice di prova:

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

Risultato:

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

Puoi usare quello @jsonAliasche è stato introdotto in jackson 2.9.0

Esempio:

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

Questo utilizza rdurante la serializzazione, ma consente redcome alias durante la deserializzazione. Ciò consente comunque rdi essere anche deserializzato.

È possibile utilizzare una combinazione di @JsonSetter e @JsonGetter per controllare rispettivamente la deserializzazione e la serializzazione della proprietà. Ciò consentirà inoltre di mantenere i nomi dei metodi getter e setter standardizzati che corrispondono al nome del campo effettivo.

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

Vorrei associare due diversi getter / setter a una variabile:

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

È possibile avere una normale coppia getter / setter. Devi solo specificare la modalità di accesso in@JsonProperty

Ecco un test unitario per questo:

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

Ho ottenuto l'output come segue:

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

Non era quello che mi aspettavo come soluzione (anche se è un caso d'uso legittimo). Il mio requisito era di consentire a un client con buggy esistente (un'app mobile già rilasciata) di utilizzare nomi alternativi.

La soluzione sta nel fornire un metodo setter separato come questo:

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

So che è una vecchia domanda, ma per me l'ho fatto funzionare quando ho capito che è in conflitto con la libreria Gson, quindi se stai usando Gson, usa @SerializedName("name")invece di @JsonProperty("name")sperare che questo aiuti

Le annotazioni con le @JsonAliasquali sono state introdotte con Jackson 2.9+, senza menzionare @JsonPropertyl'oggetto da deserializzare con più di un alias (nomi diversi per una proprietà json) funzionano bene.

Ho usato la com.fasterxml.jackson.annotation.JsonAliascoerenza del pacchetto con il com.fasterxml.jackson.databind.ObjectMappermio caso d'uso.

Ad esempio:

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

}

funziona benissimo.

Devono averlo incluso come funzionalità, perché ora l'impostazione di un diverso @JsonPropertyper un getter e setter si traduce esattamente in quello che ti aspetteresti (nome di proprietà diverso durante la serializzazione e la deserializzazione per lo stesso campo). Jackson versione 2.6.7

Puoi scrivere una classe serializzata per farlo:

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