Когда используется свойство @JsonProperty и для чего оно используется?

Ответ 1

Вот хороший пример. Я использую его для переименования переменной, потому что JSON исходит из среды .Net, где свойства начинаются с буквы верхнего регистра.

public class Parameter {
  @JsonProperty("Name")
  public String name;
  @JsonProperty("Value")
  public String value; 
}

Это правильно разбирает/из JSON:

"Parameter":{
  "Name":"Parameter-Name",
  "Value":"Parameter-Value"
}

Ответ 2

Я думаю, что OldCurmudgeon и StaxMan верны, но вот один ответ предложения с простым примером для вас.

@JsonProperty (имя), сообщает Jackson ObjectMapper, чтобы сопоставить имя свойства JSON с именем аннотированного имени Java.

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

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

Ответ 3

хорошо для того, что стоит сейчас... JsonProperty ТАКЖЕ используется для указания методов getter и setter для переменной, кроме обычной сериализации и десериализации. Например, предположим, что у вас есть такая полезная нагрузка:

{
  "check": true
}

и класс 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;
  }
}

Затем в этом случае аннотирование JsonProperty подбирается. Однако, если у вас также есть метод в классе

public class Check {

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

  public Boolean getCheck() {
     return check;
  }
}

Посмотрите также на эту документацию: http://fasterxml.github.io/jackson-annotations/javadoc/2.3.0/com/fasterxml/jackson/annotation/JsonProperty.html

Ответ 4

Без аннотаций, выведенное имя свойства (в соответствии с JSON) будет "установлено", а не - как кажется намерение - "isSet". Это связано с тем, что в соответствии со спецификацией Java Beans методы формы "isXxx" и "setXxx" воспринимаются как означающие, что для управления существует логическое свойство "xxx".

Ответ 5

Как вы знаете, все это связано с сериализацией и опреснением объекта. Предположим, что существует объект:

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

Сериализация этого объекта:

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

Имя переменной напрямую используется для сериализации данных. Если вы собираетесь удалить систему api из системной реализации, в некоторых случаях вам нужно переименовать переменную в сериализации/десериализации. @JsonProperty - это метаданные, чтобы рассказать сериализатору как к серийному объекту. Он используется для:

• имя переменной
• доступ (READ, WRITE)
• значение по умолчанию
• требуется/факультативная

из примера:

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

Ответ 6

В дополнение к другим ответам аннотация @JsonProperty действительно важна, если вы используете аннотацию @JsonCreator в классах, не имеющих конструктора 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);
    }
}

В этом примере единственный конструктор отмечен как @JsonCreator, поэтому Джексон будет использовать этот конструктор для создания экземпляра. Но результат выглядит так:

Сериализованный: {"stringValue": "ABCD", "myEnum": "FIRST"}

Исключение в потоке "main" com.fasterxml.jackson.databind.exc.InvalidFormatException: невозможно создать экземпляр com.avl.mbdtool.verificationmodule.exceptiondocument.ClassToSerialize $ MyEnum из значения String 'stringValue': значение не одно из объявленного экземпляра Enum имена: [FIRST, SECOND, THIRD]

Но после добавления аннотации @JsonProperty в конструкторе:

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

Успех десериализации:

Сериализованный: {"myEnum": "FIRST", "stringValue": "ABCD"}

StringValue: ABCD

MyEnum: FIRST

Ответ 7

Добавление JsonProperty также гарантирует безопасность в случае, если кто-то решит, что хочет изменить одно из имен свойств, не понимая, что рассматриваемый класс будет сериализован для объекта Json. Если они изменят имя свойства, JsonProperty гарантирует, что он будет использоваться в объекте Json, а не в имени свойства.

Ответ 8

Из JsonProperty javadoc,

Определяет имя логического свойства, то есть имя поля объекта JSON для использования для свойства. Если значение пустое String (которое является значением по умолчанию), попытается использовать имя аннотированного поля.