Convertir JSON en un schéma Spring Boot JPA !

Entrez JSON et convertissez-le en schéma Spring Boot JPA ! Compatible avec Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok.
JSON
Résultat
 

Convertir JSON en un schéma Spring Boot JPA !

Convertit du JSON en classe @Entity pour Spring Data JPA sur Spring Boot 3. Le fichier Java unique comprend les imports jakarta.persistence et jakarta.validation, une clé primaire @Id, un champ private par clé, les @Getter, @Setter et @FieldNameConstants de Lombok, et les @NotEmpty/@NotNull de Bean Validation.

Il vise le développement backend Spring Boot quand il vous faut rapidement une entité mappée sur une table, à partir d'un JSON d'exemple fourni par un partenaire d'intégration ou d'une spec d'écran.

Mode d'emploi

  1. Collez un enregistrement sous forme d'objet ou plusieurs sous forme de tableau. Les champs absents d'un enregistrement ne reçoivent pas d'annotation de validation.
  2. Saisissez le nom de la classe d'entité dans Nom du modèle (par défaut MyModel). Sa forme en minuscules sert aussi à la fin du package (com.hello.world.reservation).
  3. Remplacez la ligne package par le package de votre projet, enregistrez sous Reservation.java et créez un repository qui étend JpaRepository<Reservation, Long>.

Exemple

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

Les entiers comme room_no et nights sont devenus Long, rate Double et check_in LocalDateTime. Chaque clé snake_case reçoit @Column(name = "..."), et comme toutes les valeurs sont renseignées, le champ String guestName reçoit @NotEmpty() et les autres @NotNull().

Fonctionnalités prises en charge

  • Types Java : entiers → Long, décimaux → Double, booléens → Boolean, YYYY-MM-DD → LocalDate, dates-heures → LocalDateTime, autres chaînes (y compris purement numériques) → String.
  • Les objets deviennent Map<String, Object> et les tableaux List<...>, tous deux annotés @JdbcTypeCode(SqlTypes.JSON) pour qu'Hibernate 6 les stocke dans une colonne JSON.
  • @Column(name = "guest_name") garde la clé d'origine comme nom de colonne chaque fois que le nom du champ Java diffère ; les clés qui sont des mots-clés Java, comme class, deviennent class_.
  • La clé primaire suit votre JSON : sans id ou avec un id entier, on obtient @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id ; un id chaîne donne un simple @Id private String id.
  • Les champs toujours présents reçoivent @NotEmpty() quand ce sont des chaînes non vides et @NotNull() sinon, car @NotEmpty ne s'applique qu'aux chaînes et aux collections.
  • @FieldNameConstants de Lombok génère des constantes de noms comme Reservation.Fields.guestName.

Cas d'utilisation

Batchs qui stockent des données d'API externe

Quand des réservations ou commandes d'un autre système doivent être récupérées périodiquement et enregistrées, un JSON de réponse vous donne l'entité, et le squelette du batch autour de saveAll() suit rapidement.

Tables de développement via `ddl-auto`

Avec spring.jpa.hibernate.ddl-auto=update activé en local, Hibernate crée la table à partir de l'entité générée : vous pouvez charger des données pour le travail d'interface tout de suite.

Remarques et limites

  • Les imports ciblent Jakarta EE (Spring Boot 3, Hibernate 6). Sur Spring Boot 2, remettez jakarta. en javax. et remplacez @JdbcTypeCode par un converter, car il n'existe pas dans Hibernate 5.
  • 149.0 en JSON est lu comme le même nombre que 149 et devient donc Long. Un champ décimal a besoin d'une valeur fractionnaire dans l'exemple pour sortir en Double, et les montants sont mieux servis par BigDecimal.
  • Les horodatages avec décalage, comme 2024-08-09T15:00:00+09:00, perdent ce décalage dans LocalDateTime. Utilisez OffsetDateTime ou Instant quand l'instant exact compte.
  • Les colonnes JSON exigent une base qui les prend en charge (MySQL 5.7+, PostgreSQL, H2 2.x). Pour de vraies relations, remplacez la Map par une classe @Embedded ou une association @OneToMany.

FAQ

Pourquoi mettre @Column(name = ...) sur des champs que Spring mapperait de toute façon en snake_case ?

La stratégie de nommage par défaut de Spring Boot transforme bien guestName en guest_name, mais cela casse dès qu'une clé n'est pas du snake_case simple ou que la stratégie est changée. Le nom explicite garde le mapping correct quelle que soit la configuration.

@NotNull est-il appliqué à l'enregistrement ?

Avec spring-boot-starter-validation (Hibernate Validator) dans le classpath, Hibernate exécute Bean Validation juste avant persist et update et lève ConstraintViolationException. Sans lui, les annotations sont ignorées.

À quoi sert @FieldNameConstants ?

Lombok génère des constantes chaînes comme Reservation.Fields.checkIn. Utilisez-les dans Sort.by(Reservation.Fields.checkIn) ou dans des requêtes Specification/Criteria au lieu de littéraux : renommer un champ casse alors le build plutôt que la requête.