Java ক্লাসকে JSON-এ রূপান্তর করুন!

Java (class·record) কোড দিন এবং উদাহরণ JSON পান! Jackson @JsonProperty, @JsonIgnore, Lombok সমর্থিত। API ডকুমেন্টেশন ও টেস্ট request body (sample JSON)-এর জন্য উপযোগী।
Java
ফলাফল
 

Java ক্লাসকে JSON-এ রূপান্তর করুন!

Java DTO, POJO বা record-এর সোর্স দিন এবং Spring Boot-এর ডিফল্ট Jackson সেটআপ সম্ভবত যে JSON তৈরি করত তা পান। Key আসে ডিক্লেয়ার করা ফিল্ড থেকে, @JsonProperty, @JsonIgnore, @JsonIgnoreProperties আর static/transient বাদ দেওয়ার নিয়ম প্রয়োগ করে।

কোনো controller-এর request বা response DTO থেকে Swagger উদাহরণ বা ফ্রন্টএন্ডের জন্য নমুনা payload তৈরি করতে, অথবা শুধু Lombok @Data ক্লাস কোন key-গুলো বের করবে তা দেখতে এটি ব্যবহার করুন।

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

  1. DTO-র সোর্স যেমন আছে তেমনই পেস্ট করুন। Import, Lombok annotation, constructor আর মেথড থেকে গেলেও সমস্যা নেই।
  2. Nested static class, record আর enum ডিক্লারেশন একই ইনপুটে দিন, যাতে সেগুলো reference করা ফিল্ড তাদের গঠন দিয়ে পূরণ হয়।
  3. রুট টাইপ স্বয়ংক্রিয়-এ থাকলে এমন ক্লাস বেছে নেওয়া হয় যাকে অন্য কোনো ক্লাস ফিল্ডের type হিসেবে ব্যবহার করে না। Entity-গুলো একে অপরকে reference করলে তালিকা থেকে যেটি চান সেটি বেছে নিন।
  4. আউটপুটটি @Schema(example = ...), REST Docs snippet বা MockMvc request body-তে কপি করুন।

উদাহরণ

ইনপুট (Java)
@Data
@JsonIgnoreProperties({"password"})
public class MemberResponse {
    private Long memberId;
    @JsonProperty("nick_name")
    private String nickname;
    private String password;
    private Grade grade = Grade.SILVER;
    private LocalDate birthDate;
    private List<Address> addresses;
    private static final long serialVersionUID = 1L;

    public enum Grade { BRONZE, SILVER, GOLD }

    public record Address(String zipCode, String city, boolean primary) {}
}
আউটপুট (JSON)
{
  "memberId": 0,
  "nick_name": "",
  "grade": "SILVER",
  "birthDate": "1970-01-01",
  "addresses": [
    {
      "zipCode": "",
      "city": "",
      "primary": false
    }
  ]
}

ক্লাস-স্তরের @JsonIgnoreProperties({"password"}) password সরিয়ে দেয়, আর static final serialVersionUID কখনো দেখা যায় না। Initializer Grade.SILVER পড়া হয়, তাই grade enum-এর প্রথম কনস্ট্যান্ট না হয়ে "SILVER"। Nested record Address অবজেক্টের একটি array-তে প্রসারিত হয়।

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

  • ফিল্ডের নাম key হয়, যা @JsonProperty("x") বা @JsonProperty(value = "x") দিয়ে override হয়।
  • বাদ যায়: @JsonIgnore ফিল্ড, ক্লাস-স্তরের @JsonIgnoreProperties({...})-এ তালিকাভুক্ত key, আর static বা transient ফিল্ড।
  • Java 16+-এর record component, nested static class ডিক্লারেশন আর extends দিয়ে উত্তরাধিকার সূত্রে পাওয়া ফিল্ড (parent-এর ফিল্ড আগে) সাপোর্ট করে।
  • Enum ফিল্ডে প্রথম কনস্ট্যান্ট স্ট্রিং হিসেবে থাকে, বা ফিল্ড initializer-এ নাম দেওয়া কনস্ট্যান্ট; কনস্ট্যান্টে @JsonProperty("x") থাকলে স্ট্রিংটি x হয়।
  • তারিখ Spring Boot-এর ডিফল্ট Jackson আউটপুট মানে: LocalDateTime → 1970-01-01T00:00:00, LocalDate → 1970-01-01, Instant/OffsetDateTime/ZonedDateTime → Z দিয়ে শেষ হওয়া ISO স্ট্রিং, java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00।
  • BigDecimal আর Long-এর মতো সংখ্যার wrapper হয় 0, Optional<T> খুলে T হয়, byte[] হয় Base64 স্ট্রিং, আর UUID ও MongoDB ObjectId সঠিক ফরম্যাটের ভ্যালু পায়।
  • List, Set আর array একটি নমুনা element পায়; Map<Long, V>-এর মতো সংখ্যার key-যুক্ত map "0" ব্যবহার করে, অন্যথায় "key"।

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

