Tukar entiti JPA kepada JSON!

Masukkan entiti JPA untuk menjana contoh JSON! Menyokong JPA @Entity, Hibernate, Spring Boot. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
JPA
Hasil
 

Tukar entiti JPA kepada JSON!

Tampal kelas @Entity JPA Spring Boot dan lihat contoh JSON dalam bentuk yang dihasilkan oleh Jackson apabila controller memulangkan entity tersebut. Nama medan, @JsonIgnore dan @JsonProperty, medan yang diwarisi daripada @MappedSuperclass, serta jenis tarikh Java 8 semuanya dikendalikan mengikut tetapan Jackson lalai Spring Boot.

Gunakannya untuk contoh REST Docs atau Swagger, body request Postman, atau untuk mengaudit medan yang terbocor apabila entity didedahkan tanpa DTO.

Cara menggunakan

  1. Tampal kelas entity ke dalam kotak JPA. Import dan anotasi Lombok boleh dibiarkan; sertakan kelas induk, entity berkaitan dan enum supaya nilainya diisi.
  2. Kelas yang tidak dirujuk oleh kelas lain menjadi akar. Apabila entity saling merujuk, kelas public yang dipilih.
  3. Salin hasilnya ke dalam ujian atau dokumentasi anda.

Contoh

Input (Java · JPA)
@MappedSuperclass
public abstract class BaseEntity {
    @Id @GeneratedValue
    private Long id;
    private LocalDateTime createdAt;
}

@Entity
public class Appointment extends BaseEntity {
    private LocalDate visitDate;
    private BigDecimal fee;
    @Enumerated(EnumType.STRING)
    private Status status;
    @ManyToOne(fetch = FetchType.LAZY)
    private Patient patient;

    public enum Status { BOOKED, DONE, CANCELED }
}

@Entity
class Patient extends BaseEntity {
    private String name;
    @JsonIgnore
    private String residentNumber;
    @OneToMany(mappedBy = "patient")
    private List<Appointment> appointments;
}
Output (JSON)
{
  "id": 0,
  "createdAt": "1970-01-01T00:00:00",
  "visitDate": "1970-01-01",
  "fee": 0,
  "status": "BOOKED",
  "patient": {
    "id": 0,
    "createdAt": "1970-01-01T00:00:00",
    "name": "",
    "appointments": []
  }
}

Appointment dan Patient saling merujuk, jadi kelas public Appointment ialah akar dan Patient.appointments dipotong menjadi array kosong dan bukannya berulang tanpa henti. id dan createdAt daripada BaseEntity diletakkan dahulu, dan residentNumber hilang kerana @JsonIgnore. LocalDateTime ialah rentetan ISO tanpa offset, dan enum menunjukkan pemalar pertamanya, "BOOKED".

Ciri yang disokong

  • Medan static dan transient serta medan @JsonIgnore dilangkau, begitu juga nama yang disenaraikan dalam @JsonIgnoreProperties({"..."}) di peringkat kelas.
  • @JsonProperty("doctor_name") menamakan semula kunci JSON.
  • Apabila kelas induk (@MappedSuperclass atau sebarang extends) ada dalam input, medannya diletakkan dahulu.
  • Nilai lalai entity seperti private Status status = Status.ACTIVE; atau private int visits = 0; dipaparkan sebagai nilai tersebut, dan getter terkira tanpa medan sandaran (public int getAge()) muncul sebagai kunci tambahan, sama seperti yang dikeluarkan oleh Jackson.
  • Output tarikh mengikut lalai Spring Boot: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • Wrapper numerik seperti BigDecimal dan Long memberikan 0, UUID memberikan UUID serba sifar, dan byte[] memberikan rentetan base64 "AA==".
  • List/Set memberikan array satu elemen, Map<Long, String> memberikan objek dengan kunci yang sepadan ({"0": ""}), dan Optional<T> dibuka kepada nilai dalamannya.
  • Association dua hala (@OneToMany dengan @ManyToOne) dipotong dengan null atau array kosong di tempat ia berpusing kembali.

Kes penggunaan

Contoh Spring REST Docs dan Swagger

Jana JSON untuk @Schema(example = ...) atau snippet dokumentasi terus daripada entity, dan tampal semula setiap kali medan berubah supaya dokumentasi kekal selari.

Mengaudit entity yang didedahkan

Jika anda memulangkan entity tanpa DTO, semak sama ada medan seperti kata laluan atau nombor kad pengenalan masuk ke dalam respons. Medan dalam output ialah medan yang akan diserialkan oleh Jackson.

Body request MockMvc

Gunakan output sebagai rangka untuk mockMvc.perform(post("/appointments").content(...)), buang id dan timestamp yang dijana sebelum mengisi nilai.

Nota dan had

  • Jackson sebenar akan berulang tanpa henti (StackOverflowError) pada association dua hala. Jika output kelihatan terpotong, itu petanda untuk menggunakan @JsonManagedReference/@JsonBackReference, @JsonIgnore atau DTO.
  • Anotasi JPA @Transient tidak diabaikan oleh Jackson secara lalai, jadi medan sedemikian kekal dalam output; hanya medan dengan kata kunci Java transient yang dibuang.
  • Association FetchType.LAZY boleh gagal diserialkan sebagai proxy Hibernate dalam praktik; output menganggap semuanya telah dimuatkan.
  • Medan yang kelasnya tiada dalam input dipaparkan sebagai null, dan kekangan @Column seperti nullable atau length tidak diterapkan.

Soalan lazim

Betulkah tarikh sepatutnya rentetan dan bukan array seperti [2024,1,1]?

Spring Boot mematikan WRITE_DATES_AS_TIMESTAMPS, jadi LocalDateTime ditulis sebagai rentetan ISO. ObjectMapper yang dibina sendiri dengan hanya JavaTimeModule didaftarkan mungkin menulis array sebaliknya.

Adakah semua medan muncul walaupun tanpa @Getter Lombok?

Alat ini berfungsi berdasarkan pengisytiharan medan. Jackson sebenar menserialkan melalui getter (atau medan public) secara lalai, jadi medan private tanpa getter mungkin tiada dalam respons sebenar.

Bolehkah saya tampal kelas @Document MongoDB juga?

Ia mengikut peraturan Jackson yang sama, tetapi perkara khusus MongoDB seperti ObjectId dan @Field diterangkan di halaman Spring Data MongoDB ke JSON.