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

JSONを入力し、Spring Boot MongoDBスキーマに変換します!Spring Data MongoDB, @Document, @Id 対応。
JSON
結果
 

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

JSON ドキュメントを Spring Data MongoDB の @Document クラスに変換します。@Document で指定したコレクション、@Id フィールド、キーごとの private フィールド(保存されるキーと異なる場合は @Field 付き)、Lombok と jakarta.validation のアノテーションを、すべて1つの Java ファイルにまとめます。

IoT の計測値、イベント、スクレイピング結果など、プレーンな JSON として MongoDB に溜まるデータを、Spring Boot のサービスから MongoRepository を通して読み書きする必要があるときに使ってください。

使い方

  1. コレクションにある、またはこれから入るドキュメントを貼り付けます。mongosh の find().limit(5) の出力のように複数を配列で貼り付ければ、時々しかないフィールドと常にあるフィールドを区別できます。
  2. モデル名 を入力します(空なら MyModel)。クラス名と @Document(collection = "...") のコレクションの両方に使われます。
  3. package の行を直してファイルを保存し、MongoRepository<DeviceLog, String> を継承するリポジトリを作ります。

例

入力 (JSON)
[
  { "device_id": "th-sensor-07", "temperature": 21.4, "battery": 87, "online": true, "recorded_at": "2024-02-11T06:00:00Z" },
  { "device_id": "th-sensor-09", "temperature": 19.8, "battery": 12, "online": false, "recorded_at": "2024-02-11T06:00:00Z", "firmware": "1.4.2" }
]
出力 (Spring Data MongoDB)
package com.hello.world.devicelog;

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;
import org.springframework.data.mongodb.core.mapping.Field;

import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;

import java.time.LocalDateTime;

import lombok.Getter;
import lombok.Setter;
import lombok.experimental.FieldNameConstants;

@Document(collection = "DeviceLog")
@FieldNameConstants
@Getter
@Setter
public class DeviceLog {
    @Id
    private String id;

    @NotEmpty()
    @Field("device_id")
    private String deviceId;

    @NotNull()
    private Double temperature;

    @NotNull()
    private Long battery;

    @NotNull()
    private Boolean online;

    @NotNull()
    @Field("recorded_at")
    private LocalDateTime recordedAt;

    private String firmware;
}

firmware は2つ目のドキュメントにしかないので、アノテーションが付いていません。device_id と recorded_at は @Field("device_id") と @Field("recorded_at") を通して読まれるので、既存のドキュメントもマイグレーションなしで camelCase のフィールドに対応付けられます。

対応機能

  • @Document(collection = "DeviceLog") でコレクションを明示的に指定します。
  • @Id private String id が MongoDB の _id を保持します。JSON の id や _id キーは重複させずにここへまとめ、数値の id なら Long にします。
  • 各フィールドは値から Long、Double、Boolean、LocalDate(YYYY-MM-DD)、LocalDateTime(日時)、String のいずれかに型付けされ、埋め込みオブジェクトは Map<String, Object>、配列は List<...> になります。
  • 末尾に _ を付けて名前を変えた Java のキーワードも含め、Java の名前が保存されるキーと異なる場合は必ず @Field("...") を付けます。
  • すべてのドキュメントにあるフィールドは、空でない文字列なら @NotEmpty()、それ以外なら @NotNull() が付き、時々しかないフィールドや null のフィールドには何も付きません。

利用シーン

センサーやログのコレクションを検索する API

デバイスが MongoDB に直接書き込む計測値をダッシュボードに提供する必要があるとき、ドキュメントをいくつか貼り付けてクラスを得れば、findByDeviceIdOrderByRecordedAtDesc のような派生クエリをすぐに宣言できます。

Node.js のサービスとコレクションを共有する

別のサービスがすでに snake_case で書き込んでいるコレクションを Spring から読む必要がある場合、@Field アノテーションのおかげで Java 側は camelCase の名前を使いながら同じキーを読み書きできます。

注意点と制限

  • @NotEmpty と @NotNull は既定では保存時にチェックされません。save() の直前に検証するには、ValidatingMongoEventListener の Bean を登録してください。
  • LocalDateTime は MongoDB に UTC 基準の Date として保存され、サーバーのタイムゾーンによってはずれて見えることがあります。正確な時点が重要なログなら Instant のほうが安全です。
  • Long の id は MongoDB が生成しないので、保存前に自分で割り当てる必要があります。自動で埋まるのは String、ObjectId、BigInteger の id だけです。
  • 埋め込みドキュメントは Map<String, Object> で出力されます。型付きのアクセスや検証がほしい場合は小さなクラスに置き換えてください。

よくある質問

MongoDB は _id で保存するのに、フィールド名が id なのはなぜですか?

Spring Data は id という名前の(または @Id を付けた)フィールドを自動で _id に対応付け、ObjectId らしい String は ObjectId に変換します。_id を自分で宣言する必要はありません。

コレクション名を device_logs にしたいです。

文字列を @Document(collection = "device_logs") と書き換えるだけです。ジェネレーターは入力したモデル名をそのまま挿入するので、モデル名に device_logs と入力するとクラス名まで DeviceLogs になってしまいます。

JPA のエンティティとは何が違いますか?

@Entity、@Column、@GeneratedValue の代わりに @Document、@Field、Spring Data の @Id を使い、ネストした値は JSON カラムを必要とせず埋め込みのまま残ります。リレーショナルなテーブルには JSON → Spring Boot JPA のページを使ってください。