JSON کو Spring Boot MongoDB منصوبے میں تبدیل کریں!

JSON درج کریں اور اسے Spring Boot MongoDB منصوبے میں تبدیل کریں! Spring Data MongoDB, @Document, @Id سپورٹ۔
JSON
نتیجہ
 

JSON کو Spring Boot MongoDB منصوبے میں تبدیل کریں!

JSON documents کو Spring Data MongoDB کی @Document کلاس میں بدلتا ہے: @Document میں collection کا نام، ایک @Id فیلڈ، ہر key کے لیے ایک private فیلڈ اور جہاں محفوظ key مختلف ہو وہاں @Field، ساتھ میں Lombok اور jakarta.validation annotations، سب ایک Java فائل میں۔

اسے تب استعمال کریں جب MongoDB میں سادہ JSON کی صورت میں آنے والا ڈیٹا (IoT readings، events، scraping کے نتائج) Spring Boot سروس سے MongoRepository کے ذریعے پڑھنا اور لکھنا ہو۔

استعمال کا طریقہ

  1. وہ documents پیسٹ کریں جو collection میں ہیں یا ہوں گے۔ کئی documents array کی صورت میں پیسٹ کرنے سے، جیسے mongosh میں find().limit(5) کا آؤٹ پٹ، کبھی کبھار آنے والے فیلڈز مستقل فیلڈز سے الگ ہو جاتے ہیں۔
  2. ماڈل کا نام لکھیں (خالی ہو تو MyModel)؛ یہ کلاس نام اور @Document(collection = "...") میں collection دونوں کے لیے استعمال ہوتا ہے۔
  3. package لائن درست کریں، فائل محفوظ کریں، اور MongoRepository<DeviceLog, String> کو extend کرنے والی repository بنائیں۔

مثال

ان پٹ (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 صرف دوسرے document میں ہے، اس لیے اس پر کوئی annotation نہیں۔ device_id اور recorded_at، @Field("device_id") اور @Field("recorded_at") کے ذریعے پڑھے جاتے ہیں، اس لیے موجودہ documents بغیر migration کے camelCase فیلڈز سے map ہو جاتے ہیں۔

معاون خصوصیات

  • @Document(collection = "DeviceLog") سے collection کا نام واضح طور پر دیتا ہے۔
  • @Id private String id میں MongoDB کا _id ہوتا ہے؛ آپ کے JSON میں id یا _id key دہرانے کے بجائے اسی میں ضم ہو جاتی ہے، اور عددی id اسے Long بنا دیتا ہے۔
  • ہر فیلڈ کی type اس کی values سے Long، Double، Boolean، LocalDate (YYYY-MM-DD)، LocalDateTime (date-times) یا String طے ہوتی ہے؛ embedded objects بنتے ہیں Map<String, Object> اور arrays بنتی ہیں List<...>۔
  • جب بھی Java نام محفوظ key سے مختلف ہو، @Field("...") شامل کیا جاتا ہے، آخر میں _ لگا کر نام بدلے گئے Java keywords سمیت۔
  • ہر document میں موجود فیلڈز کو غیر خالی strings کے لیے @NotEmpty() اور باقی کے لیے @NotNull() ملتا ہے؛ کبھی کبھار آنے والے یا null فیلڈز کو کچھ نہیں ملتا۔

استعمال کے کیس

sensor یا log collections پر query APIs

جب devices کی سیدھی MongoDB میں لکھی گئی readings کسی dashboard کو دینی ہوں، تو چند documents پیسٹ کر کے کلاس حاصل کریں اور فوراً findByDeviceIdOrderByRecordedAtDesc جیسی derived queries ڈکلیئر کریں۔

Node.js سروس کے ساتھ collection شیئر کرنا

اگر Spring کو ایسی collection پڑھنی ہو جسے کوئی دوسری سروس پہلے سے snake_case میں لکھتی ہے، تو @Field annotations کی بدولت Java کی طرف camelCase نام استعمال ہوتے ہیں جبکہ وہی keys پڑھی اور لکھی جاتی ہیں۔

نوٹس اور حدود

  • @NotEmpty اور @NotNull بطور ڈیفالٹ save پر چیک نہیں ہوتے؛ save() سے بالکل پہلے validate کرنے کے لیے ValidatingMongoEventListener bean رجسٹر کریں۔
  • LocalDateTime، MongoDB میں UTC پر مبنی Date کے طور پر محفوظ ہوتا ہے اور سرور کے time zone کے حساب سے کھسکا ہوا نظر آ سکتا ہے۔ جن logs میں درست لمحہ اہم ہو، ان کے لیے Instant زیادہ محفوظ ہے۔
  • Long id کو MongoDB نہیں بناتا؛ محفوظ کرنے سے پہلے آپ کو خود دینی ہوگی۔ صرف String، ObjectId اور BigInteger ids خودکار طور پر بھری جاتی ہیں۔
  • embedded documents، Map<String, Object> کی صورت میں آتے ہیں۔ typed رسائی اور validation چاہیے تو انہیں چھوٹی کلاسز سے بدل دیں۔

عام سوالات

جب MongoDB _id محفوظ کرتا ہے تو فیلڈ کا نام id کیوں ہے؟

Spring Data، id نام والے (یا @Id والے) فیلڈ کو خودکار طور پر _id سے map کرتا ہے اور String کو ObjectId جیسا لگنے پر ObjectId میں بدل دیتا ہے۔ _id خود ڈکلیئر کرنے کی ضرورت نہیں۔

میں چاہتا ہوں کہ collection کا نام device_logs ہو۔

بس string ایڈٹ کریں: @Document(collection = "device_logs")۔ generator ماڈل نام جیسا لکھا گیا ویسا ہی ڈالتا ہے، اس لیے ماڈل نام میں device_logs لکھنے سے کلاس بھی DeviceLogs بن جائے گی۔

یہ JPA entity سے کیسے مختلف ہے؟

یہ @Entity، @Column اور @GeneratedValue کے بجائے @Document، @Field اور Spring Data کا @Id استعمال کرتا ہے، اور nested values کو JSON کالم کی ضرورت کے بجائے embedded رہتی ہیں۔ relational tables کے لیے JSON → Spring Boot JPA صفحہ استعمال کریں۔