Tukar kelas Java kepada JSON!

Tampal kod Java (class·record) dan dapatkan contoh JSON! Menyokong Jackson @JsonProperty, @JsonIgnore, Lombok. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Java
Hasil
 

Tukar kelas Java kepada JSON!

Masukkan kod sumber DTO, POJO atau record Java dan dapatkan JSON yang paling mungkin dihasilkan oleh tetapan lalai Jackson dalam Spring Boot. Kunci diambil daripada field yang diisytiharkan, dengan @JsonProperty, @JsonIgnore, @JsonIgnoreProperties serta pengecualian static/transient diambil kira.

Gunakannya untuk menghasilkan contoh Swagger atau payload sampel untuk frontend daripada DTO request atau response controller, atau sekadar untuk menyemak kunci yang akan dikeluarkan oleh kelas Lombok @Data.

Cara menggunakan

  1. Tampal kod sumber DTO sebagaimana adanya. Import, anotasi Lombok, constructor dan method boleh dibiarkan.
  2. Sertakan deklarasi static class, record dan enum bersarang dalam input yang sama supaya field yang merujuknya diisi dengan strukturnya.
  3. Apabila Jenis akar ditetapkan kepada Automatik, kelas yang tidak digunakan oleh kelas lain sebagai jenis field akan dipilih. Apabila entiti saling merujuk, pilih yang anda mahu daripada senarai.
  4. Salin output ke dalam @Schema(example = ...), snippet REST Docs atau body request MockMvc.

Contoh

Input (Java)
@Data
@JsonIgnoreProperties({"password"})
public class MemberResponse {
    private Long memberId;
    @JsonProperty("nick_name")
    private String nickname;
    private String password;
    private Grade grade = Grade.SILVER;
    private LocalDate birthDate;
    private List<Address> addresses;
    private static final long serialVersionUID = 1L;

    public enum Grade { BRONZE, SILVER, GOLD }

    public record Address(String zipCode, String city, boolean primary) {}
}
Output (JSON)
{
  "memberId": 0,
  "nick_name": "",
  "grade": "SILVER",
  "birthDate": "1970-01-01",
  "addresses": [
    {
      "zipCode": "",
      "city": "",
      "primary": false
    }
  ]
}

password dibuang oleh @JsonIgnoreProperties({"password"}) di peringkat kelas, dan serialVersionUID yang static final tidak pernah muncul. Initializer Grade.SILVER dibaca, jadi grade ialah "SILVER", bukan pemalar pertama enum. record Address yang bersarang dikembangkan menjadi array objek.

Ciri yang disokong

  • Nama field menjadi kunci, dan boleh diganti dengan @JsonProperty("x") atau @JsonProperty(value = "x").
  • Dikecualikan: field @JsonIgnore, kunci yang disenaraikan dalam @JsonIgnoreProperties({...}) di peringkat kelas, dan field static atau transient.
  • Menyokong komponen record Java 16+, deklarasi static class bersarang dan field yang diwarisi melalui extends (field induk didahulukan).
  • Field enum memegang pemalar pertama sebagai string, atau pemalar yang dinamakan dalam initializer field; @JsonProperty("x") pada sesuatu pemalar menukar string itu kepada x.
  • Tarikh mengikut output lalai Jackson dalam Spring Boot: LocalDateTime → 1970-01-01T00:00:00, LocalDate → 1970-01-01, Instant/OffsetDateTime/ZonedDateTime → string ISO yang berakhir dengan Z, java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00.
  • Wrapper nombor seperti BigDecimal dan Long menjadi 0, Optional<T> dibuka menjadi T, byte[] menjadi string Base64, dan UUID serta ObjectId MongoDB mendapat nilai yang berformat betul.
  • List, Set dan array mendapat satu elemen sampel; map seperti Map<Long, V> dengan kunci nombor menggunakan "0", selainnya "key".

Kes penggunaan

Mengisi contoh springdoc / Swagger

Nilai example yang ditulis tangan akan ketinggalan setiap kali field ditambah pada DTO. Jana JSON daripada kod sumber DTO dan kemaskan nilainya dari situ, supaya tiada kunci yang tertinggal atau salah eja.

Body request untuk ujian MockMvc atau RestAssured

Cipta JSON request terus daripada DTO @RequestBody dan tampalkannya ke dalam text block (""") dalam ujian anda. Kunci yang dinamakan semula dengan @JsonProperty sudah pun diambil kira, sepadan dengan binding sebenar.

Berkongsi bentuk response dengan frontend

Developer frontend yang tidak membaca kod backend boleh terus mendapat struktur JSON endpoint, tanpa perlu mentafsir kelas Java.

Nota dan had

  • Initializer field digunakan apabila ia berupa literal (= "guest", = 100, = true) atau pemalar enum (= Grade.SILVER); selain itu, seperti new ArrayList<>() atau panggilan method, akan kembali kepada nilai placeholder jenis tersebut.
  • Getter tanpa field yang sepadan, seperti getFullName() atau boolean isVip(), ditambah sebagai property seperti yang dilakukan Jackson, dengan mengambil kira @JsonIgnore/@JsonProperty pada getter itu. Sebaliknya, field private tanpa getter dianggap kelihatan (seperti dengan Lombok @Getter/@Data).
  • Peraturan penamaan global (@JsonNaming(SnakeCaseStrategy.class), spring.jackson.property-naming-strategy) dan corak tarikh @JsonFormat tidak digunakan.
  • Method @JsonValue pada enum tidak dinilai, jadi enum sebegitu tetap memaparkan pemalarnya (atau nama @JsonProperty-nya).
  • Field Page<T>/Slice<T> Spring Data dipermudahkan menjadi array elemen; serialization Page yang sebenar ialah objek dengan content, pageable dan lain-lain.

Soalan lazim

Adakah ia berfungsi apabila Lombok @Data atau @Getter menjana accessor?

Ya. Kunci dibina daripada field yang diisytiharkan, jadi getter dan setter yang dijana Lombok semasa compile tidak perlu ada dalam kod sumber.

Kenapa LocalDateTime ialah string dan bukan array nombor?

Spring Boot mendaftarkan jackson-datatype-jsr310 dan mematikan WRITE_DATES_AS_TIMESTAMPS secara lalai, yang menghasilkan string ISO; sampel mengikut tetapan lalai tersebut. ObjectMapper Jackson biasa pula mungkin menulis array seperti [1970,1,1,0,0].

Bolehkah saya menampal entiti JPA?

Entiti mempunyai struktur field yang sama, jadi ia boleh di-parse dengan baik. Hubungan dua hala seperti @OneToMany akan berulang tanpa henti, jadi ia dikembangkan sekali lalu dipotong dengan null atau array kosong. Terdapat juga halaman khas Spring Boot JPA → JSON.

Bagaimana jika @JsonIgnore diletakkan pada setter atau pada getter bagi field yang wujud?

Anotasi pada deklarasi field sentiasa digunakan, manakala anotasi pada getter hanya digunakan apabila tiada field dengan nama itu. @JsonIgnore pada setter, atau pada getter bagi field yang diisytiharkan, tidak digunakan, jadi pindahkannya ke field untuk melihat kesannya.