JPA एंटिटी को JSON में बदलें!

JPA एंटिटी डालें और उदाहरण JSON बनाएँ! JPA @Entity, Hibernate, Spring Boot समर्थित। API डॉक्यूमेंटेशन और टेस्ट request body (sample JSON) के लिए उपयोगी।
JPA
परिणाम
 

JPA एंटिटी को JSON में बदलें!

Spring Boot JPA @Entity classes पेस्ट करें और उस आकार का उदाहरण JSON देखें जो Jackson तब बनाता है जब controller उन entities को लौटाता है। Field नाम, @JsonIgnore और @JsonProperty, @MappedSuperclass से inherit हुए fields, और Java 8 date types, सब Spring Boot के default Jackson setup के अनुसार संभाले जाते हैं।

इसे REST Docs या Swagger examples, Postman request bodies के लिए, या यह जांचने के लिए इस्तेमाल करें कि DTO के बिना entity expose करने पर कौन से fields बाहर चले जाते हैं।

उपयोग कैसे करें

  1. Entity classes को JPA बॉक्स में पेस्ट करें। Imports और Lombok annotations रह सकते हैं; parent classes, जुड़ी entities और enums शामिल करें ताकि उनकी values भरें।
  2. जिस class को कोई दूसरी class reference नहीं करती वह root बनती है। जब entities एक-दूसरे को reference करती हैं, तो public class चुनी जाती है।
  3. परिणाम को अपने test या documentation में कॉपी करें।

उदाहरण

इनपुट (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;
}
आउटपुट (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 और Patient एक-दूसरे को reference करते हैं, इसलिए public class Appointment root है और Patient.appointments अंतहीन loop की बजाय खाली array पर काट दिया जाता है। BaseEntity से id और createdAt पहले आते हैं, और @JsonIgnore की वजह से residentNumber गायब है। LocalDateTime बिना offset वाली ISO string है, और enum अपना पहला constant "BOOKED" दिखाता है।

समर्थित सुविधाएँ

  • static और transient fields और @JsonIgnore fields छोड़ दिए जाते हैं, साथ ही class-level @JsonIgnoreProperties({"..."}) में सूचीबद्ध नाम भी।
  • @JsonProperty("doctor_name") JSON key rename करता है।
  • जब parent class (@MappedSuperclass या कोई भी extends) इनपुट में हो, तो उसके fields पहले आते हैं।
  • private Status status = Status.ACTIVE; या private int visits = 0; जैसा entity default उसी वैल्यू के रूप में दिखता है, और बिना backing field वाले computed getters (public int getAge()) अतिरिक्त keys के रूप में आते हैं, जैसे Jackson उन्हें निकालता।
  • Date आउटपुट Spring Boot defaults का पालन करता है: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00।
  • BigDecimal और Long जैसे numeric wrappers 0 देते हैं, UUID पूरी तरह zero वाली UUID, और byte[] base64 string "AA=="।
  • List/Set एक element वाला array देते हैं, Map<Long, String> मेल खाती key वाला object ({"0": ""}) देता है, और Optional<T> खुलकर अपनी अंदर की वैल्यू बनता है।
  • Bidirectional associations (@ManyToOne के साथ @OneToMany) जहां वापस loop करते हैं वहां null या खाली array से काट दिए जाते हैं।

उपयोग के मामले

Spring REST Docs और Swagger examples

@Schema(example = ...) या documentation snippets के लिए JSON सीधे entity से बनाएं, और fields बदलने पर हर बार दोबारा पेस्ट करके docs को साथ रखें।

Expose हुई entities की जांच

अगर आप DTOs के बिना entities लौटाते हैं, तो जांचें कि पासवर्ड या राष्ट्रीय पहचान संख्या जैसे fields responses में पहुंचते हैं या नहीं। आउटपुट के fields वही हैं जिन्हें Jackson serialize करेगा।

MockMvc request bodies

आउटपुट को mockMvc.perform(post("/appointments").content(...)) के ढांचे के रूप में इस्तेमाल करें, values भरने से पहले बने हुए id और timestamps हटा दें।

नोट्स और सीमाएँ

  • असली Jackson bidirectional associations पर अंतहीन recursion (StackOverflowError) में जाता है। अगर आउटपुट कटा हुआ दिखे, तो यह @JsonManagedReference/@JsonBackReference, @JsonIgnore या DTO का संकेत है।
  • JPA का @Transient annotation Jackson default रूप से अनदेखा नहीं करता, इसलिए ऐसे fields आउटपुट में रहते हैं; सिर्फ़ Java transient keyword वाले fields हटते हैं।
  • FetchType.LAZY associations व्यवहार में Hibernate proxies के रूप में serialize होने में विफल हो सकते हैं; आउटपुट मानता है कि सब कुछ load है।
  • जिन fields की class इनपुट में नहीं है वे null के रूप में दिखते हैं, और nullable या length जैसे @Column constraints लागू नहीं होते।

अक्सर पूछे जाने वाले प्रश्न

क्या तारीखें सच में strings होनी चाहिए, [2024,1,1] जैसे arrays नहीं?

Spring Boot WRITE_DATES_AS_TIMESTAMPS बंद करता है, इसलिए LocalDateTime ISO string के रूप में लिखा जाता है। सिर्फ़ JavaTimeModule register किया हाथ से बना ObjectMapper इसकी जगह arrays लिख सकता है।

क्या Lombok @Getter के बिना भी सभी fields दिखते हैं?

टूल field declarations से काम करता है। असली Jackson default रूप से getters (या public fields) से serialize करता है, इसलिए बिना getters वाले private fields असली responses में नहीं भी हो सकते।

क्या MongoDB @Document classes भी पेस्ट कर सकते हैं?

वे Jackson के वही नियम मानती हैं, लेकिन ObjectId और @Field जैसी MongoDB की खास बातें Spring Data MongoDB to JSON पेज पर बताई गई हैं।