JSONをSpring Boot JPAスキーマに変換!

JSONを入力してSpring Boot JPAスキーマに変換します!Spring Data JPA, Hibernate, @Entity, @Id, @GeneratedValue, Lombok 対応。
JSON
結果
 

JSONをSpring Boot JPAスキーマに変換!

JSON を、Spring Boot 3 の Spring Data JPA 向けの @Entity クラスに変換します。1つの Java ファイルに、jakarta.persistence と jakarta.validation の import、@Id の主キー、キーごとの private フィールド、Lombok の @Getter、@Setter、@FieldNameConstants、Bean Validation の @NotEmpty/@NotNull が含まれます。

連携先から受け取ったサンプル JSON や画面仕様を出発点に、テーブルにマッピングしたエンティティを素早く用意したい Spring Boot のバックエンド開発を想定しています。

使い方

  1. 1件ならオブジェクトで、複数件なら配列で貼り付けます。どれかのレコードにないフィールドには検証アノテーションが付きません。
  2. モデル名 にエンティティのクラス名を入力します(既定は MyModel)。その小文字形はパッケージの末尾(com.hello.world.reservation)にも使われます。
  3. package の行をプロジェクトのパッケージに変えて Reservation.java として保存し、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 カラムに保存するようにします。
  • Java のフィールド名が元のキーと異なる場合は、@Column(name = "guest_name") で元のキーをカラム名として保ちます。class のような Java のキーワードのキーは class_ になります。
  • 主キーは JSON に従います。id がないか整数の id なら @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id、文字列の id なら単なる @Id private String id になります。
  • @NotEmpty は文字列とコレクションにしか使えないため、常にあるフィールドのうち空でない文字列には @NotEmpty()、それ以外には @NotNull() を付けます。
  • Lombok の @FieldNameConstants が Reservation.Fields.guestName のような名前の定数を生成します。

利用シーン

外部 API のデータを保存するバッチ処理

他システムの予約や注文を定期的に取得して保存する必要があるとき、レスポンスの JSON 1つからエンティティが得られ、saveAll() を中心としたバッチ処理の骨組みもすぐに書けます。

`ddl-auto` による開発用テーブル

ローカルで spring.jpa.hibernate.ddl-auto=update を有効にしておけば、生成したエンティティから Hibernate がテーブルを作るので、UI 開発用のデータをすぐに投入できます。

注意点と制限

  • import は Jakarta EE(Spring Boot 3、Hibernate 6)向けです。Spring Boot 2 では jakarta. を javax. に戻し、Hibernate 5 には存在しない @JdbcTypeCode はコンバーターに置き換えてください。
  • JSON の 149.0 は 149 と同じ数値として解析されるので Long になります。小数のフィールドを Double にするにはサンプルに小数部のある値が必要で、金額なら BigDecimal のほうが適しています。
  • 2024-08-09T15:00:00+09:00 のようにオフセット付きのタイムスタンプは、LocalDateTime ではオフセットが失われます。時点そのものが重要なら OffsetDateTime や Instant を使ってください。
  • JSON カラムには、それを持つデータベース(MySQL 5.7 以降、PostgreSQL、H2 2.x)が必要です。本格的なリレーションにするなら、Map を @Embedded クラスや @OneToMany の関連に置き換えてください。

よくある質問

Spring がどうせ snake_case に対応付けるフィールドにも @Column(name = ...) を付けるのはなぜですか?

Spring Boot の既定の命名戦略はたまたま guestName を guest_name にしてくれますが、キーが単純な snake_case でなかったり戦略が変更されたりすると、すぐに崩れます。名前を明示しておけば、設定に関係なくマッピングが正しく保たれます。

@NotNull は保存時に強制されますか?

クラスパスに spring-boot-starter-validation(Hibernate Validator)があれば、Hibernate が persist と update の直前に Bean Validation を実行し、ConstraintViolationException を投げます。なければアノテーションは無視されます。

@FieldNameConstants は何のためにありますか?

Lombok が Reservation.Fields.checkIn のような文字列定数を生成します。Sort.by(Reservation.Fields.checkIn) や Specification/Criteria のクエリで文字列リテラルの代わりに使えば、フィールド名を変えたときにクエリではなくビルドが壊れてくれます。