แปลง JSON เป็น class ของ Java!

ป้อน JSON เพื่อสร้างโค้ด class ของ Java รวมถึงออบเจ็กต์ที่ซ้อนกัน! รองรับ Jackson @JsonProperty, Lombok Spring Boot JPA @Entity · MongoDB @Document อยู่ในแท็บด้านบน
JSON
ผลลัพธ์
 

แปลง JSON เป็น class ของ Java!

วางตัวอย่าง JSON แล้วจะได้คลาสหรือ record ของ Java ที่ Jackson deserialize ได้ทันที ออบเจ็กต์ที่ซ้อนกันจะกลายเป็นคลาสเพิ่มเติมในไฟล์เดียวกัน และอาร์เรย์จะเป็น List<T>

ใช้แทนการพิมพ์ DTO เองใน Spring Boot เช่น ไทป์ของ response สำหรับไคลเอนต์ RestTemplate, WebClient หรือ Feign หรือ request body สำหรับ API ภายนอก บน Java 16+ จะสร้างเป็น record ก็ได้ และถ้าโค้ดเบสใช้ Lombok อยู่แล้ว ตัวเลือก Lombok จะทำให้ผลลัพธ์เป็นสไตล์เดียวกัน

วิธีใช้

  1. วาง JSON ที่เป็น response ของ API ลงในช่องอินพุต
  2. ใส่ชื่อ DTO ใน ชื่อไทป์ เฉพาะคลาสแรกเท่านั้นที่เป็น public จึงควรตั้งให้ตรงกับชื่อไฟล์
  3. เลือก class (มี getter/setter) หรือ record ใน สไตล์
  4. ถ้าเลือก class ให้ติ๊ก Lombok เพื่อแทน getter/setter ด้วย @Data, @NoArgsConstructor และ @AllArgsConstructor
  5. วางผลลัพธ์ลงในไฟล์ .java แล้วเพิ่มการประกาศ package ของคุณ

ตัวอย่าง

อินพุต (JSON)
{
  "id": 1296269,
  "full_name": "octocat/Hello-World",
  "private": false,
  "stargazers_count": 80,
  "owner": { "login": "octocat", "site_admin": false },
  "topics": ["api", "demo"]
}
เอาต์พุต (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;
    }
}

คีย์แบบ snake_case อย่าง full_name ถูกจับคู่กับฟิลด์ fullName ผ่าน @JsonProperty private เป็นคำสงวนของ Java ฟิลด์จึงกลายเป็น private_ ขณะที่ accessor ยังเป็น getPrivate()/setPrivate() และออบเจ็กต์ owner ถูกแยกออกเป็นคลาส Owner ในไฟล์เดียวกัน

ฟีเจอร์ที่รองรับ

  • ผลลัพธ์สองสไตล์: class ปกติที่มี getter/setter หรือ record แบบ immutable
  • ตัวเลือก Lombok (เฉพาะสไตล์ class): เพิ่ม @Data, @NoArgsConstructor, @AllArgsConstructor พร้อม import และตัดโค้ด accessor ออก
  • เพิ่ม @JsonProperty และ import ของมันเฉพาะตรงที่ชื่อฟิลด์ต่างจากคีย์ JSON
  • ทุกฟิลด์ใช้ wrapper type (Integer, Long, Double, Boolean) จึงรับ null ของ JSON ได้โดยไม่ต้องทำอะไรเพิ่ม
  • จำนวนเต็มที่เกินช่วง 32 บิตเป็น Long และค่าที่ไทป์ปนกันเป็น Object
  • คีย์ที่เป็นคำสงวนอย่าง class หรือ default ได้ _ ต่อท้าย และคีย์ที่ขึ้นต้นด้วยตัวเลขได้คำนำหน้า n
  • Java ไม่มี type alias อาร์เรย์ระดับบนสุดจึงได้คอมเมนต์ // Root: List<RootItem> พร้อมคลาสของสมาชิก

กรณีการใช้งาน

