JPA এন্টিটি কে JSON-এ রূপান্তর করুন!

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

JPA এন্টিটি কে JSON-এ রূপান্তর করুন!

Spring Boot JPA-র @Entity ক্লাস পেস্ট করুন এবং কোনো controller সেই entity ফেরত দিলে Jackson যে আকৃতিতে JSON তৈরি করে সেই আকৃতির উদাহরণ দেখুন। ফিল্ডের নাম, @JsonIgnore আর @JsonProperty, @MappedSuperclass থেকে উত্তরাধিকার সূত্রে পাওয়া ফিল্ড, আর Java 8-এর তারিখের type সবই Spring Boot-এর ডিফল্ট Jackson সেটআপ অনুযায়ী হ্যান্ডেল করা হয়।

REST Docs বা Swagger উদাহরণ, Postman request body-র জন্য, অথবা DTO ছাড়া entity এক্সপোজ করলে কোন ফিল্ডগুলো বাইরে চলে যায় তা যাচাই করতে এটি ব্যবহার করুন।

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

  1. JPA বক্সে entity ক্লাস পেস্ট করুন। Import আর Lombok annotation থাকতে পারে; parent ক্লাস, সম্পর্কিত entity আর enum-ও দিন, যাতে সেগুলোর ভ্যালু পূরণ হয়।
  2. যে ক্লাসকে অন্য কোনো ক্লাস reference করে না সেটি রুট হয়। Entity-গুলো একে অপরকে reference করলে public ক্লাসটি বেছে নেওয়া হয়।
  3. ফলাফলটি আপনার টেস্ট বা ডকুমেন্টেশনে কপি করুন।

উদাহরণ

ইনপুট (Java · JPA)
@MappedSuperclass
public abstract class BaseEntity {
    @Id @GeneratedValue
    private Long id;
    private LocalDateTime createdAt;
}

@Entity
public class Appointment extends BaseEntity {
    private LocalDate visitDate;
    private BigDecimal fee;
    @Enumerated(EnumType.STRING)
    private Status status;
    @ManyToOne(fetch = FetchType.LAZY)
    private Patient patient;

    public enum Status { BOOKED, DONE, CANCELED }
}

@Entity
class Patient extends BaseEntity {
    private String name;
    @JsonIgnore
    private String residentNumber;
    @OneToMany(mappedBy = "patient")
    private List<Appointment> appointments;
}
আউটপুট (JSON)
{
  "id": 0,
  "createdAt": "1970-01-01T00:00:00",
  "visitDate": "1970-01-01",
  "fee": 0,
  "status": "BOOKED",
  "patient": {
    "id": 0,
    "createdAt": "1970-01-01T00:00:00",
    "name": "",
    "appointments": []
  }
}

Appointment আর Patient একে অপরকে reference করে, তাই public ক্লাস Appointment রুট, আর Patient.appointments অসীম লুপে না গিয়ে একটি ফাঁকা array-তে কেটে দেওয়া হয়। BaseEntity-র id আর createdAt আগে আসে, আর @JsonIgnore-এর কারণে residentNumber নেই। LocalDateTime offset ছাড়া ISO স্ট্রিং, আর enum তার প্রথম কনস্ট্যান্ট "BOOKED" দেখায়।

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

  • static আর transient ফিল্ড এবং @JsonIgnore ফিল্ড এড়িয়ে যাওয়া হয়, ক্লাস-স্তরের @JsonIgnoreProperties({"..."})-এ তালিকাভুক্ত নামগুলোও।
  • @JsonProperty("doctor_name") JSON key-এর নাম বদলায়।
  • Parent ক্লাস (@MappedSuperclass বা যেকোনো extends) ইনপুটে থাকলে তার ফিল্ডগুলো আগে আসে।
  • private Status status = Status.ACTIVE; বা private int visits = 0;-এর মতো entity default সেই ভ্যালু হিসেবেই দেখায়, আর backing ফিল্ড ছাড়া computed getter (public int getAge()) বাড়তি key হিসেবে আসে, ঠিক যেমন Jackson বের করত।
  • তারিখের আউটপুট Spring Boot-এর ডিফল্ট মানে: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00।
  • BigDecimal আর Long-এর মতো সংখ্যার wrapper দেয় 0, UUID দেয় পুরো শূন্যের UUID, আর byte[] দেয় base64 স্ট্রিং "AA=="।
  • List/Set দেয় এক element-এর array, Map<Long, String> দেয় মিলিয়ে key করা অবজেক্ট ({"0": ""}), আর Optional<T> খুলে ভেতরের ভ্যালু দেয়।
  • দ্বিমুখী association (@ManyToOne-সহ @OneToMany) যেখানে আবার ফিরে আসে সেখানে null বা ফাঁকা array দিয়ে কেটে দেওয়া হয়।

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

