اسے Spring Data MongoDB کی @Document کلاس اس کی embedded کلاسز اور records کے ساتھ دیں، اور یہ مثال کے طور پر وہ JSON بناتا ہے جو controller اس document کو بھیجتے وقت لوٹاتا ہے۔ شکل Spring Boot کی ڈیفالٹ Jackson serialization کے مطابق ہوتی ہے، اس لیے یہ API response کو بیان کرتی ہے، MongoDB میں محفوظ BSON کو نہیں۔
یہ embedded lists، Map فیلڈز اور Instant timestamps سے بھرے MongoDB documents پر وقت بچاتا ہے، جہاں ہاتھ سے response کا نمونہ لکھنا تھکا دینے والا ہے، اور storage format اور response format کا فرق نمایاں کر دیتا ہے۔
@Document کلاس اور اس کی embedded کلاسز یا records کو Spring Data MongoDB باکس میں پیسٹ کریں۔id اور تاریخ کے placeholders کو حقیقت سے قریب values سے بدلیں۔@Document(collection = "devices")
public class Device {
@Id
private String id;
private String serial;
@Field("fw")
private String firmwareVersion;
private Map<String, Double> lastReadings;
private List<Alert> alerts;
private Instant registeredAt;
}
record Alert(String level, String message, Instant raisedAt) {}{
"id": "",
"serial": "",
"firmwareVersion": "",
"lastReadings": {
"key": 0
},
"alerts": [
{
"level": "",
"message": "",
"raisedAt": "1970-01-01T00:00:00Z"
}
],
"registeredAt": "1970-01-01T00:00:00Z"
}List<Alert> میں Alert ایک record ہے، اس لیے اس کے components level، message اور raisedAt فیلڈز بنتے ہیں۔ Map<String, Double> بنتا ہے {"key": 0}، اور Instant ایک UTC string ہے جو Z پر ختم ہوتی ہے۔ @Field("fw") صرف MongoDB میں محفوظ فیلڈ کا نام بدلتا ہے، اس لیے JSON key firmwareVersion ہی رہتی ہے۔
record Alert(String level, ...) کی طرح Java record components فیلڈز کے طور پر پڑھے جاتے ہیں۔List اور Set ایک عنصر والی arrays بنتے ہیں؛ Map<String, T> بنتا ہے {"key": value}۔Instant، ZonedDateTime اور OffsetDateTime سے 1970-01-01T00:00:00Z ملتا ہے، جبکہ LocalDateTime بغیر offset کی string دیتا ہے۔ObjectId type والے فیلڈز کو نمونے کی hex ObjectId string ملتی ہے۔@DBRef سے جڑی کلاسز اگر ان پٹ کا حصہ ہوں تو nested objects بن جاتی ہیں۔@JsonIgnore، @JsonProperty، @JsonIgnoreProperties اور وراثت میں ملے فیلڈز JPA صفحے والے قواعد ہی پر چلتے ہیں۔جو ڈھانچے MongoDB ایک document میں سمیٹ دیتا ہے، جیسے reviews کی فہرستیں، option maps اور history arrays، وہ لمبی response مثالیں بناتے ہیں۔ کلاسز پیسٹ کریں اور ہر nested سطح آپ کے لیے لکھ دی جاتی ہے۔
@Field کے ذریعے مختصر نام یا _id سے map کیے گئے فیلڈز ڈیٹا بیس keys کو API keys سے مختلف بنا دیتے ہیں۔ آؤٹ پٹ API والی طرف دکھاتا ہے، اس لیے آپ دونوں کو ساتھ ساتھ رکھ کر دیکھ سکتے ہیں۔
@Field("...")، @Indexed اور @TextIndexed جیسی mapping annotations JSON keys نہیں بدلتیں اور ان کا اثر نہیں دکھایا جاتا۔@Id String id، _id کے طور پر محفوظ ہوتا ہے لیکن Jackson سے id کے طور پر نکلتا ہے، اور آؤٹ پٹ یہی دکھاتا ہے۔org.bson.types.ObjectId کو hex string کے بجائے timestamp اور date والے آبجیکٹ کی صورت میں لکھتا ہے۔ یہاں دکھائی گئی string شکل بھیجنے کے لیے ToStringSerializer رجسٹر کریں یا String id استعمال کریں۔GeoJsonPoint جیسی Spring Data types سمیت، null بن جاتی ہیں۔@Id، ObjectId ہونا چاہیے یا String؟String کے ساتھ Spring Data محفوظ کرتے وقت اسے ObjectId میں بدلتا ہے اور API صاف hex string لوٹاتی ہے۔ ObjectId type رکھنے کا مطلب ہے کہ responses کے لیے اضافی Jackson configuration درکار ہوگی۔
@DBRef فیلڈز واقعی nested objects کی صورت میں واپس آتے ہیں؟@DBRef پڑھتے وقت حوالہ دیا گیا document حل کرتا ہے (lazy ہو تو پہلی رسائی پر)، اس لیے responses میں nested آبجیکٹ ہوتا ہے۔ صرف ObjectId یا String id محفوظ کرنے والے دستی references صرف id لوٹاتے ہیں۔
Map<String, Object> فیلڈ کیسا دکھتا ہے؟اس کی value type معلوم نہیں، اس لیے یہ {"key": null} بنتا ہے۔ docs میں ڈالنے سے پہلے اسے اس قسم کی value سے بدلیں جو آپ واقعی محفوظ کرتے ہیں۔