DTO สำหรับ API ภายนอกใน Spring Boot

วาง response ตัวอย่างจากเอกสารของ API ชำระเงิน แผนที่ หรือส่งข้อความ แล้วส่งคลาสที่ได้ให้ restTemplate.getForObject(url, PaymentResponse.class) ยิ่งโครงสร้างซ้อนลึก ยิ่งช่วยลดฟิลด์ที่ตกหล่นเมื่อเทียบกับการเขียนเอง

โมเดล response แบบอ่านอย่างเดียวด้วย record

สำหรับ response ที่แค่อ่าน record สั้นกว่าและไม่มี setter โดย Jackson 2.12+ จะ deserialize ผ่าน canonical constructor ของ record

กู้โมเดลคืนจาก test fixture

ในโปรเจกต์ legacy ที่เหลือแค่ไฟล์ JSON ของ fixture ให้ใส่ fixture เข้าไปเพื่อดูโครงสร้างฟิลด์และได้ร่างแรกของ DTO

ข้อควรระวังและข้อจำกัด

  • ฟิลด์ที่ขาดไปในบางรายการจะมาเป็น null ใน wrapper type เท่านั้น ไม่มีอะไรระบุว่าเป็นฟิลด์ไม่บังคับ ถ้าต้อง validate ค่าที่จำเป็น ให้เพิ่ม @NotNull หรือ annotation ทำนองนั้นเอง
  • ด้วยการตั้งค่าเริ่มต้น Jackson จะโยน exception เมื่อเจอคีย์ที่ไม่รู้จัก ถ้า API อาจเพิ่มฟิลด์ ลองพิจารณา @JsonIgnoreProperties(ignoreUnknown = true) หรือปิด FAIL_ON_UNKNOWN_PROPERTIES
  • สตริงวันที่ออกมาเป็น String การจับคู่กับ LocalDateTime หรือ OffsetDateTime ต้องใช้โมดูล jackson-datatype-jsr310
  • เมื่อเลือก record เช็กบ็อกซ์ Lombok จะถูกซ่อน เพราะ record ไม่จำเป็นต้องใช้
  • คลาสที่ซ้อนกันเป็นคลาส package-private ในไฟล์เดียวกัน ไม่ใช่ public ถ้าแพ็กเกจอื่นต้องใช้ ให้แยกเป็นไฟล์ต่างหาก

คำถามที่พบบ่อย

ทำไม getter ของฟิลด์ boolean เป็น getXxx ไม่ใช่ isXxx?

ไทป์ของฟิลด์เป็น wrapper Boolean ไม่ใช่ primitive boolean และ Jackson รู้จัก accessor แบบ isXxx เฉพาะกับ primitive boolean มานานแล้ว จึงใช้ getXxx เพื่อให้พร็อพเพอร์ตี bind ได้เหมือนกันในทุกเวอร์ชันของ Jackson

ผลลัพธ์แบบ record ยังมี @JsonProperty อยู่ไหม?

มี component ที่เปลี่ยนชื่อจะเขียนเป็น @JsonProperty("full_name") String fullName โดย Jackson 2.12 ขึ้นไปจะเติมค่าผ่าน canonical constructor

ถ้าตั้ง spring.jackson.property-naming-strategy=SNAKE_CASE แล้ว ลบ annotation ทิ้งได้ไหม?

เมื่อใช้ strategy SNAKE_CASE แบบ global full_name ↔ fullName จะจับคู่ได้โดยไม่ต้องมี annotation แต่ชื่อที่เปลี่ยนเพราะคำสงวนอย่าง private_ ไม่อยู่ในขอบเขตของ strategy จึงควรเก็บ annotation พวกนั้นไว้

ใช้ผลลัพธ์กับ Gson ได้ไหม?

Gson ไม่สนใจ @JsonProperty ให้แทนด้วย @SerializedName ในผลลัพธ์แบบ class แล้วโครงสร้างเดิมจะใช้กับ Gson ได้ ส่วน record รองรับตั้งแต่ Gson 2.10