Tukar JSON kepada class Java!

Masukkan JSON untuk menjana kod class Java, termasuk objek bersarang! Menyokong Jackson @JsonProperty, Lombok. Spring Boot JPA @Entity · MongoDB @Document ada dalam tab di atas.
JSON
Hasil
 

Tukar JSON kepada class Java!

Tampal sampel JSON dan dapatkan kelas Java atau record yang boleh terus di-deserialize oleh Jackson. Objek bersarang menjadi kelas tambahan dalam fail yang sama, dan array menjadi List<T>.

Gunakannya untuk DTO yang selalunya anda taip sendiri dalam Spring Boot: jenis response bagi klien RestTemplate, WebClient atau Feign, atau body request untuk API pihak ketiga. Pada Java 16+ anda boleh menjana record, dan jika codebase anda sudah menggunakan Lombok, pilihan Lombok mengekalkan output dalam gaya yang sama.

Cara menggunakan

  1. Tampal JSON response API ke dalam kotak input.
  2. Masukkan nama DTO dalam Nama jenis. Hanya kelas pertama yang public, jadi padankan dengan nama fail.
  3. Pilih class (dengan getter/setter) atau record di bawah Gaya.
  4. Dengan class, tandakan Lombok untuk menggantikan getter/setter dengan @Data, @NoArgsConstructor dan @AllArgsConstructor.
  5. Tampal hasil ke dalam fail .java dan tambah deklarasi package anda.

Contoh

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;
    }
}

Kunci snake_case seperti full_name dipetakan kepada field fullName melalui @JsonProperty. private ialah kata kunci Java, jadi field itu menjadi private_ manakala accessor-nya kekal getPrivate()/setPrivate(), dan objek owner dipisahkan menjadi kelas Owner dalam fail yang sama.

Ciri yang disokong

  • Dua gaya output: class biasa dengan getter/setter, atau record yang immutable.
  • Pilihan Lombok (gaya class sahaja): menambah @Data, @NoArgsConstructor, @AllArgsConstructor berserta import dan membuang kod accessor.
  • @JsonProperty hanya ditambah apabila nama field berbeza daripada kunci JSON, bersama import-nya.
  • Setiap field menggunakan jenis wrapper (Integer, Long, Double, Boolean), jadi null JSON boleh diterima tanpa kerja tambahan.
  • Integer di luar julat 32-bit menjadi Long; nilai berjenis campuran menjadi Object.
  • Kunci yang merupakan kata kunci seperti class atau default diberi _ di hujungnya; kunci yang bermula dengan digit diberi awalan n.
  • Java tiada type alias, jadi array peringkat atas menghasilkan komen // Root: List<RootItem> serta kelas elemennya.

Kes penggunaan

DTO untuk API pihak ketiga dalam Spring Boot

Tampal sampel response daripada dokumentasi API pembayaran, peta atau pemesejan dan hantar kelas yang dijana kepada restTemplate.getForObject(url, PaymentResponse.class). Semakin dalam struktur bersarangnya, semakin banyak field yang tidak terlepas berbanding menulisnya sendiri.

Model response baca sahaja sebagai record

Untuk response yang hanya dibaca, record lebih ringkas dan tiada setter; Jackson 2.12+ men-deserialize melalui canonical constructor record tersebut.

Memulihkan model daripada test fixture

Dalam projek legacy yang hanya mempunyai fail JSON fixture, masukkan satu fixture untuk melihat susunan field dan mendapatkan draf pertama DTO.

Nota dan had

  • Field yang tiada dalam sesetengah item hanya akan tiba sebagai null dalam jenis wrapper; tiada apa-apa yang menandakannya sebagai opsyenal. Tambah @NotNull atau yang seumpamanya sendiri jika anda mengesahkan nilai wajib.
  • Dengan tetapan lalai, Jackson akan membaling ralat pada kunci yang tidak dikenali. Jika API mungkin menambah field, pertimbangkan @JsonIgnoreProperties(ignoreUnknown = true) atau mematikan FAIL_ON_UNKNOWN_PROPERTIES.
  • String tarikh dikeluarkan sebagai String. Memetakannya kepada LocalDateTime atau OffsetDateTime memerlukan modul jackson-datatype-jsr310.
  • Memilih record akan menyembunyikan checkbox Lombok, kerana record tidak memerlukannya.
  • Kelas bersarang ialah kelas package-private dalam fail yang sama, bukan public. Pecahkan ke fail berasingan jika package lain memerlukannya.

Soalan lazim

Kenapa getter untuk field boolean ialah getXxx dan bukan isXxx?

Jenis field ialah wrapper Boolean, bukan boolean primitif. Sejak dahulu Jackson hanya mengenali accessor isXxx untuk boolean primitif, jadi getXxx digunakan supaya property bind dengan cara yang sama pada mana-mana versi Jackson.

Adakah output record mengekalkan @JsonProperty?

Ya, komponen yang dinamakan semula ditulis sebagai @JsonProperty("full_name") String fullName. Jackson 2.12 atau lebih baharu mengisinya melalui canonical constructor.

Jika saya menetapkan spring.jackson.property-naming-strategy=SNAKE_CASE, bolehkah saya membuang anotasi?

Dengan strategi SNAKE_CASE global, full_name ↔ fullName dipetakan tanpa anotasi. Nama yang diubah kerana kata kunci, seperti private_, tidak diliputi oleh strategi itu, jadi kekalkan anotasi tersebut.

Bolehkah saya menggunakan output dengan Gson?

Gson mengabaikan @JsonProperty. Gantikannya dengan @SerializedName dalam output class dan struktur yang sama akan berfungsi dengan Gson; record disokong mulai Gson 2.10.