แปลงคลาสเอกสาร MongoDBเป็น JSON!

ป้อนคลาสเอกสาร MongoDBเพื่อสร้าง JSON ตัวอย่าง! รองรับ Spring Data MongoDB @Document เหมาะสำหรับเอกสาร API และ request body สำหรับทดสอบ (mock request body)
Spring Data MongoDB
ผลลัพธ์
 

แปลงคลาสเอกสาร MongoDBเป็น JSON!

ใส่คลาส @Document ของ Spring Data MongoDB พร้อมคลาสและ record ที่ฝังอยู่ แล้วจะได้ JSON ตัวอย่างของสิ่งที่ controller คืนเมื่อส่งเอกสารนั้น รูปร่างเป็นไปตามการ serialize ของ Jackson ค่าเริ่มต้นใน Spring Boot จึงอธิบาย response ของ API ไม่ใช่ BSON ที่เก็บใน MongoDB

ช่วยประหยัดเวลากับเอกสาร MongoDB ที่เต็มไปด้วยลิสต์ที่ฝังอยู่ ฟิลด์ Map และ timestamp แบบ Instant ซึ่งการเขียนตัวอย่าง response เองน่าเบื่อ และทำให้เห็นความต่างระหว่างรูปแบบที่เก็บกับรูปแบบของ response

วิธีใช้

  1. วางคลาส @Document และคลาสหรือ record ที่ฝังอยู่ลงในช่อง Spring Data MongoDB
  2. คลาสเอกสารที่ไม่มีคลาสอื่นอ้างถึงจะเป็นรากของผลลัพธ์
  3. เปลี่ยนค่าตัวอย่างของ id และวันที่เป็นค่าที่สมจริงก่อนนำ JSON ไปใช้ในเอกสารหรือเทสต์

ตัวอย่าง

อินพุต (Java · Spring Data MongoDB)
@Document(collection = "devices")
public class Device {
    @Id
    private String id;
    private String serial;
    @Field("fw")
    private String firmwareVersion;
    private Map<String, Double> lastReadings;
    private List<Alert> alerts;
    private Instant registeredAt;
}

record Alert(String level, String message, Instant raisedAt) {}
เอาต์พุต (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Alert ใน List<Alert> เป็น record component ของมันคือ level, message และ raisedAt จึงกลายเป็นฟิลด์ Map<String, Double> กลายเป็น {"key": 0} และ Instant เป็นสตริง UTC ที่ลงท้ายด้วย Z @Field("fw") เปลี่ยนแค่ชื่อฟิลด์ที่เก็บใน MongoDB คีย์ JSON จึงยังเป็น firmwareVersion

ฟีเจอร์ที่รองรับ

  • component ของ Java record อย่างใน record Alert(String level, ...) ถูกอ่านเป็นฟิลด์
  • List และ Set กลายเป็นอาร์เรย์หนึ่งสมาชิก Map<String, T> กลายเป็น {"key": value}
  • Instant, ZonedDateTime และ OffsetDateTime ให้ 1970-01-01T00:00:00Z ส่วน LocalDateTime ให้สตริงที่ไม่มี offset
  • ฟิลด์ที่มีไทป์ ObjectId ได้สตริง ObjectId แบบ hex ตัวอย่าง
  • คลาสที่เชื่อมด้วย @DBRef กลายเป็นออบเจ็กต์ซ้อนเมื่ออยู่ในอินพุต
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties และฟิลด์ที่สืบทอดมาใช้กฎเดียวกับหน้า JPA

กรณีการใช้งาน

response ที่มีเอกสารฝังอยู่จำนวนมาก

โครงสร้างที่ MongoDB รวมไว้ในเอกสารเดียว อย่างลิสต์รีวิว map ของตัวเลือก และอาร์เรย์ประวัติ ทำให้ตัวอย่าง response ยาว วางคลาสแล้วทุกระดับที่ซ้อนอยู่จะถูกเขียนออกมาให้

เทียบรูปร่างที่เก็บกับที่คืนออกไป

ชื่อย่อผ่าน @Field หรือฟิลด์ที่จับคู่กับ _id ทำให้คีย์ในฐานข้อมูลต่างจากคีย์ของ API ผลลัพธ์แสดงฝั่ง API คุณจึงวางทั้งสองไว้เทียบกันได้

ข้อควรระวังและข้อจำกัด

  • annotation สำหรับ mapping อย่าง @Field("..."), @Indexed และ @TextIndexed ไม่เปลี่ยนคีย์ JSON และไม่ถูกสะท้อนในผลลัพธ์
  • @Id String id ถูกเก็บเป็น _id แต่ออกจาก Jackson เป็น id ซึ่งคือสิ่งที่ผลลัพธ์แสดง
  • Jackson ค่าเริ่มต้นของ Spring Boot เขียน org.bson.types.ObjectId เป็นออบเจ็กต์ที่มี timestamp และ date ไม่ใช่สตริง hex ถ้าจะส่งเป็นสตริงแบบที่แสดงที่นี่ ให้ลงทะเบียน ToStringSerializer หรือใช้ id แบบ String
  • คลาสที่ไม่อยู่ในอินพุต รวมถึงไทป์ของ Spring Data อย่าง GeoJsonPoint จะเป็น null

คำถามที่พบบ่อย

@Id ควรเป็น ObjectId หรือ String?

ถ้าเป็น String Spring Data จะแปลงเป็น ObjectId ตอนบันทึก และ API คืนสตริง hex ที่สะอาด ถ้าคงไทป์ ObjectId ไว้ ต้องตั้งค่า Jackson เพิ่มสำหรับ response

ฟิลด์ @DBRef กลับมาเป็นออบเจ็กต์ซ้อนจริงหรือ?

@DBRef resolve เอกสารที่อ้างถึงตอนอ่าน (ตอนเข้าถึงครั้งแรกถ้าเป็น lazy) response จึงมีออบเจ็กต์ซ้อน ส่วนการอ้างอิงแบบ manual ที่เก็บแค่ id แบบ ObjectId หรือ String จะคืนแค่ id

ฟิลด์ Map<String, Object> แบบอิสระจะหน้าตาอย่างไร?

ไม่รู้ไทป์ของค่า จึงกลายเป็น {"key": null} ให้เปลี่ยนเป็นค่าชนิดที่เก็บจริงก่อนนำไปใส่ในเอกสาร