اسے Java DTO، POJO یا record کا source دیں اور وہ JSON حاصل کریں جو Spring Boot کا ڈیفالٹ Jackson سیٹ اپ غالباً بنائے گا۔ keys ڈکلیئر کیے گئے فیلڈز سے آتی ہیں، اور @JsonProperty، @JsonIgnore، @JsonIgnoreProperties اور static/transient والی exclusions لاگو ہوتی ہیں۔
اسے controller کے request یا response DTO سے Swagger example یا فرنٹ اینڈ کے لیے نمونہ payload بنانے کے لیے، یا بس یہ دیکھنے کے لیے استعمال کریں کہ Lombok @Data کلاس کون سی keys نکالے گی۔
static class، record اور enum declarations اسی ان پٹ میں شامل کریں تاکہ ان کا حوالہ دینے والے فیلڈز ان کے ڈھانچے سے بھرے جائیں۔روٹ ٹائپ کو خودکار پر رکھنے سے وہ کلاس چنی جاتی ہے جسے کوئی دوسری کلاس فیلڈ type کے طور پر استعمال نہیں کرتی۔ جب entities ایک دوسرے کا حوالہ دیں تو فہرست سے اپنی مطلوبہ کلاس چنیں۔@Schema(example = ...)، REST Docs snippet یا MockMvc request body میں کاپی کریں۔@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) {}
}{
"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 کے پہلے constant کے بجائے "SILVER" ہے۔ nested record Address پھیل کر objects کی array بن جاتا ہے۔
@JsonProperty("x") یا @JsonProperty(value = "x") override کرتا ہے۔@JsonIgnore فیلڈز، کلاس کی سطح کے @JsonIgnoreProperties({...}) میں درج keys، اور static یا transient فیلڈز۔record components، nested static class declarations اور extends سے وراثت میں ملے فیلڈز (پہلے parent فیلڈز) سپورٹ ہیں۔@JsonProperty("x") اس string کو x بنا دیتا ہے۔LocalDateTime → 1970-01-01T00:00:00، LocalDate → 1970-01-01، Instant/OffsetDateTime/ZonedDateTime → Z پر ختم ہونے والی ISO string، java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00۔BigDecimal اور Long جیسے عددی wrappers بنتے ہیں 0، Optional<T> کھل کر T بنتا ہے، byte[] بنتا ہے Base64 string، اور UUID اور MongoDB ObjectId کو درست شکل والی values ملتی ہیں۔List، Set اور arrays کو ایک نمونہ element ملتا ہے؛ Map<Long, V> جیسا عددی key والا map "0" استعمال کرتا ہے، ورنہ "key"۔ہاتھ سے لکھی example values، DTO میں ہر نیا فیلڈ شامل ہونے پر پیچھے رہ جاتی ہیں۔ DTO source سے JSON بنائیں اور وہیں سے values نکھاریں، تاکہ کوئی key غائب یا غلط ہجے والی نہ ہو۔
@RequestBody DTO سے سیدھا request JSON بنائیں اور اسے اپنے ٹیسٹ میں text block (""") میں پیسٹ کریں۔ @JsonProperty سے نام بدلی گئی keys پہلے سے لاگو ہیں، جو اصل binding سے میل کھاتی ہیں۔
بیک اینڈ کوڈ نہ پڑھنے والے فرنٹ اینڈ ڈویلپرز کو Java کلاس کی تشریح کرنے کے بجائے endpoint کا JSON ڈھانچہ براہ راست مل جاتا ہے۔
= "guest"، = 100، = true) یا enum constant (= Grade.SILVER) ہوں؛ new ArrayList<>() یا method call جیسی کوئی اور چیز ہو تو type کا placeholder آتا ہے۔getFullName() یا boolean isVip()، Jackson کی طرح properties کے طور پر شامل ہوتے ہیں، اور اس getter پر @JsonIgnore/@JsonProperty کا لحاظ رکھا جاتا ہے۔ اس کے برعکس، getter کے بغیر private فیلڈ کو نظر آنے والا مانا جاتا ہے (جیسے Lombok @Getter/@Data کے ساتھ)۔@JsonNaming(SnakeCaseStrategy.class)، spring.jackson.property-naming-strategy) اور @JsonFormat کے تاریخی patterns لاگو نہیں ہوتے۔@JsonValue methods evaluate نہیں ہوتے، اس لیے ایسے enums بھی constant (یا اس کا @JsonProperty نام) ہی دکھاتے ہیں۔Page<T>/Slice<T> فیلڈز سادہ کر کے elements کی array بنا دیے جاتے ہیں؛ اصل Page serialization، content، pageable وغیرہ والا آبجیکٹ ہوتا ہے۔@Data یا @Getter بناتا ہو؟جی ہاں۔ keys ڈکلیئر کیے گئے فیلڈز سے بنتی ہیں، اس لیے compile کے وقت Lombok کے بنائے getters اور setters کا source میں ہونا ضروری نہیں۔
LocalDateTime نمبروں کی array کے بجائے string کیوں ہے؟Spring Boot، jackson-datatype-jsr310 رجسٹر کرتا ہے اور بطور ڈیفالٹ WRITE_DATES_AS_TIMESTAMPS بند کر دیتا ہے، جس سے ISO strings بنتی ہیں؛ نمونہ اسی ڈیفالٹ پر چلتا ہے۔ سادہ Jackson ObjectMapper اس کے بجائے [1970,1,1,0,0] جیسی array لکھ سکتا ہے۔
entities کا فیلڈ ڈھانچہ ایک جیسا ہوتا ہے، اس لیے وہ ٹھیک parse ہوتی ہیں۔ @OneToMany جیسی دو طرفہ associations چکر بناتیں، اس لیے انہیں ایک بار پھیلا کر null یا خالی array سے کاٹ دیا جاتا ہے۔ Spring Boot JPA → JSON کا الگ صفحہ بھی موجود ہے۔
@JsonIgnore کسی setter پر ہو یا کسی موجودہ فیلڈ کے getter پر؟فیلڈ declaration پر لگی annotations ہمیشہ لاگو ہوتی ہیں، اور getter پر لگی annotations صرف تب جب اس نام کا کوئی فیلڈ موجود نہ ہو۔ setter پر، یا ڈکلیئر کیے گئے فیلڈ کے getter پر لگا @JsonIgnore لاگو نہیں ہوتا، اس لیے اس کا اثر دیکھنے کے لیے اسے فیلڈ پر منتقل کریں۔