JPA اینٹٹیز کو JSON میں تبدیل کریں!

JPA اینٹٹیز درج کریں اور مثالی JSON بنائیں! JPA @Entity, Hibernate, Spring Boot سپورٹ۔ API دستاویزات اور ٹیسٹ request body (sample JSON) کے لیے مفید۔
JPA
نتیجہ
 

JPA اینٹٹیز کو JSON میں تبدیل کریں!

Spring Boot JPA کی @Entity کلاسز پیسٹ کریں اور اس شکل کا مثالی JSON دیکھیں جو Jackson بناتا ہے جب کوئی controller یہ entities لوٹاتا ہے۔ فیلڈ نام، @JsonIgnore اور @JsonProperty، @MappedSuperclass سے وراثت میں ملے فیلڈز، اور Java 8 کی تاریخ والی types، سب Spring Boot کے ڈیفالٹ Jackson سیٹ اپ کے مطابق سنبھالے جاتے ہیں۔

اسے REST Docs یا Swagger مثالوں، Postman request bodies کے لیے، یا یہ جانچنے کے لیے استعمال کریں کہ DTO کے بغیر entity ظاہر کرنے پر کون سے فیلڈز باہر نکل جاتے ہیں۔

استعمال کا طریقہ

  1. entity کلاسز JPA باکس میں پیسٹ کریں۔ imports اور Lombok annotations رہنے دیں؛ parent کلاسز، متعلقہ entities اور enums شامل کریں تاکہ ان کی values بھری جائیں۔
  2. جس کلاس کا کوئی اور کلاس حوالہ نہیں دیتی وہ root بنتی ہے۔ جب entities ایک دوسرے کا حوالہ دیں تو public کلاس چنی جاتی ہے۔
  3. نتیجہ اپنے ٹیسٹ یا 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 ایک دوسرے کا حوالہ دیتے ہیں، اس لیے public کلاس Appointment root ہے اور Patient.appointments لامتناہی چکر کے بجائے خالی array پر کاٹ دیا جاتا ہے۔ BaseEntity کے id اور createdAt سب سے پہلے آتے ہیں، اور @JsonIgnore کی وجہ سے residentNumber غائب ہے۔ LocalDateTime بغیر offset کی ISO string ہے، اور enum اپنا پہلا constant "BOOKED" دکھاتا ہے۔

معاون خصوصیات

  • static اور transient فیلڈز اور @JsonIgnore فیلڈز چھوڑ دیے جاتے ہیں، اور وہ نام بھی جو کلاس کی سطح کے @JsonIgnoreProperties({"..."}) میں درج ہوں۔
  • @JsonProperty("doctor_name")، JSON key کا نام بدل دیتا ہے۔
  • جب parent کلاس (@MappedSuperclass یا کوئی بھی extends) ان پٹ میں ہو تو اس کے فیلڈز پہلے آتے ہیں۔
  • private Status status = Status.ACTIVE; یا private int visits = 0; جیسا entity ڈیفالٹ اسی value کی صورت میں دکھائی دیتا ہے، اور بغیر backing فیلڈ والے computed getters (public int getAge()) اضافی keys کے طور پر آتے ہیں، بالکل جیسے Jackson انہیں لکھتا۔
  • تاریخ کا آؤٹ پٹ Spring Boot کے ڈیفالٹس پر چلتا ہے: LocalDate → 1970-01-01، LocalDateTime → 1970-01-01T00:00:00، java.util.Date → 1970-01-01T00:00:00.000+00:00۔
  • BigDecimal اور Long جیسے عددی wrappers سے 0 ملتا ہے، UUID سے تمام صفروں والا UUID، اور byte[] سے base64 string "AA=="۔
  • List/Set سے ایک عنصر والی array ملتی ہے، Map<Long, String> سے مطابقت رکھنے والی key والا آبجیکٹ ({"0": ""})، اور Optional<T> کھل کر اپنی اندرونی value بن جاتا ہے۔
  • دو طرفہ associations (@OneToMany کے ساتھ @ManyToOne) جہاں واپس پلٹیں وہاں null یا خالی array سے کاٹ دی جاتی ہیں۔

استعمال کے کیس

Spring REST Docs اور Swagger مثالیں

@Schema(example = ...) یا documentation snippets کے لیے JSON سیدھا entity سے بنائیں، اور جب بھی فیلڈز بدلیں دوبارہ پیسٹ کریں تاکہ docs ہم آہنگ رہیں۔

ظاہر کی گئی entities کی جانچ

اگر آپ DTOs کے بغیر entities لوٹاتے ہیں تو چیک کریں کہ passwords یا قومی شناختی نمبر جیسے فیلڈز responses میں تو نہیں پہنچ رہے۔ آؤٹ پٹ کے فیلڈز وہی ہیں جنہیں Jackson serialize کرے گا۔

MockMvc request bodies

آؤٹ پٹ کو mockMvc.perform(post("/appointments").content(...)) کے ڈھانچے کے طور پر استعمال کریں، values بھرنے سے پہلے بنایا گیا id اور timestamps ہٹا دیں۔

نوٹس اور حدود

  • اصل Jackson دو طرفہ associations پر لامتناہی recursion (StackOverflowError) میں چلا جاتا ہے۔ اگر آؤٹ پٹ کٹا ہوا لگے تو یہ @JsonManagedReference/@JsonBackReference، @JsonIgnore یا DTO کا اشارہ ہے۔
  • JPA کی @Transient annotation کو Jackson بطور ڈیفالٹ نظر انداز نہیں کرتا، اس لیے ایسے فیلڈز آؤٹ پٹ میں رہتے ہیں؛ صرف Java کے transient keyword والے فیلڈز ہٹائے جاتے ہیں۔
  • FetchType.LAZY associations عملی طور پر Hibernate proxies کی صورت میں serialize ہونے میں ناکام ہو سکتی ہیں؛ آؤٹ پٹ فرض کرتا ہے کہ سب کچھ لوڈ ہے۔
  • جن فیلڈز کی کلاس ان پٹ میں نہ ہو وہ null کی صورت میں آتے ہیں، اور nullable یا length جیسی @Column constraints لاگو نہیں ہوتیں۔

عام سوالات

کیا تاریخیں واقعی strings ہونی چاہئیں، [2024,1,1] جیسی arrays نہیں؟

Spring Boot، WRITE_DATES_AS_TIMESTAMPS بند کر دیتا ہے، اس لیے LocalDateTime ISO string کی صورت میں لکھا جاتا ہے۔ ہاتھ سے بنایا گیا ObjectMapper جس میں صرف JavaTimeModule رجسٹر ہو، اس کے بجائے arrays لکھ سکتا ہے۔

کیا Lombok @Getter کے بغیر بھی تمام فیلڈز دکھائی دیتے ہیں؟

ٹول فیلڈ declarations سے کام کرتا ہے۔ اصل Jackson بطور ڈیفالٹ getters (یا public فیلڈز) کے ذریعے serialize کرتا ہے، اس لیے getters کے بغیر private فیلڈز اصل responses سے غائب ہو سکتے ہیں۔

کیا میں MongoDB کی @Document کلاسز بھی پیسٹ کر سکتا ہوں؟

وہ بھی انہی Jackson قواعد پر چلتی ہیں، لیکن ObjectId اور @Field جیسی MongoDB کی مخصوص باریکیاں Spring Data MongoDB to JSON صفحے پر بیان کی گئی ہیں۔