Chuyển class Java sang JSON!

Dán mã Java (class·record) để nhận JSON mẫu! Hỗ trợ Jackson @JsonProperty, @JsonIgnore, Lombok. Hữu ích cho tài liệu API và request body thử nghiệm (mock request body).
Java
Kết quả
 

Chuyển class Java sang JSON!

Đưa vào mã nguồn DTO, POJO hoặc record của Java để nhận JSON mà cấu hình Jackson mặc định của Spring Boot nhiều khả năng sẽ tạo ra. Key lấy từ các field đã khai báo, có áp dụng @JsonProperty, @JsonIgnore, @JsonIgnoreProperties và việc loại trừ static/transient.

Dùng nó để tạo example cho Swagger hoặc payload mẫu cho frontend từ DTO request hay response của controller, hoặc đơn giản để kiểm tra một class Lombok @Data sẽ xuất ra những key nào.

Cách sử dụng

  1. Dán nguyên mã nguồn DTO. Import, annotation Lombok, constructor và method có thể để lại.
  2. Đưa các khai báo static class, record và enum lồng nhau vào cùng đầu vào để field tham chiếu tới chúng được điền đúng cấu trúc.
  3. Khi Kiểu gốc để Tự động, class không được class nào khác dùng làm kiểu field sẽ được chọn. Khi các entity tham chiếu lẫn nhau, hãy chọn cái bạn muốn trong danh sách.
  4. Sao chép output vào @Schema(example = ...), snippet của REST Docs hoặc body request của MockMvc.

Ví dụ

Đầu vào (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) {}
}
Đầu ra (JSON)
{
  "memberId": 0,
  "nick_name": "",
  "grade": "SILVER",
  "birthDate": "1970-01-01",
  "addresses": [
    {
      "zipCode": "",
      "city": "",
      "primary": false
    }
  ]
}

password bị loại bởi @JsonIgnoreProperties({"password"}) ở cấp class, còn serialVersionUID static final không bao giờ xuất hiện. Initializer Grade.SILVER được đọc, nên grade là "SILVER" chứ không phải hằng đầu tiên của enum. record Address lồng bên trong được mở rộng thành mảng object.

Tính năng hỗ trợ

  • Tên field thành key, bị ghi đè bởi @JsonProperty("x") hoặc @JsonProperty(value = "x").
  • Bị loại: field có @JsonIgnore, các key liệt kê trong @JsonIgnoreProperties({...}) cấp class, và field static hoặc transient.
  • Hỗ trợ component của record Java 16+, khai báo static class lồng nhau và field kế thừa qua extends (field của class cha đứng trước).
  • Field enum giữ hằng đầu tiên dưới dạng chuỗi, hoặc hằng được nêu trong initializer của field; @JsonProperty("x") trên một hằng đổi chuỗi thành x.
  • Ngày giờ theo output Jackson mặc định của Spring Boot: LocalDateTime → 1970-01-01T00:00:00, LocalDate → 1970-01-01, Instant/OffsetDateTime/ZonedDateTime → chuỗi ISO kết thúc bằng Z, java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00.
  • Wrapper số như BigDecimal và Long thành 0, Optional<T> được mở thành T, byte[] thành chuỗi Base64, còn UUID và ObjectId của MongoDB nhận giá trị đúng định dạng.
  • List, Set và mảng có một phần tử mẫu; map có key số như Map<Long, V> dùng "0", còn lại dùng "key".

Trường hợp sử dụng

Điền example cho springdoc / Swagger

Giá trị example viết tay bị lệch mỗi lần DTO có thêm field. Hãy tạo JSON từ mã nguồn DTO rồi chỉnh giá trị từ đó, để không key nào bị thiếu hay viết sai.

Body request cho test MockMvc hoặc RestAssured

Tạo JSON request thẳng từ DTO @RequestBody rồi dán vào text block (""") trong test. Key đổi tên bằng @JsonProperty đã được áp dụng, khớp với binding thật.

Chia sẻ hình dạng response với frontend

Lập trình viên frontend không đọc code backend vẫn nhận được trực tiếp cấu trúc JSON của endpoint, thay vì phải tự diễn giải một class Java.

Lưu ý và giới hạn

  • Initializer của field được dùng khi là literal (= "guest", = 100, = true) hoặc hằng enum (= Grade.SILVER); những thứ khác, như new ArrayList<>() hay lời gọi method, quay về giá trị giữ chỗ của kiểu.
  • Getter không có field tương ứng, như getFullName() hay boolean isVip(), được thêm vào làm property theo cách Jackson làm, có tôn trọng @JsonIgnore/@JsonProperty trên getter đó. Ngược lại, field private không có getter vẫn được coi là hiển thị (như với Lombok @Getter/@Data).
  • Quy tắc đặt tên toàn cục (@JsonNaming(SnakeCaseStrategy.class), spring.jackson.property-naming-strategy) và pattern ngày giờ của @JsonFormat không được áp dụng.
  • Method @JsonValue trên enum không được thực thi, nên các enum đó vẫn hiện hằng (hoặc tên @JsonProperty của nó).
  • Field Page<T>/Slice<T> của Spring Data được đơn giản hóa thành mảng phần tử; khi serialize thật, Page là object có content, pageable và nhiều thứ khác.

Câu hỏi thường gặp

Có chạy được khi Lombok @Data hay @Getter sinh accessor không?

Có. Key được dựng từ field đã khai báo, nên getter và setter mà Lombok sinh lúc compile không cần có trong mã nguồn.

Vì sao LocalDateTime là chuỗi chứ không phải mảng số?

Spring Boot đăng ký jackson-datatype-jsr310 và mặc định tắt WRITE_DATES_AS_TIMESTAMPS, cho ra chuỗi ISO; mẫu theo mặc định đó. Một ObjectMapper Jackson trần có thể ghi thành mảng như [1970,1,1,0,0].

Có dán entity JPA được không?

Entity có cùng cấu trúc field nên parse bình thường. Quan hệ hai chiều như @OneToMany sẽ lặp vô hạn, nên chúng được mở rộng một lần rồi cắt bằng null hoặc mảng rỗng. Ngoài ra còn có trang riêng Spring Boot JPA → JSON.

Nếu @JsonIgnore nằm trên setter hoặc trên getter của một field có sẵn thì sao?

Annotation trên khai báo field luôn được áp dụng, còn annotation trên getter chỉ áp dụng khi không có field cùng tên. @JsonIgnore trên setter, hoặc trên getter của field đã khai báo, không được áp dụng, nên hãy chuyển nó lên field để thấy tác dụng.