I-convert ang JSON sa Spring Boot JPA Schema!

Ipasok ang JSON at i-convert ito sa Spring Boot JPA Schema! Sinusuportahan ang Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok.
JSON
Resulta
 

I-convert ang JSON sa Spring Boot JPA Schema!

Kino-convert ang JSON sa isang @Entity class para sa Spring Data JPA sa Spring Boot 3. Kasama sa iisang Java file ang mga import ng jakarta.persistence at jakarta.validation, isang @Id primary key, isang private field bawat key, ang @Getter, @Setter at @FieldNameConstants ng Lombok, at ang @NotEmpty/@NotNull ng Bean Validation.

Para ito sa trabaho sa Spring Boot backend kung saan kailangan mo agad ng entity na naka-map sa isang table, simula sa sample JSON mula sa isang integration partner o sa isang screen spec.

Paano gamitin

  1. I-paste ang isang record bilang object o ilan bilang array. Walang validation annotation ang mga field na wala sa alinmang record.
  2. Ilagay sa Pangalan ng model ang pangalan ng entity class (default MyModel). Ginagamit din ang lowercase na anyo nito sa dulo ng package (com.hello.world.reservation).
  3. Palitan ang linyang package ng package ng project mo, i-save ito bilang Reservation.java, at gumawa ng repository na nag-e-extend ng JpaRepository<Reservation, Long>.

Halimbawa

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;
}

Naging Long ang mga integer gaya ng room_no at nights, Double ang rate, at LocalDateTime ang check_in. Nakakakuha ng @Column(name = "...") ang bawat snake_case na key, at dahil may laman ang bawat value, nakakakuha ng @NotEmpty() ang String field na guestName at @NotNull() ang iba.

Mga sinusuportahang feature

  • Mga Java type: integer → Long, decimal → Double, boolean → Boolean, YYYY-MM-DD → LocalDate, date-time → LocalDateTime, ibang string (kasama ang mga puro digit) → String.
  • Nagiging Map<String, Object> ang mga object at List<...> ang mga array, parehong may annotation na @JdbcTypeCode(SqlTypes.JSON) para i-store sila ng Hibernate 6 sa isang JSON column.
  • Napapanatili ng @Column(name = "guest_name") ang orihinal na key bilang column name tuwing iba ang Java field name; nagiging class_ ang mga key na Java keyword, gaya ng class.
  • Sinusunod ng primary key ang JSON mo: kapag walang id o integer ang id, @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id ang lumalabas, at kapag string ang id, simpleng @Id private String id.
  • Nakakakuha ng @NotEmpty() ang mga field na laging nandoon kapag hindi blangkong string sila at @NotNull() kung hindi, dahil sa string at collection lang ina-apply ang @NotEmpty.
  • Gumagawa ang Lombok @FieldNameConstants ng mga name constant gaya ng Reservation.Fields.guestName.

Mga gamit

Mga batch job na nag-i-store ng external API data

Kapag kailangang pana-panahong kunin at i-save ang mga reservation o order mula sa ibang system, makukuha mo ang entity mula sa isang response JSON, at mabilis na susunod ang batch job skeleton sa paligid ng saveAll().

Mga development table gamit ang `ddl-auto`

Kapag naka-enable sa local ang spring.jpa.hibernate.ddl-auto=update, ginagawa ng Hibernate ang table mula sa na-generate na entity, kaya makakapag-load ka agad ng data para sa UI work.

Mga paalala at limitasyon

  • Naka-target sa Jakarta EE (Spring Boot 3, Hibernate 6) ang mga import. Sa Spring Boot 2, ibalik sa javax. ang jakarta. at palitan ng converter ang @JdbcTypeCode, dahil wala ito sa Hibernate 5.
  • Napa-parse ang 149.0 sa JSON bilang parehong numero ng 149, kaya nagiging Long ito. Kailangan ng decimal field ng value na may fractional part sa sample para lumabas na Double, at mas bagay ang BigDecimal para sa pera.
  • Nawawala ang offset sa LocalDateTime ng mga timestamp na may offset, gaya ng 2024-08-09T15:00:00+09:00. Gamitin ang OffsetDateTime o Instant kapag mahalaga ang eksaktong sandali.
  • Kailangan ng mga JSON column ng database na may ganoon (MySQL 5.7+, PostgreSQL, H2 2.x). Para sa totoong relation, palitan ang Map ng isang @Embedded class o @OneToMany association.

Mga madalas itanong

Bakit maglalagay ng @Column(name = ...) sa mga field na ima-map naman ng Spring sa snake_case?

Nagkataong ginagawang guest_name ng default naming strategy ng Spring Boot ang guestName, pero nasisira iyon sa sandaling hindi simpleng snake_case ang isang key o napalitan ang strategy. Sa explicit na pangalan, tama pa rin ang mapping anuman ang configuration.

Ipinapatupad ba ang @NotNull kapag nagse-save?

Kapag nasa classpath ang spring-boot-starter-validation (Hibernate Validator), pinapatakbo ng Hibernate ang Bean Validation bago mismo ang persist at update at nagta-throw ng ConstraintViolationException. Kapag wala ito, hindi pinapansin ang mga annotation.

Para saan ang @FieldNameConstants?

Gumagawa ang Lombok ng mga string constant gaya ng Reservation.Fields.checkIn. Gamitin sila sa Sort.by(Reservation.Fields.checkIn) o sa mga Specification/Criteria query sa halip na string literal, para ang build ang masira kapag pinalitan ang pangalan ng field, hindi ang query.