JSON কে Kotlin data class-এ রূপান্তর করুন!

JSON দিন এবং nested object সহ Kotlin data class কোড তৈরি করুন! kotlinx.serialization @Serializable, @SerialName, Jackson সমর্থিত।
JSON
ফলাফল
 

JSON কে Kotlin data class-এ রূপান্তর করুন!

একটি API response বা config JSON পেস্ট করুন এবং তার গঠন হুবহু প্রতিফলিত করে এমন Kotlin data class কোড পান। Nested অবজেক্ট আর অবজেক্টের array প্রতিটিই নিজস্ব ক্লাস হয়, আর আপনি kotlinx.serialization বা Jackson যেকোনোটি বেছে নিতে পারেন।

Android অ্যাপ বা Ktor/Spring সার্ভিসে কোনো এক্সটার্নাল API যুক্ত করার সময়, টাইপ না করে একটি নমুনা response থেকেই মডেলের কাঠামো পেতে চাইলে এটি তৈরি। কনভার্শন পুরোটাই আপনার ব্রাউজারে চলে, তাই কোনো ইন্টারনাল API response পেস্ট করলেও তা কোথাও পাঠানো হয় না।

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

  1. ইনপুট বক্সে JSON পেস্ট করুন। ছাঁটাই করা অংশের চেয়ে সম্পূর্ণ আসল response দিলে type অনুমান ভালো হয়।
  2. টাইপের নাম-এ top-level ক্লাসের নাম দিন (ডিফল্ট Root), যেমন UserResponse।
  3. সিরিয়ালাইজার-এ kotlinx.serialization বা Jackson বেছে নিন, আপনার প্রজেক্ট আগে থেকে যেটি ব্যবহার করে সেটি।
  4. জেনারেট হওয়া কোড আপনার মডেল ফাইলে কপি করুন। Type-এর নাম আর সিরিয়ালাইজার URL-এ থাকে, তাই বুকমার্ক খুললে একই সেটআপ আবার পাওয়া যায়।

উদাহরণ

ইনপুট (JSON)
{
  "orderId": "A-1024",
  "paid": true,
  "total": 39.9,
  "coupon": null,
  "items": [
    { "sku": "TSHIRT-M", "qty": 2 },
    { "sku": "CAP", "qty": 1, "gift_wrap": true }
  ]
}
আউটপুট (Kotlin · kotlinx.serialization)
import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.json.JsonElement

@Serializable
data class Order(
    val orderId: String,
    val paid: Boolean,
    val total: Double,
    val coupon: JsonElement? = null,
    val items: List<Item>
)

@Serializable
data class Item(
    val sku: String,
    val qty: Int,
    @SerialName("gift_wrap") val giftWrap: Boolean? = null
)

items array-এর ভেতরের অবজেক্টগুলো একবচনের Item ক্লাস হয়, আর শুধু দ্বিতীয় আইটেমে থাকা gift_wrap হয় Boolean? = null। coupon সবসময় শুধু null, তাই এর type অনুমান করা যায় না এবং আপনি আসল type দিয়ে বদলানোর জন্য এটিকে JsonElement? হিসেবে রেখে দেওয়া হয়।

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

  • kotlinx.serialization: প্রতিটি ক্লাসে @Serializable, নাম বদলানো ফিল্ডে @SerialName, সাথে দরকারি import।
  • Jackson: শুধু নাম বদলানো ফিল্ডে @JsonProperty।
  • user_name বা home-url-এর মতো key camelCase প্রপার্টি (userName, homeUrl) হয়, annotation দিয়ে মূল key-এর সাথে ম্যাপ থাকে।
  • class বা val-এর মতো Kotlin keyword backtick-এ মোড়ানো হয়; সংখ্যা দিয়ে শুরু হওয়া key n prefix পায়।
  • সংখ্যা: integer হয় Int, 32-বিটের বেশি ভ্যালু হয় Long, আর কোনো দশমিক থাকলে ফিল্ডটি হয় Double।
  • অবজেক্টের array সব আইটেম থেকে একটি ক্লাসে একত্রিত হয়; শুধু কিছু আইটেমে থাকা ফিল্ড হয় ? = null।
  • Top-level array বা primitive থেকে একটি typealias তৈরি হয়, যেমন typealias Root = List<RootItem>।

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