Spring REST Docs আর Swagger-এর উদাহরণ

Entity থেকে সরাসরি @Schema(example = ...) বা ডকুমেন্টেশন snippet-এর JSON তৈরি করুন, আর ফিল্ড বদলালেই আবার পেস্ট করে ডকুমেন্টেশন হালনাগাদ রাখুন।

এক্সপোজ করা entity যাচাই

DTO ছাড়া entity ফেরত দিলে পাসওয়ার্ড বা জাতীয় পরিচয়পত্র নম্বরের মতো ফিল্ড response-এ চলে যাচ্ছে কি না দেখুন। আউটপুটের ফিল্ডগুলোই Jackson serialize করত।

MockMvc-এর request body

mockMvc.perform(post("/appointments").content(...))-এর কাঠামো হিসেবে আউটপুট ব্যবহার করুন, ভ্যালু বসানোর আগে জেনারেট হওয়া id আর timestamp সরিয়ে দিন।

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

  • আসল Jackson দ্বিমুখী association-এ অসীমভাবে recursion করে (StackOverflowError)। আউটপুট কাটা মনে হলে বুঝবেন @JsonManagedReference/@JsonBackReference, @JsonIgnore বা DTO-র দরকার।
  • JPA-র @Transient annotation Jackson ডিফল্টভাবে উপেক্ষা করে না, তাই এমন ফিল্ড আউটপুটে থেকে যায়; শুধু Java-র transient keyword-যুক্ত ফিল্ড সরানো হয়।
  • বাস্তবে FetchType.LAZY association Hibernate proxy হিসেবে serialize হতে ব্যর্থ হতে পারে; আউটপুট ধরে নেয় সবকিছু লোড করা আছে।
  • যেসব ফিল্ডের ক্লাস ইনপুটে নেই সেগুলো null হিসেবে দেখায়, আর nullable বা length-এর মতো @Column constraint প্রয়োগ হয় না।

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

তারিখ কি সত্যিই [2024,1,1]-এর মতো array না হয়ে স্ট্রিং হবে?

Spring Boot WRITE_DATES_AS_TIMESTAMPS বন্ধ রাখে, তাই LocalDateTime ISO স্ট্রিং হিসেবে লেখা হয়। শুধু JavaTimeModule রেজিস্টার করা হাতে তৈরি ObjectMapper এর বদলে array লিখতে পারে।

Lombok @Getter ছাড়াও কি সব ফিল্ড দেখায়?

টুলটি ফিল্ড ডিক্লারেশন থেকে কাজ করে। আসল Jackson ডিফল্টভাবে getter (বা public ফিল্ড) দিয়ে serialize করে, তাই getter ছাড়া private ফিল্ড বাস্তবের response-এ নাও থাকতে পারে।

MongoDB-র @Document ক্লাসও কি পেস্ট করা যায়?

সেগুলোও একই Jackson নিয়ম মানে, তবে ObjectId আর @Field-এর মতো MongoDB-নির্দিষ্ট সতর্কতা Spring Data MongoDB থেকে JSON পেজে আলোচনা করা আছে।