แปลง JSON เป็น Spring Boot JPA แผน!

ป้อน JSON และแปลงเป็น Spring Boot JPA แผน! รองรับ Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok
JSON
ผลลัพธ์
 

แปลง JSON เป็น Spring Boot JPA แผน!

แปลง JSON เป็นคลาส @Entity สำหรับ Spring Data JPA บน Spring Boot 3 ไฟล์ Java ไฟล์เดียวมี import ของ jakarta.persistence และ jakarta.validation primary key แบบ @Id ฟิลด์ private ต่อหนึ่งคีย์ @Getter, @Setter และ @FieldNameConstants ของ Lombok และ @NotEmpty/@NotNull ของ Bean Validation

เหมาะกับงาน backend Spring Boot ที่ต้องการ entity ที่จับคู่กับตารางอย่างรวดเร็ว โดยเริ่มจาก JSON ตัวอย่างของพาร์ตเนอร์ที่เชื่อมระบบหรือสเปกของหน้าจอ

วิธีใช้

  1. วางหนึ่งเรคคอร์ดเป็นออบเจ็กต์หรือหลายเรคคอร์ดเป็นอาร์เรย์ ฟิลด์ที่ขาดไปในเรคคอร์ดใดจะไม่ได้ annotation สำหรับ validation
  2. ใส่ชื่อคลาส entity ใน ชื่อโมเดล (ค่าเริ่มต้น MyModel) ชื่อแบบตัวพิมพ์เล็กจะถูกใช้ต่อท้าย package ด้วย (com.hello.world.reservation)
  3. เปลี่ยนบรรทัด package เป็น package ของโปรเจกต์ บันทึกเป็น Reservation.java แล้วสร้าง repository ที่ extend JpaRepository<Reservation, Long>

ตัวอย่าง

อินพุต (JSON)
{
  "guest_name": "Hana Lee",
  "room_no": 1204,
  "nights": 3,
  "rate": 149.5,
  "breakfast": true,
  "check_in": "2024-08-09T15:00:00"
}
เอาต์พุต (Spring Data JPA)
package com.hello.world.reservation;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;

import java.time.LocalDateTime;

import lombok.Getter;
import lombok.Setter;
import lombok.experimental.FieldNameConstants;

@Entity
@FieldNameConstants
@Getter
@Setter
public class Reservation {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @NotEmpty()
    @Column(name = "guest_name")
    private String guestName;

    @NotNull()
    @Column(name = "room_no")
    private Long roomNo;

    @NotNull()
    private Long nights;

    @NotNull()
    private Double rate;

    @NotNull()
    private Boolean breakfast;

    @NotNull()
    @Column(name = "check_in")
    private LocalDateTime checkIn;
}

จำนวนเต็มอย่าง room_no และ nights กลายเป็น Long ส่วน rate เป็น Double และ check_in เป็น LocalDateTime ทุกคีย์แบบ snake_case ได้ @Column(name = "...") และเพราะทุกค่ามีข้อมูลครบ ฟิลด์ String อย่าง guestName จึงได้ @NotEmpty() ส่วนที่เหลือได้ @NotNull()

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

  • ไทป์ Java: จำนวนเต็ม → Long, ทศนิยม → Double, บูลีน → Boolean, YYYY-MM-DD → LocalDate, วันเวลา → LocalDateTime, สตริงอื่น (รวมที่มีแต่ตัวเลข) → String
  • ออบเจ็กต์เป็น Map<String, Object> และอาร์เรย์เป็น List<...> ทั้งคู่มี @JdbcTypeCode(SqlTypes.JSON) เพื่อให้ Hibernate 6 เก็บลงคอลัมน์ JSON
  • @Column(name = "guest_name") เก็บคีย์เดิมเป็นชื่อคอลัมน์เมื่อชื่อฟิลด์ Java ต่างไป คีย์ที่เป็นคำสงวนของ Java อย่าง class จะเป็น class_
  • primary key เป็นไปตาม JSON ของคุณ: ไม่มี id หรือ id เป็นจำนวนเต็ม จะได้ @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id ส่วน id ที่เป็นสตริงจะได้ @Id private String id ธรรมดา
  • ฟิลด์ที่มีเสมอได้ @NotEmpty() เมื่อเป็นสตริงที่ไม่ว่าง นอกนั้นได้ @NotNull() เพราะ @NotEmpty ใช้ได้กับสตริงและคอลเลกชันเท่านั้น
  • @FieldNameConstants ของ Lombok สร้างค่าคงที่ของชื่ออย่าง Reservation.Fields.guestName

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

batch job ที่เก็บข้อมูลจาก API ภายนอก

เมื่อต้องดึงการจองหรือคำสั่งซื้อจากระบบอื่นเป็นระยะแล้วบันทึก JSON ของ response ตัวเดียวก็ได้ entity และโครง batch job รอบ saveAll() ก็ตามมาได้เร็ว

ตารางสำหรับพัฒนาผ่าน `ddl-auto`

เมื่อเปิด spring.jpa.hibernate.ddl-auto=update บนเครื่อง Hibernate จะสร้างตารางจาก entity ที่ได้ คุณจึงโหลดข้อมูลสำหรับงาน UI ได้ทันที

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

  • import อิง Jakarta EE (Spring Boot 3, Hibernate 6) บน Spring Boot 2 ให้เปลี่ยน jakarta. กลับเป็น javax. และแทน @JdbcTypeCode ด้วย converter เพราะ Hibernate 5 ไม่มี
  • 149.0 ใน JSON ถูกพาร์สเป็นตัวเลขเดียวกับ 149 จึงกลายเป็น Long ฟิลด์ทศนิยมต้องมีค่าที่มีเศษในตัวอย่างจึงจะออกมาเป็น Double และสำหรับเงิน BigDecimal เหมาะกว่า
  • timestamp ที่มี offset อย่าง 2024-08-09T15:00:00+09:00 จะเสีย offset ไปใน LocalDateTime ถ้าช่วงเวลาที่แน่นอนสำคัญ ให้ใช้ OffsetDateTime หรือ Instant
  • คอลัมน์ JSON ต้องใช้ฐานข้อมูลที่รองรับ (MySQL 5.7+, PostgreSQL, H2 2.x) ถ้าเป็นความสัมพันธ์จริง ให้แทน Map ด้วยคลาส @Embedded หรือความสัมพันธ์ @OneToMany

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

ทำไมใส่ @Column(name = ...) ในฟิลด์ที่ Spring จะจับคู่เป็น snake_case อยู่แล้ว?

naming strategy ค่าเริ่มต้นของ Spring Boot บังเอิญแปลง guestName เป็น guest_name ได้ แต่จะพังทันทีเมื่อคีย์ไม่ใช่ snake_case ธรรมดาหรือมีการเปลี่ยน strategy การระบุชื่อชัดเจนทำให้การจับคู่ถูกต้องไม่ว่าคอนฟิกจะเป็นอย่างไร

@NotNull ถูกบังคับตอนบันทึกไหม?

ถ้ามี spring-boot-starter-validation (Hibernate Validator) ใน classpath Hibernate จะรัน Bean Validation ก่อน persist และ update และโยน ConstraintViolationException ถ้าไม่มี annotation จะถูกเพิกเฉย

@FieldNameConstants มีไว้ทำอะไร?

Lombok สร้างค่าคงที่สตริงอย่าง Reservation.Fields.checkIn ใช้ใน Sort.by(Reservation.Fields.checkIn) หรือ query แบบ Specification/Criteria แทน string literal เมื่อเปลี่ยนชื่อฟิลด์ build จะพังแทนที่ query จะพัง