如何使用 Jackson 更改 JSON 中的字段名称

Question

我正在使用 Jackson 将我的对象转换为 json。 该对象有 2 个字段：

@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 中显示为“值”，“名称”显示为“标签”。 Jackson 的文档对此并不清楚，我已经尝试了所有注释，即使在远程看来它也能满足我的需要，但我无法让 name 显示为 label 和 id 在 json 中显示为 value。

有谁知道如何做到这一点或者这是否可能？

Answer 1

您是否尝试过使用@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; }
}

Answer 2

请注意，Jackson 1.x 中有 org.codehaus.jackson.annotate.JsonProperty ，Jackson 2.x 中有 com.fasterxml.jackson.annotation.JsonProperty 。检查您正在使用哪个 ObjectMapper（来自哪个版本），并确保使用正确的注释。

Answer 3

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，则可以通过 < 覆盖 JSON 属性名称code>@JsonbProperty 注解：

@Entity
public class City {

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

   @JsonbProperty("label")
   private String name;

   //Getters and setters omitted for brevity
}

Answer 4

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

Jackson MixIns。

如果您处理第三方类，而您无法对其进行注释，或者您只是不想用 Jackson 特定的注释来污染该类，那么这很有用。

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

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