แปลง JSON เป็น Spring Boot MongoDB แผน!

ป้อน JSON และแปลงเป็น Spring Boot MongoDB แผน! รองรับ Spring Data MongoDB, @Document, @Id
JSON
ผลลัพธ์
 

แปลง JSON เป็น Spring Boot MongoDB แผน!

แปลงเอกสาร JSON เป็นคลาส @Document ของ Spring Data MongoDB: คอลเลกชันที่ระบุใน @Document ฟิลด์ @Id ฟิลด์ private ต่อหนึ่งคีย์พร้อม @Field เมื่อคีย์ที่เก็บต่างไป รวมถึง annotation ของ Lombok และ jakarta.validation ทั้งหมดในไฟล์ Java ไฟล์เดียว

ใช้เมื่อข้อมูลที่ลงไปอยู่ใน MongoDB เป็น JSON ธรรมดา (ค่าจากอุปกรณ์ IoT, event, ผลจากการ scrape) ต้องถูกอ่านและเขียนจากเซอร์วิส Spring Boot ผ่าน MongoRepository

วิธีใช้

  1. วางเอกสารที่อยู่หรือจะอยู่ในคอลเลกชัน การวางหลายเอกสารเป็นอาร์เรย์ เช่นผลของ find().limit(5) ใน mongosh จะช่วยแยกฟิลด์ที่มีบางครั้งออกจากฟิลด์ที่มีเสมอ
  2. พิมพ์ ชื่อโมเดล (ถ้าว่างจะเป็น MyModel) ชื่อนี้ใช้ทั้งเป็นชื่อคลาสและชื่อคอลเลกชันใน @Document(collection = "...")
  3. แก้บรรทัด package บันทึกไฟล์ แล้วสร้าง repository ที่ extend 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 มีแค่ในเอกสารที่สอง จึงไม่มี annotation ส่วน device_id และ recorded_at ถูกอ่านผ่าน @Field("device_id") และ @Field("recorded_at") เอกสารที่มีอยู่จึงจับคู่กับฟิลด์ camelCase ได้โดยไม่ต้อง migrate

ฟีเจอร์ที่รองรับ

  • ระบุชื่อคอลเลกชันชัดเจนด้วย @Document(collection = "DeviceLog")
  • @Id private String id เก็บ _id ของ MongoDB คีย์ id หรือ _id ใน JSON ถูกรวมเข้าไปแทนที่จะซ้ำ และ id ที่เป็นตัวเลขจะทำให้เป็น Long
  • แต่ละฟิลด์ได้ไทป์จากค่าของมันเป็น Long, Double, Boolean, LocalDate (YYYY-MM-DD), LocalDateTime (วันเวลา) หรือ String ออบเจ็กต์ที่ฝังอยู่เป็น Map<String, Object> และอาร์เรย์เป็น List<...>
  • เพิ่ม @Field("...") เมื่อชื่อใน Java ไม่ใช่คีย์ที่เก็บ รวมถึงคำสงวนของ Java ที่ถูกเปลี่ยนชื่อโดยเติม _ ต่อท้าย
  • ฟิลด์ที่มีในทุกเอกสารได้ @NotEmpty() เมื่อเป็นสตริงที่ไม่ว่าง และ @NotNull() ในกรณีอื่น ส่วนฟิลด์ที่มีบางครั้งหรือเป็น null ไม่ได้ annotation

กรณีการใช้งาน

API สำหรับ query คอลเลกชันของเซนเซอร์หรือ log

เมื่อค่าที่อุปกรณ์เขียนลง MongoDB โดยตรงต้องส่งให้แดชบอร์ด วางเอกสารสักสองสามตัวเพื่อให้ได้คลาส แล้วประกาศ derived query อย่าง findByDeviceIdOrderByRecordedAtDesc ได้ทันที

ใช้คอลเลกชันร่วมกับเซอร์วิส Node.js

ถ้า Spring ต้องอ่านคอลเลกชันที่เซอร์วิสอื่นเขียนเป็น snake_case อยู่แล้ว annotation @Field ทำให้ฝั่ง Java ใช้ชื่อ camelCase ได้ขณะที่อ่านและเขียนคีย์ชุดเดิม

ข้อควรระวังและข้อจำกัด

  • @NotEmpty และ @NotNull ไม่ถูกตรวจตอนบันทึกโดยค่าเริ่มต้น ให้ลงทะเบียน bean ValidatingMongoEventListener เพื่อ validate ก่อน save()
  • LocalDateTime ถูกเก็บเป็น Date ที่อิง UTC ใน MongoDB และอาจดูเหมือนเลื่อนไปตามเขตเวลาของเซิร์ฟเวอร์ สำหรับ log ที่ช่วงเวลาแน่นอนสำคัญ Instant ปลอดภัยกว่า
  • id แบบ Long ไม่ถูกสร้างโดย MongoDB ต้องกำหนดเองก่อนบันทึก มีแค่ id แบบ String, ObjectId และ BigInteger ที่ถูกเติมให้อัตโนมัติ
  • เอกสารที่ฝังอยู่ออกมาเป็น Map<String, Object> ถ้าต้องการเข้าถึงแบบมีไทป์และ validation ให้เปลี่ยนเป็นคลาสเล็ก ๆ

คำถามที่พบบ่อย

ทำไมฟิลด์ชื่อ id ทั้งที่ MongoDB เก็บเป็น _id?

Spring Data จับคู่ฟิลด์ชื่อ id (หรือที่มี @Id) กับ _id ให้อัตโนมัติ และแปลง String เป็น ObjectId เมื่อมีรูปแบบเหมือน ObjectId ไม่จำเป็นต้องประกาศ _id เอง

อยากให้คอลเลกชันชื่อ device_logs

แก้สตริงได้เลย: @Document(collection = "device_logs") ตัวสร้างใส่ชื่อโมเดลตามที่พิมพ์ ถ้าพิมพ์ device_logs เป็นชื่อโมเดล คลาสก็จะกลายเป็น DeviceLogs ไปด้วย

ต่างจาก JPA entity อย่างไร?

ใช้ @Document, @Field และ @Id ของ Spring Data แทน @Entity, @Column และ @GeneratedValue และค่าที่ซ้อนกันยังฝังอยู่ในเอกสารโดยไม่ต้องใช้คอลัมน์ JSON สำหรับตารางเชิงสัมพันธ์ ให้ใช้หน้า JSON → Spring Boot JPA