Tukarkan JSON kepada Spring Boot JPA!

Masukkan JSON dan tukarkannya kepada Spring Boot JPA! Menyokong Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok.
JSON
Hasil
 

Tukarkan JSON kepada Spring Boot JPA!

Menukar JSON kepada kelas @Entity untuk Spring Data JPA pada Spring Boot 3. Satu fail Java itu merangkumi import jakarta.persistence dan jakarta.validation, primary key @Id, medan private bagi setiap kunci, @Getter, @Setter dan @FieldNameConstants Lombok, serta @NotEmpty/@NotNull daripada Bean Validation.

Ia ditujukan untuk kerja backend Spring Boot apabila anda perlukan entity yang dipetakan ke jadual dengan cepat, bermula daripada sampel JSON rakan integrasi atau spesifikasi skrin.

Cara menggunakan

  1. Tampal satu rekod sebagai objek atau beberapa rekod sebagai tatasusunan. Medan yang tiada dalam mana-mana rekod tidak mendapat anotasi validasi.
  2. Masukkan nama kelas entity dalam Nama model (lalai MyModel). Bentuk huruf kecilnya juga digunakan di hujung package (com.hello.world.reservation).
  3. Tukar baris package kepada package projek anda, simpan sebagai Reservation.java, dan cipta repository yang mewarisi JpaRepository<Reservation, Long>.

Contoh

Input (JSON)
{
  "guest_name": "Hana Lee",
  "room_no": 1204,
  "nights": 3,
  "rate": 149.5,
  "breakfast": true,
  "check_in": "2024-08-09T15:00:00"
}
Output (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;
}

Integer seperti room_no dan nights menjadi Long, rate menjadi Double, dan check_in menjadi LocalDateTime. Setiap kunci snake_case mendapat @Column(name = "..."), dan oleh kerana setiap nilai terisi, medan String guestName mendapat @NotEmpty() manakala yang lain @NotNull().

Ciri yang disokong

  • Jenis Java: integer → Long, perpuluhan → Double, boolean → Boolean, YYYY-MM-DD → LocalDate, tarikh-masa → LocalDateTime, rentetan lain (termasuk yang hanya digit) → String.
  • Objek menjadi Map<String, Object> dan tatasusunan List<...>, kedua-duanya beranotasi @JdbcTypeCode(SqlTypes.JSON) supaya Hibernate 6 menyimpannya dalam lajur JSON.
  • @Column(name = "guest_name") mengekalkan kunci asal sebagai nama lajur setiap kali nama medan Java berbeza; kunci yang merupakan kata kunci Java, seperti class, menjadi class_.
  • Primary key mengikut JSON anda: tiada id atau id integer menghasilkan @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id, manakala id rentetan menghasilkan @Id private String id biasa.
  • Medan yang sentiasa ada mendapat @NotEmpty() jika ia rentetan tidak kosong dan @NotNull() jika sebaliknya, kerana @NotEmpty hanya terpakai pada rentetan dan koleksi.
  • @FieldNameConstants Lombok menjana pemalar nama seperti Reservation.Fields.guestName.

Kes penggunaan

Batch job yang menyimpan data API luaran

Apabila tempahan atau pesanan daripada sistem lain perlu ditarik secara berkala dan disimpan, satu JSON respons sudah memberi anda entity, dan rangka batch job di sekitar saveAll() boleh disiapkan dengan pantas.

Jadual pembangunan melalui `ddl-auto`

Dengan spring.jpa.hibernate.ddl-auto=update diaktifkan secara tempatan, Hibernate mencipta jadual daripada entity yang dijana, jadi anda boleh terus memuatkan data untuk kerja UI.

Nota dan had

  • Import menyasarkan Jakarta EE (Spring Boot 3, Hibernate 6). Pada Spring Boot 2, tukar jakarta. kembali kepada javax. dan gantikan @JdbcTypeCode dengan converter, kerana ia tidak wujud dalam Hibernate 5.
  • 149.0 dalam JSON dihurai sebagai nombor yang sama dengan 149, jadi ia menjadi Long. Medan perpuluhan memerlukan nilai pecahan dalam sampel untuk menjadi Double, dan untuk wang BigDecimal lebih sesuai.
  • Cap masa dengan offset, seperti 2024-08-09T15:00:00+09:00, kehilangan offset dalam LocalDateTime. Gunakan OffsetDateTime atau Instant apabila saat sebenar itu penting.
  • Lajur JSON memerlukan pangkalan data yang menyokongnya (MySQL 5.7+, PostgreSQL, H2 2.x). Untuk hubungan sebenar, gantikan Map dengan kelas @Embedded atau perkaitan @OneToMany.

Soalan lazim

Mengapa letak @Column(name = ...) pada medan yang akan dipetakan Spring ke snake_case juga?

Strategi penamaan lalai Spring Boot kebetulan menukar guestName kepada guest_name, tetapi ia rosak sebaik sahaja kunci bukan snake_case biasa atau strategi itu ditukar. Nama yang eksplisit memastikan pemetaan kekal betul tanpa mengira konfigurasi.

Adakah @NotNull dikuatkuasakan semasa menyimpan?

Dengan spring-boot-starter-validation (Hibernate Validator) dalam classpath, Hibernate menjalankan Bean Validation sejurus sebelum persist dan update dan membaling ConstraintViolationException. Tanpanya, anotasi tersebut diabaikan.

Apakah kegunaan @FieldNameConstants?

Lombok menjana pemalar rentetan seperti Reservation.Fields.checkIn. Gunakannya dalam Sort.by(Reservation.Fields.checkIn) atau dalam query Specification/Criteria menggantikan literal rentetan, supaya menamakan semula medan akan merosakkan build dan bukan query.