แจ็กสันกับ JSON: ฟิลด์ที่ไม่รู้จักไม่ถูกทำเครื่องหมายว่าเพิกเฉย

ฉันต้องแปลงสตริง JSON ให้เป็นวัตถุ Java ฉันใช้ Jackson สำหรับการจัดการ JSON ฉันไม่สามารถควบคุมอินพุต JSON ได้ (ฉันอ่านจากเว็บเซอร์วิส) นี่คืออินพุต JSON ของฉัน:

{"wrapper":[{"id":"13","name":"Fred"}]}

นี่คือกรณีการใช้งานที่เรียบง่าย:

private void tryReading() {
    String jsonStr = "{\"wrapper\"\:[{\"id\":\"13\",\"name\":\"Fred\"}]}";
    ObjectMapper mapper = new ObjectMapper();  
    Wrapper wrapper = null;
    try {
        wrapper = mapper.readValue(jsonStr , Wrapper.class);
    } catch (Exception e) {
        e.printStackTrace();
    }
    System.out.println("wrapper = " + wrapper);
}

คลาสเอนทิตีของฉันคือ:

public Class Student { 
    private String name;
    private String id;
    //getters & setters for name & id here
}

คลาสของ Wrapper ของฉันนั้นเป็นวัตถุคอนเทนเนอร์เพื่อให้ได้รายชื่อนักเรียนของฉัน:

public Class Wrapper {
    private List<Student> students;
    //getters & setters here
}

ฉันได้รับข้อผิดพลาดนี้และ "เสื้อคลุม" nullผลตอบแทน ฉันไม่แน่ใจว่ามีอะไรขาดหายไป ใครช่วยได้บ้าง

org.codehaus.jackson.map.exc.UnrecognizedPropertyException: 
    Unrecognized field "wrapper" (Class Wrapper), not marked as ignorable
 at [Source: java.io.StringReader@1198891; line: 1, column: 13] 
    (through reference chain: Wrapper["wrapper"])
 at org.codehaus.jackson.map.exc.UnrecognizedPropertyException
    .from(UnrecognizedPropertyException.java:53)

คุณสามารถใช้คำอธิบายประกอบระดับของแจ็คสัน:

import com.fasterxml.jackson.annotation.JsonIgnoreProperties

@JsonIgnoreProperties
class { ... }

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

@JsonIgnoreProperties(ignoreUnknown = true)

คุณสามารถใช้ได้

ObjectMapper objectMapper = getObjectMapper();
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

มันจะละเว้นคุณสมบัติทั้งหมดที่ไม่ได้ประกาศ

คำตอบแรกนั้นเกือบจะถูกต้อง แต่สิ่งที่จำเป็นคือการเปลี่ยนเมธอด getter, ไม่ใช่ฟิลด์ - ฟิลด์เป็นแบบส่วนตัว (และไม่ตรวจจับอัตโนมัติ); เพิ่มเติม getters มีความสำคัญเหนือกว่าช่องถ้ามองเห็นทั้งคู่ (มีหลายวิธีในการทำให้ฟิลด์ส่วนตัวมองเห็นได้เช่นกัน แต่ถ้าคุณต้องการให้มี getter ก็ไม่มีประเด็นมากนัก)

ดังนั้นผู้ทะเยอทะยานควรตั้งชื่อgetWrapper()หรือทำหมายเหตุประกอบด้วย:

@JsonProperty("wrapper")

หากคุณต้องการชื่อวิธี getter ตามที่เป็นอยู่

ใช้ Jackson 2.6.0 สิ่งนี้ใช้ได้กับฉัน:

private static final ObjectMapper objectMapper = 
    new ObjectMapper()
        .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

และด้วยการตั้งค่า:

@JsonIgnoreProperties(ignoreUnknown = true)

สามารถทำได้ 2 วิธี:

1. ทำเครื่องหมาย POJO เพื่อละเว้นคุณสมบัติที่ไม่รู้จัก

   @JsonIgnoreProperties(ignoreUnknown = true)

2. กำหนดค่า ObjectMapper ที่ทำให้เป็นอนุกรม / ยกเลิกการจัดอันดับ POJO / json ดังต่อไปนี้:

   ObjectMapper mapper =new ObjectMapper();            
   // for Jackson version 1.X        
   mapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);
   // for Jackson version 2.X
   mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) 

มันทำงานได้อย่างสมบูรณ์แบบสำหรับฉัน

