JSON को Java class में बदलें!

JSON डालें और nested object समेत Java class कोड बनाएं! Jackson @JsonProperty, Lombok समर्थित। Spring Boot JPA @Entity · MongoDB @Document ऊपर के टैब में।
JSON
परिणाम
 

JSON को Java class में बदलें!

JSON sample पेस्ट करें और ऐसी Java classes या records पाएं जिन्हें Jackson तुरंत deserialize कर सके। Nested objects उसी फ़ाइल में अतिरिक्त classes बनते हैं, और 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 का नाम डालें। सिर्फ़ पहली class 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 field से map होती हैं। private Java keyword है, इसलिए field private_ बना जबकि उसके accessors getPrivate()/setPrivate() ही रहते हैं, और owner object उसी फ़ाइल में Owner class के रूप में अलग किया गया।

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

  • दो आउटपुट स्टाइल: getters/setters वाली सामान्य class, या immutable record।
  • Lombok option (सिर्फ़ class स्टाइल): imports के साथ @Data, @NoArgsConstructor, @AllArgsConstructor जोड़ता है और accessor कोड हटाता है।
  • @JsonProperty सिर्फ़ वहीं जुड़ता है जहां field नाम JSON key से अलग हो, उसके import के साथ।
  • हर field wrapper type (Integer, Long, Double, Boolean) इस्तेमाल करता है, इसलिए JSON null बिना अतिरिक्त काम के फ़िट हो जाता है।
  • 32-bit range से बड़े integers Long बनते हैं; मिले-जुले types की values Object बनती हैं।
  • class या default जैसी keyword keys के अंत में _ लगता है; अंक से शुरू होने वाली keys को n prefix मिलता है।
  • Java में type aliases नहीं होते, इसलिए top-level array // Root: List<RootItem> comment और element class बनाता है।

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

Spring Boot में third-party APIs के DTOs

Payment, maps या messaging API के docs से sample response पेस्ट करें और बनी हुई class को restTemplate.getForObject(url, PaymentResponse.class) में दें। Nesting जितनी गहरी हो, हाथ से लिखने की तुलना में उतने ज़्यादा fields छूटने से बचते हैं।

Records के रूप में read-only response models

जिन responses को आप सिर्फ़ पढ़ते हैं, उनके लिए record छोटा होता है और उसमें setters नहीं होते; Jackson 2.12+ record के canonical constructor से deserialize करता है।

Test fixtures से model वापस पाना

ऐसे legacy project में जहां सिर्फ़ fixture JSON फ़ाइलें बची हैं, field layout देखने और DTO का पहला draft पाने के लिए एक fixture डालें।

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

  • कुछ items में न मौजूद field wrapper type में बस null के रूप में आता है; उसे optional के रूप में चिह्नित नहीं किया जाता। अगर आप required values validate करते हैं तो @NotNull जैसा कुछ खुद जोड़ें।
  • Default settings में Jackson अज्ञात keys पर exception देता है। अगर API fields जोड़ सकता है, तो @JsonIgnoreProperties(ignoreUnknown = true) या FAIL_ON_UNKNOWN_PROPERTIES बंद करने पर विचार करें।
  • तारीख वाली strings String के रूप में आती हैं। उन्हें LocalDateTime या OffsetDateTime से map करने के लिए jackson-datatype-jsr310 module चाहिए।
  • record चुनने पर Lombok checkbox छिप जाता है, क्योंकि records को इसकी ज़रूरत नहीं।
  • Nested classes उसी फ़ाइल में package-private classes हैं, public नहीं। अगर दूसरे packages को चाहिए तो उन्हें अलग फ़ाइलों में बांटें।

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

Boolean field का getter isXxx की बजाय getXxx क्यों है?

Field type Boolean wrapper है, primitive boolean नहीं। Jackson लंबे समय से isXxx accessors को सिर्फ़ primitive boolean के लिए पहचानता है, इसलिए हर Jackson version पर property एक जैसे bind हो, इसके लिए getXxx इस्तेमाल होता है।

क्या record आउटपुट @JsonProperty रखता है?

हां, rename किए गए components @JsonProperty("full_name") String fullName के रूप में लिखे जाते हैं। Jackson 2.12 या बाद का version उन्हें 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 से समर्थित हैं।