java - 何时使用 @JsonProperty 属性以及它的用途是什么？

Question

这个 bean 的“状态”：

public class State {

    private boolean isSet;

    @JsonProperty("isSet")
    public boolean isSet() {
        return isSet;
    }

    @JsonProperty("isSet")
    public void setSet(boolean isSet) {
        this.isSet = isSet;
    }

}

使用 ajax 'success' 回调通过网络发送：

        success : function(response) {  
            if(response.State.isSet){   
                alert('success called successfully)
            }

这里需要注解@JsonProperty 吗？使用它有什么好处？我想我可以删除这个注释而不会造成任何副作用。

在https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations上阅读此注释我不知道何时需要使用此注释？

score 298 · Accepted Answer

这是一个很好的例子。我使用它来重命名变量，因为 JSON 来自.Net属性以大写字母开头的环境。

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

这正确地解析到/从 JSON：

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

score 56 · Accepted Answer

我认为 OldCurmudgeon 和 StaxMan 都是正确的，但这里有一个简单的例子回答你。

@JsonProperty(name)，告诉 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;
 }

score 43 · Accepted Answer

好吧，现在它的价值...除了通常的序列化和反序列化之外，JsonProperty 还用于指定变量的 getter 和 setter 方法。例如，假设您有这样的有效负载：

{
  "check": true
}

和一个反序列化器类：

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

score 25 · Accepted Answer

如果没有注释，推断的属性名称（从 JSON 匹配）将是“set”，而不是 - 似乎是意图 - “isSet”。这是因为根据 Java Beans 规范，采用“isXxx”和“setXxx”形式的方法意味着有逻辑属性“xxx”要管理。

score 10 · Accepted Answer

如您所知，这完全是关于序列化和淡化对象。假设有一个对象：

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

这个对象的序列化是：

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

变量名直接用于序列化数据。如果您要从系统实现中删除系统 api，在某些情况下，您必须在序列化/反序列化中重命名变量。@JsonProperty 是一个元数据，用于告诉序列化器如何序列化对象。它用于：

变量的名称
访问（读、写）
默认值
必需/可选

例如：

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

score 9 · Accepted Answer

添加 JsonProperty 还可以确保安全，以防有人决定要更改其中一个属性名称而没有意识到所讨论的类将被序列化为 Json 对象。如果他们更改属性名称，JsonProperty 确保它将在 Json 对象中使用，而不是属性名称。

score 8 · Accepted Answer

除了上面的所有答案，不要忘记文档中说的部分

标记注释，可用于将非静态方法定义为逻辑属性的“setter”或“getter”（取决于其签名），或用作逻辑属性的非静态对象字段（序列化、反序列化）财产。

如果您non-static的类中有一个不是常规的方法，那么您可以通过在其上使用注释使其getter or setter像 a 一样。getter and setter请参阅下面的示例

public class Testing {
    private Integer id;
    private String username;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getIdAndUsername() {
        return id + "." + username; 
    }

    public String concatenateIdAndUsername() {
        return id + "." + username; 
    }
}

当上述对象被序列化时，响应将包含

用户名来自getUsername()
来自getId()
idAndUsername 来自getIdAndUsername*

由于该方法getIdAndUsername以getthen 开头，因此它被视为普通 getter，为什么你可以用@JsonIgnore.

如果您注意到concatenateIdAndUsername没有返回，那是因为它的名称没有以开头，get并且如果您希望该方法的结果包含在响应中，那么您可以使用@JsonProperty("...")它，它将被视为正常getter/setter，如上面突出显示的文档中所述.

score 4 · Accepted Answer

作为其他答案的补充，如果您在没有无参数构造函数的类中@JsonProperty使用注释，则注释非常重要。@JsonCreator

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，因此 Jackson 将使用这个构造函数来创建实例。但输出是这样的：

序列化：{"stringValue":"ABCD","myEnum":"FIRST"}

线程“主”com.fasterxml.jackson.databind.exc.InvalidFormatException 中的异常：无法 从字符串值“stringValue”构造 ClassToSerialize$MyEnum 的实例：值不是声明的枚举实例名称之一：[FIRST，SECOND，THIRD]

但是在@JsonProperty构造函数中添加注解之后：

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

反序列化成功：

序列化：{"myEnum":"FIRST","stringValue":"ABCD"}

字符串值：ABCD

我的枚举：第一

score 0 · Accepted Answer

来自 JsonProperty javadoc，

定义逻辑属性的名称，即用于属性的 JSON 对象字段名称。如果值为空字符串（这是默认值），将尝试使用被注释的字段的名称。

java - 何时使用 @JsonProperty 属性以及它的用途是什么？

9 回答 9

Related

Reference