JSON کو Java class میں تبدیل کریں!

JSON درج کریں اور nested objects سمیت Java class کوڈ بنائیں! Jackson @JsonProperty, Lombok سپورٹ۔ Spring Boot JPA @Entity · MongoDB @Document اوپر والے ٹیبز میں۔
JSON
نتیجہ
 

JSON کو Java class میں تبدیل کریں!

JSON نمونہ پیسٹ کریں اور ایسی Java کلاسز یا records حاصل کریں جنہیں Jackson فوراً deserialize کر سکے۔ nested objects اسی فائل میں اضافی کلاسز بن جاتے ہیں، اور arrays بنتی ہیں List<T>۔

اسے ان DTOs کے لیے استعمال کریں جو آپ ورنہ Spring Boot میں ہاتھ سے ٹائپ کرتے: RestTemplate، WebClient یا Feign clients کی response types، یا third-party APIs کے لیے request bodies۔ Java 16+ پر آپ records بنا سکتے ہیں، اور اگر آپ کا codebase پہلے سے Lombok استعمال کرتا ہے تو Lombok option آؤٹ پٹ کو اسی انداز میں رکھتا ہے۔

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

  1. API response کا JSON ان پٹ باکس میں پیسٹ کریں۔
  2. ٹائپ کا نام میں DTO کا نام لکھیں۔ صرف پہلی کلاس public ہوتی ہے، اس لیے اسے فائل کے نام سے ملائیں۔
  3. اسٹائل کے نیچے class (getters/setters کے ساتھ) یا record چنیں۔
  4. class کے ساتھ getters/setters کی جگہ @Data، @NoArgsConstructor اور @AllArgsConstructor لانے کے لیے Lombok پر نشان لگائیں۔
  5. نتیجہ .java فائل میں پیسٹ کریں اور اپنی package declaration شامل کریں۔

مثال

ان پٹ (JSON)
{
  "id": 1296269,
  "full_name": "octocat/Hello-World",
  "private": false,
  "stargazers_count": 80,
  "owner": { "login": "octocat", "site_admin": false },
  "topics": ["api", "demo"]
}
آؤٹ پٹ (Java · class)
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.List;

public class Repository {
    private Integer id;
    @JsonProperty("full_name") private String fullName;
    @JsonProperty("private") private Boolean private_;
    @JsonProperty("stargazers_count") private Integer stargazersCount;
    private Owner owner;
    private List<String> topics;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getFullName() {
        return fullName;
    }

    public void setFullName(String fullName) {
        this.fullName = fullName;
    }

    public Boolean getPrivate() {
        return private_;
    }

    public void setPrivate(Boolean private_) {
        this.private_ = private_;
    }

    public Integer getStargazersCount() {
        return stargazersCount;
    }

    public void setStargazersCount(Integer stargazersCount) {
        this.stargazersCount = stargazersCount;
    }

    public Owner getOwner() {
        return owner;
    }

    public void setOwner(Owner owner) {
        this.owner = owner;
    }

    public List<String> getTopics() {
        return topics;
    }

    public void setTopics(List<String> topics) {
        this.topics = topics;
    }
}

class Owner {
    private String login;
    @JsonProperty("site_admin") private Boolean siteAdmin;

    public String getLogin() {
        return login;
    }

    public void setLogin(String login) {
        this.login = login;
    }

    public Boolean getSiteAdmin() {
        return siteAdmin;
    }

    public void setSiteAdmin(Boolean siteAdmin) {
        this.siteAdmin = siteAdmin;
    }
}

full_name جیسی snake_case keys، @JsonProperty کے ذریعے fullName فیلڈ سے map ہوتی ہیں۔ private ایک Java keyword ہے، اس لیے فیلڈ کا نام private_ ہو گیا جبکہ اس کے accessors getPrivate()/setPrivate() ہی رہے، اور owner آبجیکٹ کو اسی فائل میں الگ Owner کلاس میں نکال دیا گیا۔

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

  • آؤٹ پٹ کے دو انداز: getters/setters والی عام class، یا ناقابلِ تبدیل record۔
  • Lombok option (صرف class انداز میں): imports کے ساتھ @Data، @NoArgsConstructor، @AllArgsConstructor شامل کرتا ہے اور accessor کوڈ ہٹا دیتا ہے۔
  • @JsonProperty صرف وہاں لگتا ہے جہاں فیلڈ نام JSON key سے مختلف ہو، اپنے import کے ساتھ۔
  • ہر فیلڈ wrapper type (Integer، Long، Double، Boolean) استعمال کرتا ہے، اس لیے JSON کا null بغیر اضافی کام کے سما جاتا ہے۔
  • 32-bit حد سے بڑے integers بنتے ہیں Long؛ ملی جلی types والی values بنتی ہیں Object۔
  • class یا default جیسی keyword keys کے آخر میں _ لگتا ہے؛ ہندسے سے شروع ہونے والی keys کے آگے n prefix لگتا ہے۔
  • Java میں type aliases نہیں ہوتے، اس لیے سب سے اوپر کی array سے // Root: List<RootItem> comment اور element کلاس بنتی ہے۔

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

