Tempel contoh JSON dan dapatkan class atau record Java yang langsung bisa di-deserialize oleh Jackson. Objek bersarang menjadi class tambahan di file yang sama, dan array menjadi List<T>.
Gunakan untuk DTO yang biasanya Anda ketik manual di Spring Boot: tipe respons untuk client RestTemplate, WebClient, atau Feign, maupun body request untuk API pihak ketiga. Di Java 16+ Anda bisa menghasilkan record, dan jika codebase Anda sudah memakai Lombok, opsi Lombok menjaga output tetap dengan gaya yang sama.
Nama tipe. Hanya class pertama yang public, jadi samakan dengan nama file.class (dengan getter/setter) atau record di Gaya.class, centang Lombok untuk mengganti getter/setter dengan @Data, @NoArgsConstructor dan @AllArgsConstructor..java dan tambahkan deklarasi package Anda.{
"id": 1296269,
"full_name": "octocat/Hello-World",
"private": false,
"stargazers_count": 80,
"owner": { "login": "octocat", "site_admin": false },
"topics": ["api", "demo"]
}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;
}
}
Key snake_case seperti full_name dipetakan ke field fullName lewat @JsonProperty. private adalah keyword Java, jadi field-nya menjadi private_ sementara accessor-nya tetap getPrivate()/setPrivate(), dan objek owner dipisahkan menjadi class Owner di file yang sama.
class biasa dengan getter/setter, atau record yang immutable.@Data, @NoArgsConstructor, @AllArgsConstructor beserta import-nya dan membuang kode accessor.@JsonProperty hanya ditambahkan jika nama field berbeda dari key JSON, beserta import-nya.Integer, Long, Double, Boolean), jadi null dari JSON langsung muat tanpa kerja tambahan.Long; nilai bertipe campuran menjadi Object.class atau default diberi _ di belakang; key yang diawali angka diberi prefix n.// Root: List<RootItem> beserta class elemennya.Tempel contoh respons dari dokumentasi API pembayaran, peta, atau messaging dan berikan class yang dihasilkan ke restTemplate.getForObject(url, PaymentResponse.class). Semakin dalam nesting-nya, semakin banyak field yang tidak terlewat dibandingkan menulisnya manual.
Untuk respons yang hanya Anda baca, record lebih ringkas dan tidak punya setter; Jackson 2.12+ men-deserialize-nya lewat canonical constructor record.
Di proyek lama yang hanya menyisakan file JSON fixture, masukkan sebuah fixture untuk melihat susunan field-nya dan mendapatkan draf pertama DTO.
null di tipe wrapper; tidak ada yang menandainya sebagai opsional. Tambahkan sendiri @NotNull atau sejenisnya jika Anda memvalidasi nilai wajib.@JsonIgnoreProperties(ignoreUnknown = true) atau menonaktifkan FAIL_ON_UNKNOWN_PROPERTIES.String. Memetakannya ke LocalDateTime atau OffsetDateTime memerlukan modul jackson-datatype-jsr310.record menyembunyikan checkbox Lombok, karena record tidak membutuhkannya.public. Pisahkan ke file tersendiri jika package lain membutuhkannya.getXxx dan bukan isXxx?Tipe field-nya adalah wrapper Boolean, bukan primitive boolean. Sejak lama Jackson hanya mengenali accessor isXxx untuk primitive boolean, jadi getXxx dipakai agar properti terikat dengan cara yang sama di versi Jackson mana pun.
record tetap mempertahankan @JsonProperty?Ya, komponen yang diganti namanya ditulis sebagai @JsonProperty("full_name") String fullName. Jackson 2.12 atau lebih baru mengisinya lewat canonical constructor.
spring.jackson.property-naming-strategy=SNAKE_CASE, bisakah anotasinya dihapus?Dengan strategi SNAKE_CASE global, full_name ↔ fullName terpetakan tanpa anotasi. Nama yang diubah karena keyword, seperti private_, tidak dicakup oleh strategi tersebut, jadi pertahankan anotasi itu.
Gson mengabaikan @JsonProperty. Ganti dengan @SerializedName di output class dan struktur yang sama berfungsi dengan Gson; record didukung mulai Gson 2.10.