MongoDB ডকুমেন্ট ক্লাস কে JSON-এ রূপান্তর করুন!

MongoDB ডকুমেন্ট ক্লাস দিন এবং উদাহরণ JSON তৈরি করুন! Spring Data MongoDB @Document সমর্থিত। API ডকুমেন্টেশন ও টেস্ট request body (sample JSON)-এর জন্য উপযোগী।
Spring Data MongoDB
ফলাফল
 

MongoDB ডকুমেন্ট ক্লাস কে JSON-এ রূপান্তর করুন!

Spring Data MongoDB-র একটি @Document ক্লাস তার embedded ক্লাস ও record-সহ দিন, এটি সেই ডকুমেন্ট পাঠালে controller কী ফেরত দেয় তার উদাহরণ JSON তৈরি করে। আকৃতিটি Spring Boot-এর ডিফল্ট Jackson serialization মানে, তাই এটি API response বর্ণনা করে, MongoDB-তে সংরক্ষিত BSON নয়।

Embedded তালিকা, Map ফিল্ড আর Instant timestamp-এ ভরা MongoDB ডকুমেন্টে হাতে response নমুনা লেখা ক্লান্তিকর, সেখানে এটি সময় বাঁচায়, আর সংরক্ষণের ফরম্যাট ও response ফরম্যাটের পার্থক্য চোখের সামনে আনে।

কীভাবে ব্যবহার করবেন

  1. Spring Data MongoDB বক্সে @Document ক্লাস আর তার embedded ক্লাস বা record পেস্ট করুন।
  2. যে ডকুমেন্ট ক্লাসকে অন্য কোনো ক্লাস reference করে না সেটি আউটপুটের রুট হয়।
  3. ডকুমেন্টেশন বা টেস্টে JSON ব্যবহার করার আগে id আর তারিখের placeholder বাস্তবসম্মত ভ্যালু দিয়ে বদলান।

উদাহরণ

ইনপুট (Java · Spring Data MongoDB)
@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) {}
আউটপুট (JSON)
{
  "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, তাই এর component level, message আর raisedAt ফিল্ড হয়। Map<String, Double> হয় {"key": 0}, আর Instant হলো Z দিয়ে শেষ হওয়া UTC স্ট্রিং। @Field("fw") শুধু MongoDB-তে সংরক্ষিত ফিল্ডের নাম বদলায়, তাই JSON key firmwareVersion-ই থাকে।

সমর্থিত বৈশিষ্ট্য

  • record Alert(String level, ...)-এর মতো Java record component ফিল্ড হিসেবে পড়া হয়।
  • List আর Set এক element-এর array হয়; Map<String, T> হয় {"key": value}।
  • Instant, ZonedDateTime আর OffsetDateTime দেয় 1970-01-01T00:00:00Z, অন্যদিকে LocalDateTime দেয় offset ছাড়া স্ট্রিং।
  • ObjectId type-এর ফিল্ড একটি নমুনা hex ObjectId স্ট্রিং পায়।
  • @DBRef দিয়ে যুক্ত ক্লাস ইনপুটের অংশ হলে nested অবজেক্ট হয়।
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties আর উত্তরাধিকার সূত্রে পাওয়া ফিল্ড JPA পেজের মতোই একই নিয়ম মানে।

ব্যবহারের ক্ষেত্র

অনেক embedded ডকুমেন্টসহ response

রিভিউয়ের তালিকা, অপশনের map আর ইতিহাসের array-এর মতো যে গঠন MongoDB একটি ডকুমেন্টে ভরে রাখে, তা থেকে দীর্ঘ response উদাহরণ তৈরি হয়। ক্লাসগুলো পেস্ট করলে প্রতিটি nested স্তর আপনার জন্য লেখা হয়ে যায়।

সংরক্ষিত আর ফেরত দেওয়া আকৃতির তুলনা

@Field দিয়ে ছোট নাম বা _id-এ ম্যাপ করা ফিল্ডের কারণে ডাটাবেসের key API-এর key থেকে আলাদা হয়। আউটপুট API-এর দিকটি দেখায়, তাই দুটো পাশাপাশি রাখা যায়।

নোট ও সীমাবদ্ধতা

  • @Field("..."), @Indexed আর @TextIndexed-এর মতো ম্যাপিং annotation JSON key বদলায় না এবং প্রতিফলিত হয় না।
  • @Id String id _id হিসেবে সংরক্ষিত হয় কিন্তু Jackson থেকে বের হয় id হিসেবে, আউটপুটও সেটাই দেখায়।
  • Spring Boot-এর ডিফল্ট Jackson org.bson.types.ObjectId-কে hex স্ট্রিং হিসেবে নয়, timestamp আর date-সহ একটি অবজেক্ট হিসেবে লেখে। এখানে দেখানো স্ট্রিং রূপে পাঠাতে একটি ToStringSerializer রেজিস্টার করুন বা String id ব্যবহার করুন।
  • ইনপুটে নেই এমন ক্লাস, GeoJsonPoint-এর মতো Spring Data type-সহ, null হয়।

সাধারণ প্রশ্ন

আমার @Id কি ObjectId হবে নাকি String?

String হলে Spring Data সেভ করার সময় এটিকে ObjectId-তে কনভার্ট করে এবং API একটি পরিষ্কার hex স্ট্রিং ফেরত দেয়। ObjectId type রাখলে response-এর জন্য বাড়তি Jackson কনফিগারেশন লাগে।

@DBRef ফিল্ড কি সত্যিই nested অবজেক্ট হিসেবে ফেরত আসে?

@DBRef পড়ার সময় (lazy হলে প্রথম অ্যাক্সেসে) reference করা ডকুমেন্ট resolve করে, তাই response-এ nested অবজেক্ট থাকে। শুধু ObjectId বা String id রাখা manual reference শুধু id-টিই ফেরত দেয়।

মুক্ত-রূপের Map<String, Object> ফিল্ড দেখতে কেমন হয়?

এর value type অজানা, তাই এটি {"key": null} হয়। ডকুমেন্টেশনে দেওয়ার আগে আপনি আসলে যে ধরনের ভ্যালু রাখেন তা দিয়ে বদলে দিন।