Tukar kelas dokumen MongoDB kepada JSON!

Masukkan kelas dokumen MongoDB untuk menjana contoh JSON! Menyokong Spring Data MongoDB @Document. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Spring Data MongoDB
Hasil
 

Tukar kelas dokumen MongoDB kepada JSON!

Berikan kelas @Document Spring Data MongoDB bersama kelas terbenam dan record-nya, dan ia membina contoh JSON bagi apa yang dipulangkan oleh controller apabila menghantar dokumen tersebut. Bentuknya mengikut serialisasi Jackson lalai Spring Boot, jadi ia menggambarkan respons API, bukan BSON yang disimpan dalam MongoDB.

Ia menjimatkan masa untuk dokumen MongoDB yang penuh dengan senarai terbenam, medan Map dan timestamp Instant, di mana menulis contoh respons secara manual amat meletihkan, dan ia menjelaskan jurang antara format storan dan format respons.

Cara menggunakan

  1. Tampal kelas @Document serta kelas terbenam atau record-nya ke dalam kotak Spring Data MongoDB.
  2. Kelas dokumen yang tidak dirujuk oleh kelas lain menjadi akar output.
  3. Gantikan placeholder id dan tarikh dengan nilai yang realistik sebelum menggunakan JSON dalam dokumentasi atau ujian.

Contoh

Input (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) {}
Output (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Alert dalam List<Alert> ialah record, jadi komponennya level, message dan raisedAt menjadi medan. Map<String, Double> menjadi {"key": 0}, dan Instant ialah rentetan UTC yang berakhir dengan Z. @Field("fw") hanya menamakan semula medan yang disimpan dalam MongoDB, jadi kunci JSON kekal firmwareVersion.

Ciri yang disokong

  • Komponen record Java, seperti dalam record Alert(String level, ...), dibaca sebagai medan.
  • List dan Set menjadi array satu elemen; Map<String, T> menjadi {"key": value}.
  • Instant, ZonedDateTime dan OffsetDateTime memberikan 1970-01-01T00:00:00Z, manakala LocalDateTime memberikan rentetan tanpa offset.
  • Medan berjenis ObjectId mendapat rentetan ObjectId hex contoh.
  • Kelas yang dipautkan dengan @DBRef menjadi objek bersarang apabila ia sebahagian daripada input.
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties dan medan yang diwarisi mengikut peraturan yang sama seperti halaman JPA.

Kes penggunaan

Respons dengan banyak dokumen terbenam

Struktur yang dipadatkan oleh MongoDB ke dalam satu dokumen, seperti senarai ulasan, peta pilihan dan array sejarah, menghasilkan contoh respons yang panjang. Tampal kelas-kelasnya dan setiap peringkat bersarang ditulis untuk anda.

Membandingkan bentuk yang disimpan dan yang dipulangkan

Nama pendek melalui @Field atau medan yang dipetakan ke _id menjadikan kunci pangkalan data berbeza daripada kunci API. Output menunjukkan sisi API, jadi anda boleh meletakkan kedua-duanya bersebelahan.

Nota dan had

  • Anotasi pemetaan seperti @Field("..."), @Indexed dan @TextIndexed tidak mengubah kunci JSON dan tidak diambil kira.
  • @Id String id disimpan sebagai _id tetapi keluar daripada Jackson sebagai id, dan itulah yang ditunjukkan oleh output.
  • Jackson lalai Spring Boot menulis org.bson.types.ObjectId sebagai objek dengan timestamp dan date, bukan sebagai rentetan hex. Untuk menghantar bentuk rentetan seperti yang ditunjukkan di sini, daftarkan ToStringSerializer atau gunakan id String.
  • Kelas yang tiada dalam input, termasuk jenis Spring Data seperti GeoJsonPoint, menjadi null.

Soalan lazim

Patutkah @Id saya berjenis ObjectId atau String?

Dengan String, Spring Data menukarnya kepada ObjectId semasa menyimpan dan API memulangkan rentetan hex yang kemas. Mengekalkan jenis ObjectId bermakna anda perlukan konfigurasi Jackson tambahan untuk respons.

Adakah medan @DBRef benar-benar dipulangkan sebagai objek bersarang?

@DBRef meleraikan dokumen yang dirujuk semasa membaca (pada akses pertama jika lazy), jadi respons mengandungi objek bersarang. Rujukan manual yang hanya menyimpan id ObjectId atau String hanya memulangkan id tersebut.

Bagaimana rupa medan Map<String, Object> bentuk bebas?

Jenis nilainya tidak diketahui, jadi ia menjadi {"key": null}. Gantikannya dengan jenis nilai yang benar-benar anda simpan sebelum memasukkannya ke dalam dokumentasi.