ObjectMapper objectMapper = new ObjectMapper();
objectMapper.configure(
    DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);

@JsonIgnoreProperties(ignoreUnknown = true) คำอธิบายประกอบไม่ได้

มันใช้งานได้ดีกว่าทั้งหมดโปรดดูที่คุณสมบัตินี้

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;

    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    projectVO = objectMapper.readValue(yourjsonstring, Test.class);

หากคุณใช้งาน Jackson 2.0

ObjectMapper mapper = new ObjectMapper();
mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);

ตามเอกสารคุณสามารถละเว้นฟิลด์ที่เลือกหรือฟิลด์ uknown ทั้งหมด:

 // to prevent specified fields from being serialized or deserialized
 // (i.e. not include in JSON output; or being set even if they were included)
 @JsonIgnoreProperties({ "internalId", "secretKey" })

 // To ignore any unknown properties in JSON input without exception:
 @JsonIgnoreProperties(ignoreUnknown=true)

มันทำงานให้ฉันด้วยรหัสต่อไปนี้:

ObjectMapper mapper =new ObjectMapper();    
mapper.configure(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES, false);

การเพิ่ม setters และ getters แก้ไขปัญหาสิ่งที่ฉันรู้สึกว่าเป็นปัญหาจริงคือวิธีแก้ปัญหา แต่ไม่ใช่วิธีที่จะระงับ / เพิกเฉยต่อข้อผิดพลาด ฉันได้รับข้อผิดพลาด " ฟิลด์ที่ไม่รู้จัก .. ไม่ได้ทำเครื่องหมายว่าเพิกเฉย .. "

แม้ว่าฉันจะใช้คำอธิบายประกอบด้านล่างด้านบนของชั้นเรียน แต่ก็ไม่สามารถแยกวิเคราะห์วัตถุ json และให้ฉันป้อน

@JsonIgnoreProperties (เพิกเฉย = จริง)

จากนั้นฉันก็รู้ว่าฉันไม่ได้เพิ่ม setters และ getters หลังจากเพิ่ม setters และ getters ให้กับ "Wrapper" และไปที่ "Student" มันใช้งานได้อย่างมีเสน่ห์

แจ็กสันบ่นเพราะไม่สามารถหาทุ่งใน Wrapper ในชั้นเรียนของคุณที่เรียกว่า "wrapper" มันทำเช่นนี้เพราะวัตถุ JSON ของคุณมีคุณสมบัติที่เรียกว่า "wrapper"

ฉันคิดว่าการแก้ไขคือการเปลี่ยนชื่อฟิลด์คลาส Wrapper ของคุณเป็น "wrapper" แทนที่จะเป็น "students"

ฉันลองใช้วิธีการด้านล่างและใช้งานได้กับการอ่านรูปแบบ JSON กับแจ็คสัน ใช้โซลูชันที่แนะนำแล้วของ: หมายเหตุประกอบ getter ด้วย@JsonProperty("wrapper")

คลาส wrapper ของคุณ

public Class Wrapper{ 
  private List<Student> students;
  //getters & setters here 
} 

คำแนะนำของฉันสำหรับคลาส wrapper

public Class Wrapper{ 

  private StudentHelper students; 

  //getters & setters here 
  // Annotate getter
  @JsonProperty("wrapper")
  StudentHelper getStudents() {
    return students;
  }  
} 


public class StudentHelper {

  @JsonProperty("Student")
  public List<Student> students; 

  //CTOR, getters and setters
  //NOTE: If students is private annotate getter with the annotation @JsonProperty("Student")
}

อย่างไรก็ตามสิ่งนี้จะให้ผลลัพธ์ของรูปแบบ:

{"wrapper":{"student":[{"id":13,"name":Fred}]}}

นอกจากนี้สำหรับข้อมูลเพิ่มเติมโปรดดูที่https://github.com/FasterXML/jackson-annotations

หวังว่านี่จะช่วยได้

วิธีการแก้ปัญหานี้เป็นเรื่องทั่วไปเมื่ออ่านกระแส json และต้องได้รับเพียงบางฟิลด์ในขณะที่เขตข้อมูลที่ไม่ได้แมปอย่างถูกต้องในระดับโดเมนของคุณสามารถละเว้น:

import org.codehaus.jackson.annotate.JsonIgnoreProperties;
@JsonIgnoreProperties(ignoreUnknown = true)

