I-convert ang JSON sa Java class!

Maglagay ng JSON para gumawa ng Java class code, kasama ang mga nested object! Sinusuportahan ang Jackson @JsonProperty, Lombok. Nasa mga tab sa itaas ang Spring Boot JPA @Entity · MongoDB @Document.
JSON
Resulta
 

I-convert ang JSON sa Java class!

I-paste ang isang JSON sample at makakakuha ka ng mga Java class o record na kayang i-deserialize agad ng Jackson. Nagiging karagdagang class sa parehong file ang mga nested object, at nagiging List<T> ang mga array.

Gamitin ito para sa mga DTO na kung hindi ay mano-mano mong ita-type sa Spring Boot: mga response type para sa RestTemplate, WebClient o Feign client, o mga request body para sa mga third-party API. Sa Java 16+, puwede kang maglabas ng mga record, at kung gumagamit na ng Lombok ang codebase mo, napapanatili ng Lombok option ang parehong istilo sa output.

Paano gamitin

  1. I-paste sa input box ang JSON ng API response.
  2. Ilagay sa Pangalan ng type ang pangalan ng DTO. Ang unang class lang ang public, kaya itugma ito sa file name.
  3. Piliin ang class (may getter/setter) o record sa ilalim ng Estilo.
  4. Kapag class, i-tick ang Lombok para palitan ng @Data, @NoArgsConstructor at @AllArgsConstructor ang mga getter/setter.
  5. I-paste ang resulta sa isang .java file at idagdag ang package declaration mo.

Halimbawa

Input (JSON)
{
  "id": 1296269,
  "full_name": "octocat/Hello-World",
  "private": false,
  "stargazers_count": 80,
  "owner": { "login": "octocat", "site_admin": false },
  "topics": ["api", "demo"]
}
Output (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;
    }
}

Naka-map sa field na fullName ang mga snake_case na key gaya ng full_name gamit ang @JsonProperty. Java keyword ang private, kaya naging private_ ang field habang getPrivate()/setPrivate() pa rin ang mga accessor nito, at inihiwalay ang owner object bilang Owner class sa parehong file.

Mga sinusuportahang feature

  • Dalawang istilo ng output: regular na class na may getter/setter, o immutable na record.
  • Lombok option (sa class style lang): nagdadagdag ng @Data, @NoArgsConstructor, @AllArgsConstructor kasama ang mga import at tinatanggal ang accessor code.
  • Idinadagdag lang ang @JsonProperty kung saan iba ang field name sa JSON key, kasama ang import nito.
  • Wrapper type (Integer, Long, Double, Boolean) ang gamit ng bawat field, kaya kasya ang JSON null nang walang dagdag na trabaho.
  • Nagiging Long ang mga integer na lampas sa 32-bit range; nagiging Object ang mga value na halo ang type.
  • Nilalagyan ng _ sa dulo ang mga keyword key gaya ng class o default; nilalagyan ng prefix na n ang mga key na nagsisimula sa digit.
  • Walang type alias ang Java, kaya kapag array ang top level, may comment na // Root: List<RootItem> kasama ang element class.

Mga gamit

Mga DTO para sa third-party API sa Spring Boot

I-paste ang sample response mula sa docs ng isang payment, maps o messaging API at ipasa ang na-generate na class sa restTemplate.getForObject(url, PaymentResponse.class). Habang lumalalim ang nesting, mas maraming field ang hindi mo makakaligtaan kumpara sa mano-manong pagsulat.

Mga read-only na response model bilang record

Para sa mga response na binabasa mo lang, mas maikli ang record at walang setter; nagde-deserialize ang Jackson 2.12+ gamit ang canonical constructor ng record.

Pagbawi ng model mula sa mga test fixture

Sa isang legacy project na fixture JSON file lang ang meron, ipasok ang isang fixture para makita ang ayos ng mga field at makakuha ng unang draft ng DTO.

Mga paalala at limitasyon

  • Dumarating lang bilang null sa wrapper type ang field na wala sa ilang item; walang nagmamarka dito bilang optional. Ikaw na ang magdagdag ng @NotNull o katulad kung vina-validate mo ang mga required na value.
  • Sa default na settings, nagta-throw ang Jackson kapag may hindi kilalang key. Kung puwedeng magdagdag ng field ang API, isaalang-alang ang @JsonIgnoreProperties(ignoreUnknown = true) o ang pag-disable ng FAIL_ON_UNKNOWN_PROPERTIES.
  • Lumalabas na String ang mga date string. Kailangan ng jackson-datatype-jsr310 module para i-map sila sa LocalDateTime o OffsetDateTime.
  • Kapag record ang pinili, nawawala ang Lombok checkbox, dahil hindi ito kailangan ng mga record.
  • Package-private na class sa parehong file ang mga nested class, hindi public. Ihiwalay sila sa sariling file kung kailangan sila ng ibang package.

Mga madalas itanong

Bakit getXxx at hindi isXxx ang getter ng boolean field?

Ang field type ay ang wrapper na Boolean, hindi primitive na boolean. Matagal nang kinikilala ng Jackson ang mga isXxx accessor para lang sa primitive na boolean, kaya getXxx ang ginagamit para pareho ang pag-bind ng property sa anumang bersyon ng Jackson.

Napapanatili ba ng record output ang @JsonProperty?

Oo, isinusulat ang mga component na pinalitan ng pangalan bilang @JsonProperty("full_name") String fullName. Pinupunan sila ng Jackson 2.12 o mas bago gamit ang canonical constructor.

Kung i-set ko ang spring.jackson.property-naming-strategy=SNAKE_CASE, puwede ko bang burahin ang mga annotation?

Sa global na SNAKE_CASE strategy, nagma-map ang full_name ↔ fullName nang walang annotation. Hindi sakop ng strategy ang mga pangalang binago dahil sa keyword, gaya ng private_, kaya panatilihin ang mga annotation na iyon.

Magagamit ko ba ang output kasama ang Gson?

Hindi pinapansin ng Gson ang @JsonProperty. Palitan ito ng @SerializedName sa class output at gagana ang parehong istruktura sa Gson; suportado ang mga record mula Gson 2.10.