Chuyển JSON thành class Java!

Nhập JSON để tạo mã class Java, kể cả các object lồng nhau! Hỗ trợ Jackson @JsonProperty, Lombok. Spring Boot JPA @Entity · MongoDB @Document ở các tab phía trên.
JSON
Kết quả
 

Chuyển JSON thành class Java!

Dán một mẫu JSON để nhận class hoặc record Java mà Jackson deserialize được ngay. Object lồng nhau thành các class bổ sung trong cùng file, còn mảng thành List<T>.

Dùng nó cho những DTO mà bạn vẫn phải gõ tay trong Spring Boot: kiểu response cho client RestTemplate, WebClient hay Feign, hoặc body request cho API bên thứ ba. Với Java 16+ bạn có thể xuất record, và nếu codebase đã dùng Lombok, option Lombok giữ output cùng phong cách.

Cách sử dụng

  1. Dán JSON response của API vào ô nhập.
  2. Nhập tên DTO vào Tên kiểu. Chỉ class đầu tiên là public, nên hãy đặt trùng với tên file.
  3. Chọn class (có getter/setter) hoặc record ở mục Kiểu.
  4. Với class, đánh dấu Lombok để thay getter/setter bằng @Data, @NoArgsConstructor và @AllArgsConstructor.
  5. Dán kết quả vào file .java và thêm khai báo package.

Ví dụ

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

Key snake_case như full_name ánh xạ sang field fullName qua @JsonProperty. private là từ khóa Java nên field thành private_ trong khi accessor vẫn là getPrivate()/setPrivate(), và object owner được tách ra thành class Owner trong cùng file.

Tính năng hỗ trợ

  • Hai kiểu output: class thông thường có getter/setter, hoặc record bất biến.
  • Option Lombok (chỉ với kiểu class): thêm @Data, @NoArgsConstructor, @AllArgsConstructor cùng import và bỏ code accessor.
  • @JsonProperty chỉ được thêm ở chỗ tên field khác key JSON, kèm import của nó.
  • Mọi field dùng kiểu wrapper (Integer, Long, Double, Boolean), nên null của JSON vừa vặn mà không cần xử lý thêm.
  • Số nguyên vượt phạm vi 32 bit thành Long; giá trị có kiểu lẫn lộn thành Object.
  • Key trùng từ khóa như class hay default được thêm _ ở cuối; key bắt đầu bằng chữ số nhận tiền tố n.
  • Java không có type alias, nên mảng ở cấp cao nhất cho ra comment // Root: List<RootItem> cộng class phần tử.

Trường hợp sử dụng

DTO cho API bên thứ ba trong Spring Boot

Dán response mẫu trong tài liệu của API thanh toán, bản đồ hay nhắn tin, rồi truyền class được tạo vào restTemplate.getForObject(url, PaymentResponse.class). Cấu trúc càng lồng sâu thì càng tránh được nhiều field bị sót so với viết tay.

Model response chỉ đọc dạng record

Với response bạn chỉ đọc, record ngắn hơn và không có setter; Jackson 2.12+ deserialize thông qua canonical constructor của record.

Khôi phục model từ test fixture

Trong dự án legacy chỉ còn file JSON fixture, đưa một fixture vào để xem bố cục field và có bản nháp đầu tiên của DTO.

Lưu ý và giới hạn

  • Field thiếu ở một số phần tử chỉ đơn giản nhận null trong kiểu wrapper; không có gì đánh dấu nó là tùy chọn. Hãy tự thêm @NotNull hoặc tương tự nếu bạn validate giá trị bắt buộc.
  • Với thiết lập mặc định, Jackson ném lỗi khi gặp key lạ. Nếu API có thể thêm field, hãy cân nhắc @JsonIgnoreProperties(ignoreUnknown = true) hoặc tắt FAIL_ON_UNKNOWN_PROPERTIES.
  • Chuỗi ngày tháng ra dạng String. Ánh xạ sang LocalDateTime hay OffsetDateTime cần module jackson-datatype-jsr310.
  • Chọn record sẽ ẩn checkbox Lombok, vì record không cần đến nó.
  • Class lồng nhau là class package-private trong cùng file, không phải public. Hãy tách ra file riêng nếu package khác cần dùng.

Câu hỏi thường gặp

Vì sao getter của field boolean là getXxx chứ không phải isXxx?

Kiểu field là wrapper Boolean, không phải boolean nguyên thủy. Từ lâu Jackson chỉ nhận accessor isXxx cho boolean nguyên thủy, nên getXxx được dùng để property bind giống nhau trên mọi phiên bản Jackson.

Output record có giữ @JsonProperty không?

Có, component bị đổi tên được viết là @JsonProperty("full_name") String fullName. Jackson 2.12 trở lên điền giá trị qua canonical constructor.

Nếu đặt spring.jackson.property-naming-strategy=SNAKE_CASE thì có xóa annotation được không?

Với chiến lược SNAKE_CASE toàn cục, full_name ↔ fullName ánh xạ được mà không cần annotation. Những tên bị đổi vì trùng từ khóa, như private_, không nằm trong phạm vi của chiến lược, nên hãy giữ các annotation đó.

Có dùng output với Gson được không?

Gson bỏ qua @JsonProperty. Thay nó bằng @SerializedName trong output dạng class là cùng cấu trúc đó chạy được với Gson; record được hỗ trợ từ Gson 2.10.