¿Cuándo se utiliza la propiedad @JsonProperty y para qué se utiliza?

Creo que OldCurmudgeon y StaxMan son ambos correctos, pero aquí hay una respuesta de oración con un ejemplo simple para usted.

@JsonProperty(nombre), le dice a Jackson ObjectMapper que asigne el nombre de la propiedad JSON al nombre del campo Java anotado.

//example of json that is submitted 
"Car":{
  "Type":"Ferrari",
}

//where it gets mapped 
public static class Car {
  @JsonProperty("Type")
  public String type;
 }

Bien por lo que vale ahora... JsonProperty TAMBIÉN se usa para especificar los métodos getter y setter para la variable, aparte de la serialización y deserialización habituales. Por ejemplo, supongamos que tiene una carga útil como esta:

{
  "check": true
}

Y una clase Deserializer:

public class Check {

  @JsonProperty("check")    // It is needed else Jackson will look got getCheck method and will fail
  private Boolean check;

  public Boolean isCheck() {
     return check;
  }
}

Entonces en este caso se necesita la anotación JsonProperty. Sin embargo, si también tiene un método en la clase

public class Check {

  //@JsonProperty("check")    Not needed anymore
  private Boolean check;

  public Boolean getCheck() {
     return check;
  }
}

Echa un vistazo a esta documentación también: http://fasterxml.github.io/jackson-annotations/javadoc/2.3.0/com/fasterxml/jackson/annotation/JsonProperty.html

Sin anotaciones, el nombre de propiedad inferido (para coincidir con JSON) sería "set", y no not como parece ser la intención isS "isSet". Esto se debe a que según la especificación de Java Beans, los métodos de forma "isXXX" y "setXXX" se toman para significar que hay una propiedad lógica " xxx " para administrar.

Como usted sabe, todo esto se trata de serializar y desalinizar un objeto. Supongamos que hay un objeto:

public class Parameter {
  public String _name;
  public String _value; 
}

La serialización de este objeto es:

{
  "_name": "...",
  "_value": "..."
}

El nombre de la variable se usa directamente para serializar datos. Si está a punto de eliminar la api del sistema de la implementación del sistema, en algunos casos, debe cambiar el nombre de la variable en serialización/deserialización. @JsonProperty es un meta datos para decirle a serializer cómo hacer un objeto serial. Se utiliza para:

• variable nombre
• acceso (LECTURA, ESCRITURA)
• valor predeterminado
• obligatorio / opcional

Del ejemplo:

public class Parameter {
  @JsonProperty(
        value="Name",
        required=true,
        defaultValue="No name",
        access= Access.READ_WRITE)
  public String _name;
  @JsonProperty(
        value="Value",
        required=true,
        defaultValue="Empty",
        access= Access.READ_WRITE)
  public String _value; 
}

Como adición a otras respuestas, la anotación @JsonProperty es realmente importante si usa la anotación @JsonCreator en clases que no tienen un constructor no-arg.

public class ClassToSerialize {

    public enum MyEnum {
        FIRST,SECOND,THIRD
    }

    public String stringValue = "ABCD";
    public MyEnum myEnum;


    @JsonCreator
    public ClassToSerialize(MyEnum myEnum) {
        this.myEnum = myEnum;
    }

    public static void main(String[] args) throws IOException {
        ObjectMapper mapper = new ObjectMapper();

        ClassToSerialize classToSerialize = new ClassToSerialize(MyEnum.FIRST);
        String jsonString = mapper.writeValueAsString(classToSerialize);
        System.out.println(jsonString);
        ClassToSerialize deserialized = mapper.readValue(jsonString, ClassToSerialize.class);
        System.out.println("StringValue: " + deserialized.stringValue);
        System.out.println("MyEnum: " + deserialized.myEnum);
    }
}

En este ejemplo el único constructor está marcado como @JsonCreator, por lo tanto Jackson usará este constructor para crear la instancia. Pero la salida es como:

Serializado: {"stringValue":"ABCD","MyEnum":"FIRST"}

Excepción en thread " lo más importante" com.fasterxml.jackson.databind.exc.InvalidFormatException: No puede construir instancia de com.avl.mbdtool.módulo de verificación.exceptiondocument.ClassToSerialize My MyEnum from String value 'stringValue': valor no uno de la enumeración declarada nombres de instancia: [PRIMERO, SEGUNDO, TERCERO]

Pero después de la adición de la anotación @JsonProperty en el constructor:

@JsonCreator
public ClassToSerialize(@JsonProperty("myEnum") MyEnum myEnum) {
    this.myEnum = myEnum;
}

La deserialización es exitosa:

Serializado: {"MyEnum":"FIRST","stringValue":"ABCD"}

StringValue: ABCD

MyEnum: PRIMERO

Agregar el JsonProperty también garantiza la seguridad en caso de que alguien decida que desea cambiar uno de los nombres de propiedad sin darse cuenta de que la clase en cuestión se serializará a un objeto Json. Si cambian el nombre de la propiedad, JsonProperty garantiza que se utilizará en el objeto Json y no en el nombre de la propiedad.

De JsonProperty javadoc,

Define el nombre de la propiedad lógica, es decir, el nombre del campo de objeto JSON que se utilizará para la propiedad. Si el valor es una cadena vacía (que es la predeterminada), intentará usar el nombre del campo que está anotado.