Retrofit বা Ktor ক্লায়েন্টের response মডেল

Postman বা ব্রাউজার DevTools থেকে কপি করা একটি response পেস্ট করুন, Call<Order> বা client.get<Order>()-এর জন্য প্রস্তুত ক্লাস পাবেন। কয়েক ডজন ফিল্ডের response-এ এটি হাতে কপি করার টাইপো আর ভুল type এড়ায়।

snake_case API-কে Kotlin নামকরণে ম্যাপ করা

ব্যাকএন্ড created_at পাঠালে Kotlin-এর দিকে পড়া হয় createdAt, আর serial name মূল key রেখে দেয়। গ্লোবাল naming strategy-র উপর নির্ভর না করে ম্যাপিংটি প্রতিটি ক্লাসে দৃশ্যমান থাকে।

kotlinx.serialization-এ মাইগ্রেশন

Gson বা Jackson মডেল kotlinx.serialization-এ সরালে একই JSON থেকে দুটি আউটপুটই তৈরি করে ঠিক কোন annotation বদলায় তা দেখুন।

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

  • Type অনুমান হয় শুধু আপনার পেস্ট করা নমুনা থেকে। প্রতিটি নমুনা আইটেমে থাকা ফিল্ড non-null হিসেবে আসে, তাই API ডকুমেন্টেশন অনুযায়ী বাদ পড়তে পারে এমন ফিল্ডে নিজে ? যোগ করুন।
  • 2024-01-01T00:00:00Z-এর মতো তারিখের স্ট্রিং String থাকে; Instant-এ বদলাতে নিজের serializer লাগে।
  • kotlinx.serialization Any serialize করতে পারে না, তাই অনুমানযোগ্য type নেই এমন ভ্যালু সেখানে হয় JsonElement আর Jackson-এ Any।
  • কোনো enum, sealed class বা default value (যেমন ফাঁকা তালিকা) তৈরি হয় না। নির্দিষ্ট কিছু ভ্যালুর ফিল্ড পরে enum-এ বদলে নেওয়া ভালো।
  • সব ক্লাস একটি ব্লকে আসে; package ডিক্লারেশন আর ফাইলে ভাগ করা আপনার কাজ।

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

ফিল্ড কেন শুধু String? না হয়ে String? = null?

Key অনুপস্থিত থাকলে আর প্রপার্টির default না থাকলে kotlinx.serialization MissingFieldException ছোড়ে। কিছু আইটেমে না থাকা বা null থাকা ফিল্ডে = null যোগ করলে সেই key ছাড়া response-ও ঠিকঠাক decode হয়।

@SerialName ছাড়া JSON key-কেই কি প্রপার্টির নাম হিসেবে রাখা যায়?

টুলটি সবসময় camelCase-এ কনভার্ট করে এবং নাম আলাদা হলেই শুধু annotation যোগ করে, তাই আগে থেকেই camelCase key-গুলো annotation ছাড়া আসে। snake_case নাম রাখতে চাইলে জেনারেট করার পর প্রপার্টির নাম বদলে annotation-গুলো সরিয়ে দিন।

Jackson বেছে নিলে কি jackson-module-kotlin লাগে?

হ্যাঁ। জেনারেট হওয়া data class-এ no-arg constructor নেই, তাই constructor parameter দিয়ে ভ্যালু bind করতে Jackson-এর jackson-module-kotlin রেজিস্টার করা থাকতে হবে (dependency থাকলে Spring Boot এটি স্বয়ংক্রিয়ভাবে রেজিস্টার করে)।

এটি কি Moshi বা Gson মডেল তৈরি করতে পারে?

সিরিয়ালাইজারের অপশন হলো kotlinx.serialization আর Jackson। Gson-এর জন্য Jackson আউটপুট নিয়ে @JsonProperty-কে @SerializedName দিয়ে বদলান; Moshi-র জন্য @Json(name = ...) ব্যবহার করুন। ক্লাসের গঠন একই থাকে।