Chuyển đổi JSON thành giải pháp Spring Boot JPA!

Nhập JSON và chuyển đổi nó thành giải pháp Spring Boot JPA! Hỗ trợ Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok.
JSON
Kết quả
 

Chuyển đổi JSON thành giải pháp Spring Boot JPA!

Chuyển JSON thành class @Entity cho Spring Data JPA trên Spring Boot 3. Một file Java duy nhất có sẵn import jakarta.persistence và jakarta.validation, khóa chính @Id, một field private cho mỗi key, @Getter, @Setter và @FieldNameConstants của Lombok, cùng @NotEmpty/@NotNull của Bean Validation.

Công cụ hướng tới công việc backend Spring Boot khi bạn cần nhanh một entity ánh xạ tới bảng, bắt đầu từ JSON mẫu của đối tác tích hợp hoặc từ đặc tả màn hình.

Cách sử dụng

  1. Dán một bản ghi dưới dạng object hoặc nhiều bản ghi dưới dạng mảng. Field thiếu ở bất kỳ bản ghi nào sẽ không nhận annotation validate.
  2. Nhập tên class entity vào Tên model (mặc định MyModel). Dạng chữ thường của nó cũng được dùng ở cuối package (com.hello.world.reservation).
  3. Đổi dòng package thành package của dự án, lưu thành Reservation.java, rồi tạo repository kế thừa JpaRepository<Reservation, Long>.

Ví dụ

Đầu vào (JSON)
{
  "guest_name": "Hana Lee",
  "room_no": 1204,
  "nights": 3,
  "rate": 149.5,
  "breakfast": true,
  "check_in": "2024-08-09T15:00:00"
}
Đầu ra (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;
}

Số nguyên như room_no và nights thành Long, rate thành Double, và check_in thành LocalDateTime. Mỗi key snake_case nhận @Column(name = "..."), và vì mọi giá trị đều được điền, field String guestName nhận @NotEmpty() còn các field khác nhận @NotNull().

Tính năng hỗ trợ

  • Kiểu Java: số nguyên → Long, số thập phân → Double, boolean → Boolean, YYYY-MM-DD → LocalDate, ngày giờ → LocalDateTime, chuỗi khác (kể cả chuỗi chỉ gồm chữ số) → String.
  • Object thành Map<String, Object> và mảng thành List<...>, cả hai đều gắn @JdbcTypeCode(SqlTypes.JSON) để Hibernate 6 lưu vào cột JSON.
  • @Column(name = "guest_name") giữ key gốc làm tên cột mỗi khi tên field Java khác đi; key là từ khóa Java, như class, thành class_.
  • Khóa chính theo JSON của bạn: không có id hoặc id là số nguyên cho ra @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id, id dạng chuỗi cho ra @Id private String id thông thường.
  • Field luôn có mặt nhận @NotEmpty() khi là chuỗi không rỗng và @NotNull() trong các trường hợp khác, vì @NotEmpty chỉ áp dụng cho chuỗi và collection.
  • @FieldNameConstants của Lombok tạo hằng tên như Reservation.Fields.guestName.

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

Batch job lưu dữ liệu từ API bên ngoài

Khi phải định kỳ kéo đặt phòng hay đơn hàng từ hệ thống khác về và lưu lại, một JSON response là đủ để có entity, và khung batch job quanh saveAll() theo sau rất nhanh.

Bảng phát triển qua `ddl-auto`

Khi bật spring.jpa.hibernate.ddl-auto=update ở máy local, Hibernate tạo bảng từ entity được tạo, nên bạn có thể nạp dữ liệu cho công việc UI ngay.

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

  • Import nhắm tới Jakarta EE (Spring Boot 3, Hibernate 6). Trên Spring Boot 2, hãy đổi jakarta. lại thành javax. và thay @JdbcTypeCode bằng converter, vì nó không có trong Hibernate 5.
  • 149.0 trong JSON được parse thành cùng con số với 149, nên thành Long. Field thập phân cần mẫu có phần lẻ mới ra Double, và với tiền tệ thì BigDecimal phù hợp hơn.
  • Timestamp có offset, như 2024-08-09T15:00:00+09:00, mất offset trong LocalDateTime. Dùng OffsetDateTime hoặc Instant khi thời điểm chính xác là quan trọng.
  • Cột JSON cần database có hỗ trợ (MySQL 5.7+, PostgreSQL, H2 2.x). Với quan hệ thật, hãy thay Map bằng class @Embedded hoặc liên kết @OneToMany.

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

Sao phải đặt @Column(name = ...) trên field mà Spring vốn đã ánh xạ sang snake_case?

Chiến lược đặt tên mặc định của Spring Boot tình cờ biến guestName thành guest_name, nhưng sẽ hỏng ngay khi một key không phải snake_case thuần hoặc chiến lược bị thay đổi. Tên tường minh giữ phép ánh xạ đúng bất kể cấu hình.

@NotNull có được kiểm tra khi lưu không?

Khi có spring-boot-starter-validation (Hibernate Validator) trên classpath, Hibernate chạy Bean Validation ngay trước persist và update, và ném ConstraintViolationException. Không có nó, các annotation bị bỏ qua.

@FieldNameConstants dùng để làm gì?

Lombok tạo các hằng chuỗi như Reservation.Fields.checkIn. Hãy dùng chúng trong Sort.by(Reservation.Fields.checkIn) hoặc trong truy vấn Specification/Criteria thay cho string literal, để khi đổi tên field thì build bị lỗi chứ không phải truy vấn.