使用Jackson在JSON中更改字段名称

时间:2011-08-31 20:54:20

标签: java jquery hibernate jquery-ui jackson

我正在使用杰克逊将我的一个物体转换为json。 该对象有两个字段:

@Entity
public class City {
   @id
   Long id;
   String name;
   public String getName() { return name; }
   public void setName(String name){ this.name = name; }
   public Long getId() { return id; }
   public void setName(Long id){ this.id = id; }
}

由于我想在jQuery自动完成功能中使用它,我希望'id'在json中显示为'value','name'显示为'label'。杰克逊的文档在这方面并不清楚,我已经尝试了每一个注释,即使它远远看起来像我需要的那样,但我不能让name显示为label和{{1}在json中显示为id

有没有人知道如何做到这一点或者是否可能?

4 个答案:

答案 0 :(得分:284)

您是否尝试过使用@JsonProperty?

@Entity
public class City {
   @id
   Long id;
   String name;

   @JsonProperty("label")
   public String getName() { return name; }

   public void setName(String name){ this.name = name; }

   @JsonProperty("value")
   public Long getId() { return id; }

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

答案 1 :(得分:41)

请注意Jackson 1.x中有org.codehaus.jackson.annotate.JsonProperty,Jackson 2.x中有com.fasterxml.jackson.annotation.JsonProperty。检查您正在使用的ObjectMapper(从哪个版本开始),并确保使用正确的注释。

答案 2 :(得分:8)

还有一个选项可以重命名字段:

Jackson MixIns

如果您处理的第三方课程非常有用,您无法注释,或者您只是不想使用Jackson特定注释污染课程。

Mixins的Jackson文档已经过时,因此example可以提供更清晰的信息。本质上:您创建mixin类,以您想要的方式进行序列化。然后将其注册到ObjectMapper:

objectMapper.addMixIn(ThirdParty.class, MyMixIn.class);

答案 3 :(得分:5)

Jackson

如果您使用的是Jackson,则可以使用@JsonProperty注释来自定义给定JSON属性的名称。

因此,您只需要使用@JsonProperty注释来注释实体字段并提供自定义JSON属性名称,如下所示:

@Entity
public class City {

   @Id
   @JsonProperty("value")
   private Long id;

   @JsonProperty("label")
   private String name;

   //Getters and setters omitted for brevity
}

JavaEE或JakartaEE JSON-B

JSON-B是用于将Java对象与JSON相互转换的标准绑定层。如果您使用的是JSON-B,则可以通过@JsonbProperty批注覆盖JSON属性名称:

@Entity
public class City {

   @Id
   @JsonbProperty("value")
   private Long id;

   @JsonbProperty("label")
   private String name;

   //Getters and setters omitted for brevity
}