springdoc / Swagger-এর উদাহরণ পূরণ করা

DTO-তে ফিল্ড যোগ হলেই হাতে লেখা example ভ্যালু পিছিয়ে পড়ে। DTO-র সোর্স থেকে JSON তৈরি করে সেখান থেকে ভ্যালুগুলো ঘষামাজা করুন, তাহলে কোনো key বাদ পড়বে না বা ভুল বানানে থাকবে না।

MockMvc বা RestAssured টেস্টের request body

@RequestBody DTO থেকে সরাসরি request JSON তৈরি করে আপনার টেস্টের text block (""")-এ পেস্ট করুন। @JsonProperty দিয়ে নাম বদলানো key আগে থেকেই প্রয়োগ করা থাকে, যা আসল binding-এর সাথে মেলে।

ফ্রন্টএন্ডের সাথে response-এর আকৃতি শেয়ার করা

যে ফ্রন্টএন্ড ডেভেলপাররা ব্যাকএন্ড কোড পড়েন না, তাঁরা Java ক্লাস ব্যাখ্যা না করেই endpoint-এর JSON গঠন সরাসরি পেয়ে যান।

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

  • ফিল্ড initializer ব্যবহৃত হয় যখন তা literal (= "guest", = 100, = true) বা enum কনস্ট্যান্ট (= Grade.SILVER); new ArrayList<>() বা মেথড কলের মতো অন্য কিছু হলে type-এর placeholder-এ ফিরে যায়।
  • মিলে যাওয়া ফিল্ড ছাড়া getter, যেমন getFullName() বা boolean isVip(), Jackson-এর মতোই প্রপার্টি হিসেবে যোগ হয়, সেই getter-এর @JsonIgnore/@JsonProperty মেনে। উল্টোভাবে, getter ছাড়া private ফিল্ডকে দৃশ্যমান ধরে নেওয়া হয় (Lombok @Getter/@Data-এর মতো)।
  • গ্লোবাল নামকরণের নিয়ম (@JsonNaming(SnakeCaseStrategy.class), spring.jackson.property-naming-strategy) আর @JsonFormat-এর তারিখ প্যাটার্ন প্রয়োগ হয় না।
  • Enum-এর @JsonValue মেথড মূল্যায়ন করা হয় না, তাই এমন enum তবুও কনস্ট্যান্ট (বা তার @JsonProperty নাম) দেখায়।
  • Spring Data Page<T>/Slice<T> ফিল্ড element-এর array-তে সরলীকৃত হয়; আসল Page serialization হলো content, pageable ইত্যাদিসহ একটি অবজেক্ট।

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

Lombok @Data বা @Getter accessor তৈরি করলে কি কাজ করে?

হ্যাঁ। Key তৈরি হয় ডিক্লেয়ার করা ফিল্ড থেকে, তাই Lombok কম্পাইলের সময় যে getter আর setter তৈরি করে সেগুলো সোর্সে থাকার দরকার নেই।

LocalDateTime কেন সংখ্যার array না হয়ে স্ট্রিং?

Spring Boot ডিফল্টভাবে jackson-datatype-jsr310 রেজিস্টার করে এবং WRITE_DATES_AS_TIMESTAMPS বন্ধ রাখে, ফলে ISO স্ট্রিং আসে; নমুনা সেই ডিফল্টই মানে। শুধু Jackson-এর ObjectMapper হলে এর বদলে [1970,1,1,0,0]-এর মতো array লিখতে পারে।

JPA entity কি পেস্ট করা যায়?

Entity-র ফিল্ডের গঠন একই, তাই ঠিকঠাক parse হয়। @OneToMany-এর মতো দ্বিমুখী association লুপে পড়ত, তাই সেগুলো একবার প্রসারিত করে null বা ফাঁকা array দিয়ে কেটে দেওয়া হয়। এর জন্য আলাদা Spring Boot JPA → JSON পেজও আছে।

@JsonIgnore setter-এ বা বিদ্যমান ফিল্ডের getter-এ থাকলে কী হয়?

ফিল্ড ডিক্লারেশনের annotation সবসময় প্রযোজ্য, আর getter-এর annotation প্রযোজ্য শুধু যখন সেই নামের কোনো ফিল্ড নেই। Setter-এ, বা ডিক্লেয়ার করা ফিল্ডের getter-এ থাকা @JsonIgnore প্রয়োগ হয় না, তাই এর প্রভাব দেখতে এটি ফিল্ডে সরিয়ে নিন।