序列化和反序列化期间JSON属性的不同名称

Question

是否可能:在Jackson库中序列化/反序列化期间,在类中有一个字段,但它有不同的名称？

例如,我有"Coordiantes"课程.

class Coordinates{
  int red;
}

对于来自JSON的反序列化,希望具有如下格式:

{
  "red":12
}

但是当我将序列化对象时,结果应该是这样的:

{
  "r":12
}

我尝试通过@JsonProperty在getter和setter上应用注释来实现它(具有不同的值):

class Coordiantes{
    int red;

    @JsonProperty("r")
    public byte getRed() {
      return red;
    }

    @JsonProperty("red")
    public void setRed(byte red) {
      this.red = red;
    }
}

但我有一个例外:

org.codehaus.jackson.map.exc.UnrecognizedPropertyException:无法识别的字段"red"

Answer 1

刚测试过,这个有效:

public class Coordinates {
    byte red;

    @JsonProperty("r")
    public byte getR() {
      return red;
    }

    @JsonProperty("red")
    public void setRed(byte red) {
      this.red = red;
    }
}

这个想法是方法名称应该是不同的,因此jackson将其解析为不同的字段,而不是一个字段.

这是测试代码:

Coordinates c = new Coordinates();
c.setRed((byte) 5);

ObjectMapper mapper = new ObjectMapper();
System.out.println("Serialization: " + mapper.writeValueAsString(c));

Coordinates r = mapper.readValue("{\"red\":25}",Coordinates.class);
System.out.println("Deserialization: " + r.getR());

结果:

Serialization: {"r":5}
Deserialization: 25

Answer 2

您可以使用在jackson 2.9.0中引入的@jsonAlias

例:

public class Info {
  @JsonAlias({ "r", "red" })
  public String r;
}

Answer 3

我会将两个不同的getter/setter绑定到一个变量:

class Coordinates{
    int red;

    @JsonProperty("red")
    public byte getRed() {
      return red;
    }

    public void setRed(byte red) {
      this.red = red;
    }

    @JsonProperty("r")
    public byte getR() {
      return red;
    }

    public void setR(byte red) {
      this.red = red;
    }
}

Answer 4

您可以使用@JsonSetter和@JsonGetter的组合来分别控制反序列化和属性的序列化.

import com.fasterxml.jackson.annotation.JsonSetter;    
import com.fasterxml.jackson.annotation.JsonGetter;

class Coordinates {
    private int red;

    //# Used during serialization
    @JsonGetter("r")
    public int getRed() {
        return red;
    }

    //# Used during deserialization
    @JsonSetter("red")
    public void setRed(int red) {
        this.red = red;
    }
}

Answer 5

@JsonAlias在 Jackson 2.9+ 中引入的注释，无需提及@JsonProperty要使用多个别名（json 属性的不同名称）反序列化的项目，效果很好。

我在我的用例com.fasterxml.jackson.annotation.JsonAlias中使用了包一致性。com.fasterxml.jackson.databind.ObjectMapper

例如：

@Data
@Builder
public class Chair {

    @JsonAlias({"woodenChair", "steelChair"})
    private String entityType;

}


@Test
public void test1() {

   String str1 = "{\"woodenChair\":\"chair made of wood\"}";
   System.out.println( mapper.readValue(str1, Chair.class));
   String str2 = "{\"steelChair\":\"chair made of steel\"}";
   System.out.println( mapper.readValue(str2, Chair.class));

}

工作正常。

Answer 6

可以有正常的吸气剂/设定剂对。您只需要在中指定访问模式@JsonProperty

这是为此的单元测试：

public class JsonPropertyTest {

  private static class TestJackson {

    private String color;

    @JsonProperty(value = "device_color", access = JsonProperty.Access.READ_ONLY)
    public String getColor() {
      return color;
    };

    @JsonProperty(value = "color", access = JsonProperty.Access.WRITE_ONLY)
    public void setColor(String color) {
      this.color = color;
    }

  }

  @Test
  public void shouldParseWithAccessModeSpecified() throws Exception {
    String colorJson = "{\"color\":\"red\"}";
    ObjectMapper mapper = new ObjectMapper();
    TestJackson colotObject = mapper.readValue(colorJson, TestJackson.class);

    String ser = mapper.writeValueAsString(colotObject);
    System.out.println("Serialized colotObject: " + ser);
  }
}

我得到的输出如下：

Serialized colotObject: {"device_color":"red"}

Answer 7

您可以使用此变体：

import lombok.Getter;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonProperty;

//...

@JsonProperty(value = "rr") // for deserialization
@Getter(onMethod_ = {@JsonGetter(value = "r")}) // for serialization
private String rrrr;

使用 Lombok 吸气剂

Answer 8

这不是我期望的解决方案(虽然它是一个合法的用例).我的要求是允许现有的错误客户端(已经发布的移动应用程序)使用备用名称.

解决方案在于提供一个单独的setter方法,如下所示:

@JsonSetter( "r" )
public void alternateSetRed( byte red ) {
    this.red = red;
}