JSON کو Spring Boot JPA منصوبے میں تبدیل کریں!

JSON درج کریں اور اسے Spring Boot JPA منصوبے میں تبدیل کریں! Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok سپورٹ۔
JSON
نتیجہ
 

JSON کو Spring Boot JPA منصوبے میں تبدیل کریں!

JSON کو Spring Boot 3 پر Spring Data JPA کے لیے @Entity کلاس میں بدلتا ہے۔ ایک Java فائل میں jakarta.persistence اور jakarta.validation imports، @Id primary key، ہر key کے لیے ایک private فیلڈ، Lombok کے @Getter، @Setter اور @FieldNameConstants، اور Bean Validation کے @NotEmpty/@NotNull شامل ہوتے ہیں۔

یہ Spring Boot بیک اینڈ کے اس کام کے لیے ہے جہاں آپ کو کسی integration partner یا screen spec کے نمونہ JSON سے شروع کر کے جلدی سے table سے map ہونے والی entity چاہیے۔

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

  1. ایک record آبجیکٹ کی صورت میں یا کئی array کی صورت میں پیسٹ کریں۔ جو فیلڈز کسی بھی record میں غائب ہوں انہیں کوئی validation annotation نہیں ملتی۔
  2. ماڈل کا نام میں entity کلاس کا نام لکھیں (ڈیفالٹ MyModel)۔ اس کی چھوٹے حروف والی شکل package کے آخر میں بھی استعمال ہوتی ہے (com.hello.world.reservation)۔
  3. package لائن کو اپنے پروجیکٹ کے package میں بدلیں، Reservation.java کے طور پر محفوظ کریں، اور JpaRepository<Reservation, Long> کو extend کرنے والی repository بنائیں۔

مثال

ان پٹ (JSON)
{
  "guest_name": "Hana Lee",
  "room_no": 1204,
  "nights": 3,
  "rate": 149.5,
  "breakfast": true,
  "check_in": "2024-08-09T15:00:00"
}
آؤٹ پٹ (Spring Data JPA)
package com.hello.world.reservation;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;

import java.time.LocalDateTime;

import lombok.Getter;
import lombok.Setter;
import lombok.experimental.FieldNameConstants;

@Entity
@FieldNameConstants
@Getter
@Setter
public class Reservation {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @NotEmpty()
    @Column(name = "guest_name")
    private String guestName;

    @NotNull()
    @Column(name = "room_no")
    private Long roomNo;

    @NotNull()
    private Long nights;

    @NotNull()
    private Double rate;

    @NotNull()
    private Boolean breakfast;

    @NotNull()
    @Column(name = "check_in")
    private LocalDateTime checkIn;
}

room_no اور nights جیسے integers بنے Long، rate بنا Double، اور check_in بنا LocalDateTime۔ ہر snake_case key کو @Column(name = "...") ملتا ہے، اور چونکہ ہر value بھری ہوئی ہے، String فیلڈ guestName کو @NotEmpty() اور باقی کو @NotNull() ملتا ہے۔

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

  • Java types: integers → Long، decimals → Double، booleans → Boolean، YYYY-MM-DD → LocalDate، date-times → LocalDateTime، باقی strings (صرف ہندسوں والی سمیت) → String۔
  • objects بنتے ہیں Map<String, Object> اور arrays بنتی ہیں List<...>، دونوں پر @JdbcTypeCode(SqlTypes.JSON) لگتا ہے تاکہ Hibernate 6 انہیں JSON کالم میں محفوظ کرے۔
  • جب بھی Java فیلڈ نام مختلف ہو، @Column(name = "guest_name") اصل key کو کالم نام کے طور پر رکھتا ہے؛ جو keys Java keywords ہیں، جیسے class، وہ class_ بنتی ہیں۔
  • primary key آپ کے JSON کے مطابق ہوتی ہے: id نہ ہو یا integer id ہو تو @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id، string id ہو تو سادہ @Id private String id۔
  • ہمیشہ موجود فیلڈز کو غیر خالی strings ہونے پر @NotEmpty() اور باقی صورتوں میں @NotNull() ملتا ہے، کیونکہ @NotEmpty صرف strings اور collections پر لاگو ہوتا ہے۔
  • Lombok کا @FieldNameConstants، Reservation.Fields.guestName جیسے نام والے constants بناتا ہے۔

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

بیرونی API ڈیٹا محفوظ کرنے والی batch jobs

جب کسی دوسرے سسٹم سے reservations یا orders وقفے وقفے سے کھینچ کر محفوظ کرنے ہوں تو ایک response JSON سے entity مل جاتی ہے، اور saveAll() کے گرد batch job کا ڈھانچہ جلدی بن جاتا ہے۔

`ddl-auto` کے ذریعے development tables

local پر spring.jpa.hibernate.ddl-auto=update فعال ہونے سے Hibernate بنائی گئی entity سے table بنا دیتا ہے، اس لیے آپ UI کام کے لیے فوراً ڈیٹا لوڈ کر سکتے ہیں۔

نوٹس اور حدود

  • imports، Jakarta EE (Spring Boot 3، Hibernate 6) کو نشانہ بناتے ہیں۔ Spring Boot 2 پر jakarta. کو واپس javax. کریں اور @JdbcTypeCode کو converter سے بدلیں، کیونکہ Hibernate 5 میں یہ موجود نہیں۔
  • JSON میں 149.0، 149 والا ہی نمبر parse ہوتا ہے، اس لیے یہ Long بنتا ہے۔ decimal فیلڈ کو Double کی صورت میں لانے کے لیے نمونے میں کسر والی value چاہیے، اور رقم کے لیے BigDecimal بہتر ہے۔
  • 2024-08-09T15:00:00+09:00 جیسے offset والے timestamps، LocalDateTime میں اپنا offset کھو دیتے ہیں۔ جب لمحہ اہم ہو تو OffsetDateTime یا Instant استعمال کریں۔
  • JSON کالمز کے لیے ایسا ڈیٹا بیس چاہیے جس میں یہ ہوں (MySQL 5.7+، PostgreSQL، H2 2.x)۔ اصل relations کے لیے Map کو @Embedded کلاس یا @OneToMany association سے بدلیں۔

عام سوالات

جن فیلڈز کو Spring ویسے بھی snake_case سے map کر دیتا، ان پر @Column(name = ...) کیوں؟

Spring Boot کی ڈیفالٹ naming strategy اتفاق سے guestName کو guest_name بنا دیتی ہے، لیکن جیسے ہی کوئی key سادہ snake_case نہ ہو یا strategy بدلی جائے، یہ ٹوٹ جاتا ہے۔ واضح نام configuration سے قطع نظر mapping درست رکھتا ہے۔

کیا محفوظ کرتے وقت @NotNull لاگو ہوتا ہے؟

classpath پر spring-boot-starter-validation (Hibernate Validator) ہو تو Hibernate، persist اور update سے بالکل پہلے Bean Validation چلاتا ہے اور ConstraintViolationException throw کرتا ہے۔ اس کے بغیر annotations نظر انداز ہوتی ہیں۔

@FieldNameConstants کس کام کا ہے؟

Lombok، Reservation.Fields.checkIn جیسے string constants بناتا ہے۔ انہیں string literals کے بجائے Sort.by(Reservation.Fields.checkIn) یا Specification/Criteria queries میں استعمال کریں، تاکہ کسی فیلڈ کا نام بدلنے پر query کے بجائے build ٹوٹے۔