โซลูชันอย่างละเอียดจะใช้เครื่องมือเช่น jsonschema2pojo เพื่อสร้างคลาสโดเมนที่ต้องการโดยอัตโนมัติเช่น Student จาก Schema ของ json Response คุณสามารถทำหลังโดย json ออนไลน์เพื่อแปลง schema

ใส่คำอธิบายประกอบลงในฟิลด์นักเรียนด้านล่างเนื่องจากมีความไม่ตรงกันในชื่อของคุณสมบัติ json และคุณสมบัติ java

public Class Wrapper {
    @JsonProperty("wrapper")
    private List<Student> students;
    //getters & setters here
}

อย่างที่ไม่มีใครพูดถึงฉันคิดว่าฉันจะ ...

ปัญหาคือคุณสมบัติของคุณใน JSON ของคุณเรียกว่า "wrapper" และคุณสมบัติของคุณใน Wrapper.class เรียกว่า "students"

ดังนั้นทั้ง ...

1. แก้ไขชื่อของคุณสมบัติในคลาสหรือ JSON
2. อธิบายตัวแปรคุณสมบัติของคุณตามความคิดเห็นของ StaxMan
3. อธิบาย setter (ถ้าคุณมี)

ชุดของประชาชนเขตชั้นเรียนของคุณไม่ส่วนตัว

public Class Student { 
    public String name;
    public String id;
    //getters & setters for name & id here
}

สิ่งที่ใช้ได้ผลสำหรับฉันคือการเผยแพร่สู่สาธารณะ มันแก้ไขปัญหาให้ฉัน

ทั้งเปลี่ยน

public Class Wrapper {
    private List<Student> students;
    //getters & setters here
}

ถึง

public Class Wrapper {
    private List<Student> wrapper;
    //getters & setters here
}

---- หรือ ----

เปลี่ยนสตริง JSON ของคุณเป็น

{"students":[{"id":"13","name":"Fred"}]}

ข้อมูลของคุณ

{"wrapper":[{"id":"13","name":"Fred"}]}

ระบุว่าเป็นวัตถุโดยมีฟิลด์ชื่อ "wrapper" ซึ่งเป็นชุดของนักเรียน ดังนั้นคำแนะนำของฉันจะเป็น

Wrapper = mapper.readValue(jsonStr , Wrapper.class);

โดยWrapperนิยามว่าเป็น

class Wrapper {
    List<Student> wrapper;
}

Firebase Android ใหม่เปิดตัวการเปลี่ยนแปลงครั้งใหญ่; ด้านล่างสำเนาเอกสาร:

