ชื่อต่าง ๆ ของคุณสมบัติ JSON ระหว่างการทำให้เป็นอนุกรมและการดีซีเรียลไลเซชัน

เป็นไปได้หรือไม่: มีหนึ่งฟิลด์ในชั้นเรียน แต่มีชื่อแตกต่างกันระหว่างการทำให้เป็นอันดับ / การดีซีเรียลไลซ์เซชันในไลบรารีของ 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: ฟิลด์ที่ไม่รู้จัก "สีแดง"

เพิ่งทดสอบและใช้งานได้:

public class Coordinates {
    byte red;

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

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

แนวคิดคือชื่อวิธีการควรแตกต่างกันดังนั้นแจ็คสันจึงแยกวิเคราะห์เป็นฟิลด์ต่าง ๆ ไม่ใช่เป็นหนึ่งฟิลด์

นี่คือรหัสทดสอบ:

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

คุณสามารถใช้@jsonAliasซึ่งได้รับการแนะนำในแจ็คสัน 2.9.0

ตัวอย่าง:

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

สิ่งนี้ใช้rระหว่างการทำให้เป็นอนุกรม แต่อนุญาตให้redเป็นนามแฝงระหว่างการดีซีเรียลไลเซชัน สิ่งนี้ยังช่วยให้rมีการ deserialized เช่นกัน

คุณสามารถใช้การรวมกันของ@JsonSetterและ@JsonGetterเพื่อควบคุมการดีซีเรียลไลซ์เซชันและการทำให้เป็นอนุกรมของคุณสมบัติของคุณตามลำดับ สิ่งนี้จะช่วยให้คุณสามารถรักษาชื่อ getter และ setter เมธอดมาตรฐานที่สอดคล้องกับชื่อฟิลด์จริงของคุณ

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

ฉันจะผูก getters / setters ที่ต่างกันสองคู่เข้ากับตัวแปรเดียว

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

มีความเป็นไปได้ที่จะมีคู่ 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"}

นี่ไม่ใช่สิ่งที่ฉันคาดหวังว่าจะเป็นวิธีแก้ปัญหา (แม้ว่าจะเป็นกรณีการใช้งานที่ถูกกฎหมาย) ความต้องการของฉันคืออนุญาตให้ลูกค้ารถบั๊กกี้ที่มีอยู่ (แอพมือถือซึ่งเปิดตัวแล้ว) ใช้ชื่ออื่น

วิธีการแก้ปัญหาอยู่ในการให้วิธีการตั้งค่าแยกต่างหากเช่นนี้:

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

ฉันรู้ว่ามันเป็นคำถามเก่า แต่สำหรับฉันฉันได้มันทำงานเมื่อฉันคิดว่ามันขัดแย้งกับห้องสมุด Gson ดังนั้นถ้าคุณใช้ Gson แล้วใช้@SerializedName("name")แทน@JsonProperty("name")หวังว่านี่จะช่วยได้

คำอธิบายประกอบ@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));

}

ทำงานได้ดี

พวกเขาจะต้องรวมสิ่งนี้เป็นคุณสมบัติเพราะตอนนี้การตั้งค่าที่แตกต่างกัน@JsonPropertyสำหรับผลทะเยอทะยานและตัวตั้งค่าในสิ่งที่คุณคาดหวัง (ชื่อทรัพย์สินที่แตกต่างกันในระหว่างการเป็นอันดับและ แจ็คสันรุ่น 2.6.7

คุณสามารถเขียนคลาสที่ทำให้เป็นอนุกรมได้:

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