Spring Boot میں third-party APIs کے لیے DTOs

ادائیگی، نقشے یا messaging API کی docs کا نمونہ response پیسٹ کریں اور بنائی گئی کلاس restTemplate.getForObject(url, PaymentResponse.class) کو دیں۔ nesting جتنی گہری ہو، ہاتھ سے لکھنے کے مقابلے میں اتنے ہی زیادہ فیلڈز چھوٹنے سے بچتے ہیں۔

records کی صورت میں صرف پڑھنے والے response ماڈلز

جن responses کو آپ صرف پڑھتے ہیں ان کے لیے record چھوٹا ہوتا ہے اور اس میں setters نہیں ہوتے؛ Jackson 2.12+ اسے record کے canonical constructor کے ذریعے deserialize کرتا ہے۔

test fixtures سے ماڈل بحال کرنا

کسی legacy پروجیکٹ میں جہاں صرف fixture JSON فائلیں موجود ہوں، ایک fixture دے کر فیلڈز کی ترتیب دیکھیں اور DTO کا پہلا ڈرافٹ حاصل کریں۔

نوٹس اور حدود

  • کچھ items میں غائب فیلڈ بس wrapper type میں null کی صورت میں آتا ہے؛ کوئی چیز اسے اختیاری نشان زد نہیں کرتی۔ اگر آپ لازمی values validate کرتے ہیں تو @NotNull وغیرہ خود لگائیں۔
  • ڈیفالٹ settings کے ساتھ Jackson نامعلوم keys پر exception دیتا ہے۔ اگر API فیلڈز شامل کر سکتی ہے تو @JsonIgnoreProperties(ignoreUnknown = true) یا FAIL_ON_UNKNOWN_PROPERTIES بند کرنے پر غور کریں۔
  • تاریخ والی strings، String کی صورت میں آتی ہیں۔ انہیں LocalDateTime یا OffsetDateTime سے map کرنے کے لیے jackson-datatype-jsr310 module چاہیے۔
  • record چننے پر Lombok checkbox چھپ جاتا ہے، کیونکہ records کو اس کی ضرورت نہیں۔
  • nested کلاسز اسی فائل میں package-private کلاسز ہیں، public نہیں۔ اگر دوسرے packages کو ان کی ضرورت ہو تو انہیں الگ فائلوں میں تقسیم کریں۔

عام سوالات

boolean فیلڈ کا getter isXxx کے بجائے getXxx کیوں ہے؟

فیلڈ کی type primitive boolean نہیں بلکہ Boolean wrapper ہے۔ Jackson طویل عرصے سے isXxx accessors کو صرف primitive boolean کے لیے پہچانتا ہے، اس لیے getXxx استعمال ہوتا ہے تاکہ property ہر Jackson ورژن پر ایک ہی طرح bind ہو۔

کیا record آؤٹ پٹ @JsonProperty برقرار رکھتا ہے؟

جی ہاں، نام بدلے گئے components، @JsonProperty("full_name") String fullName کی صورت میں لکھے جاتے ہیں۔ Jackson 2.12 یا بعد کا ورژن انہیں canonical constructor کے ذریعے بھرتا ہے۔

اگر میں spring.jackson.property-naming-strategy=SNAKE_CASE سیٹ کروں تو کیا annotations مٹا سکتا ہوں؟

global SNAKE_CASE strategy کے ساتھ full_name ↔ fullName بغیر annotations کے map ہو جاتا ہے۔ keywords کی وجہ سے بدلے گئے نام، جیسے private_، strategy کے دائرے میں نہیں آتے، اس لیے وہ annotations رہنے دیں۔

کیا میں آؤٹ پٹ Gson کے ساتھ استعمال کر سکتا ہوں؟

Gson، @JsonProperty کو نظر انداز کرتا ہے۔ class آؤٹ پٹ میں اسے @SerializedName سے بدلیں تو وہی ڈھانچہ Gson کے ساتھ کام کرتا ہے؛ records، Gson 2.10 سے سپورٹ ہیں۔