[ https://firebase.google.com/support/guides/firebase-android] :

อัพเดตอ็อบเจ็กต์โมเดล Java ของคุณ

เช่นเดียวกับ SDK 2.x ฐานข้อมูล Firebase อัตโนมัติจะแปลงวัตถุ Java ที่คุณส่งผ่านไปยังDatabaseReference.setValue()เข้าไป JSON และสามารถอ่าน JSON เข้าไปในวัตถุ Java DataSnapshot.getValue()ใช้

ใน SDK ใหม่เมื่ออ่าน JSON เป็นวัตถุ Java ที่มีDataSnapshot.getValue()คุณสมบัติที่ไม่รู้จักใน JSON @JsonIgnoreExtraProperties(ignoreUnknown=true)จะถูกละเลยในขณะนี้โดยเริ่มต้นเพื่อให้คุณไม่จำเป็นอีกต่อไป

หากต้องการยกเว้นฟิลด์ / getters เมื่อเขียนวัตถุ Java เพื่อ JSON, คำอธิบายประกอบเรียกว่าตอนนี้แทน@Exclude@JsonIgnore

BEFORE

@JsonIgnoreExtraProperties(ignoreUnknown=true)
public class ChatMessage {
   public String name;
   public String message;
   @JsonIgnore
   public String ignoreThisField;
}

dataSnapshot.getValue(ChatMessage.class)

AFTER

public class ChatMessage {
   public String name;
   public String message;
   @Exclude
   public String ignoreThisField;
}

dataSnapshot.getValue(ChatMessage.class)

หากมีคุณสมบัติพิเศษใน JSON ของคุณที่ไม่ได้อยู่ในคลาส Java ของคุณคุณจะเห็นคำเตือนนี้ในไฟล์บันทึก:

W/ClassMapper: No setter/field for ignoreThisProperty found on class com.firebase.migrationguide.ChatMessage

คุณสามารถกำจัดคำเตือนนี้ได้โดยใส่@IgnoreExtraPropertiesคำอธิบายประกอบไว้ในชั้นเรียนของคุณ ถ้าคุณต้องการให้ฐานข้อมูล Firebase ทำงานเหมือนที่ทำใน 2.x SDK และโยนข้อยกเว้นหากมีคุณสมบัติที่ไม่รู้จักคุณสามารถใส่@ThrowOnExtraPropertiesคำอธิบายประกอบไว้ในชั้นเรียนของคุณ

สำหรับส่วนของฉันบรรทัดเดียว

@JsonIgnoreProperties(ignoreUnknown = true)

ไม่ได้ทำงานด้วย

เพียงเพิ่ม

@JsonInclude(Include.NON_EMPTY)

แจ็คสัน 2.4.0

มันทำงานได้อย่างสมบูรณ์แบบสำหรับฉัน

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

ฉันแก้ไขปัญหานี้โดยเพียงแค่เปลี่ยนลายเซ็นของ setter และ getter method ของคลาส POJO ของฉัน สิ่งที่ฉันต้องทำคือเปลี่ยนวิธีการgetObjectเพื่อให้ตรงกับสิ่งที่ mapper กำลังมองหา ในกรณีของฉันฉันมีgetImageUrlเดิม แต่ข้อมูล JSON มีimage_urlซึ่งทำให้ mapper หยุดทำงาน ฉันเปลี่ยนทั้ง setter และ getters เป็นgetImage_url และ setImage_urlsetImage_url

หวังว่านี่จะช่วยได้

POJO ควรกำหนดเป็น

คลาสการตอบกลับ

public class Response {
    private List<Wrapper> wrappers;
    // getter and setter
}

คลาส Wrapper

public class Wrapper {
    private String id;
    private String name;
    // getters and setters
}

และ mapper เพื่ออ่านค่า

Response response = mapper.readValue(jsonStr , Response.class);

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

public class Wrapper {
    private List<Student> wrapper;
    //getters & setters here
}

ความเป็นไปได้อีกอย่างหนึ่งคือคุณสมบัตินี้ใน application.properties spring.jackson.deserialization.fail-on-unknown-properties=falseซึ่งไม่ต้องการการเปลี่ยนแปลงรหัสอื่น ๆ ในแอปพลิเคชันของคุณ และเมื่อคุณเชื่อว่าสัญญามีความเสถียรคุณสามารถลบคุณสมบัตินี้หรือทำเครื่องหมายเป็นจริง

นี่อาจไม่ใช่ปัญหาเดียวกับที่ OP มี แต่ในกรณีที่มีคนมาที่นี่ด้วยความผิดพลาดแบบเดียวกันฉันก็จะช่วยให้พวกเขาแก้ปัญหาได้ ฉันได้รับข้อผิดพลาดเดียวกับ OP เมื่อฉันใช้ ObjectMapper จากการพึ่งพาที่แตกต่างกันเป็นคำอธิบายประกอบ JsonProperty

งานนี้:

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.annotation.JsonProperty;

ไม่ทำงาน, ไม่เป็นผล:

import org.codehaus.jackson.map.ObjectMapper; //org.codehaus.jackson:jackson-mapper-asl:1.8.8
import com.fasterxml.jackson.annotation.JsonProperty; //com.fasterxml.jackson.core:jackson-databind:2.2.3

Google นำมาให้ฉันที่นี่และฉันรู้สึกประหลาดใจที่เห็นคำตอบ ... ทุกข้อเสนอแนะผ่านข้อผิดพลาด ( ซึ่งมักจะกลับ 4 เท่าในภายหลังในการพัฒนา ) แทนที่จะแก้มันจนกว่าสุภาพบุรุษคนนี้คืนค่าด้วยศรัทธาใน SO!

objectMapper.readValue(responseBody, TargetClass.class)

ใช้ในการแปลง json String เป็นวัตถุคลาสสิ่งที่ขาดหายไปคือTargetClassควรมีgetter / setters สาธารณะ เหมือนกันในตัวอย่างคำถามของ OP ด้วยเช่นกัน! :)

ผ่านlombokชั้นเรียนของคุณดังต่อไปนี้ควรใช้งานได้ !!

@Data
@Builder
public class TargetClass {
    private String a;
}

นำเข้า com.fasterxml.jackson.annotation.JsonIgnoreProperties;

@JsonIgnoreProperties