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

例如,我有一个类“coordindiantes”。

class Coordinates{
  int red;
}

对于JSON的反序列化,希望有这样的格式:

{
  "red":12
}

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

{
  "r":12
}

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

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。exx . unrecognizedpropertyexception:无法识别的字段“red”


当前回答

这并不是我所期望的解决方案(尽管这是一个合理的用例)。我的要求是允许一个存在bug的客户端(一个已经发布的移动应用程序)使用替代名称。

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

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

其他回答

使用Jackson 2.9+引入的@JsonAlias进行注释,而不用在要用多个别名(json属性的不同名称)反序列化的项上提到@JsonProperty就可以了。

我使用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));

}

工作得很好。

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

例子:

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

在序列化期间使用r,但在反序列化期间允许使用red作为别名。不过,这仍然允许反序列化r。

你可以写一个序列化类来实现:

public class Symbol

{
     private String symbol;

     private String name;

     public String getSymbol() {
        return symbol;
    }
    public void setSymbol(String symbol) {
        this.symbol = symbol;
    }    
    public String getName() {
        return name;
    }    
    public void setName(String name) {
        this.name = name;
    }
}
public class SymbolJsonSerializer extends JsonSerializer<Symbol> {

    @Override
    public void serialize(Symbol symbol, JsonGenerator jgen, SerializerProvider serializers) throws IOException, JsonProcessingException {
        jgen.writeStartObject();

        jgen.writeStringField("symbol", symbol.getSymbol());
         //Changed name to full_name as the field name of Json string
        jgen.writeStringField("full_name", symbol.getName());
        jgen.writeEndObject(); 
    }
}

            ObjectMapper mapper = new ObjectMapper();

            SimpleModule module = new SimpleModule();
            module.addSerializer(Symbol.class, new SymbolJsonSerializer());
            mapper.registerModule(module); 

            //only convert non-null field, option...
            mapper.setSerializationInclusion(Include.NON_NULL); 

            String jsonString = mapper.writeValueAsString(symbolList);

这并不是我所期望的解决方案(尽管这是一个合理的用例)。我的要求是允许一个存在bug的客户端(一个已经发布的移动应用程序)使用替代名称。

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

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

可以有普通的getter/setter对。您只需要在@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"}