Chuyển lớp document MongoDB thành JSON!

Nhập lớp document MongoDB để tạo JSON mẫu! Hỗ trợ Spring Data MongoDB @Document. Hữu ích cho tài liệu API và request body thử nghiệm (mock request body).
Spring Data MongoDB
Kết quả
 

Chuyển lớp document MongoDB thành JSON!

Đưa vào một class @Document của Spring Data MongoDB cùng các class và record nhúng của nó, công cụ dựng JSON ví dụ cho những gì controller trả về khi gửi document đó. Hình dạng theo cách serialize Jackson mặc định của Spring Boot, nên nó mô tả response của API, không phải BSON được lưu trong MongoDB.

Nó tiết kiệm thời gian với các document MongoDB đầy list nhúng, field Map và timestamp Instant, nơi viết tay mẫu response rất mệt, đồng thời làm lộ rõ khoảng cách giữa định dạng lưu trữ và định dạng response.

Cách sử dụng

  1. Dán class @Document cùng các class hoặc record nhúng của nó vào ô Spring Data MongoDB.
  2. Class document không bị class nào khác tham chiếu sẽ thành gốc của output.
  3. Thay các giá trị giữ chỗ của id và ngày tháng bằng giá trị thực tế trước khi dùng JSON trong tài liệu hay test.

Ví dụ

Đầu vào (Java · Spring Data MongoDB)
@Document(collection = "devices")
public class Device {
    @Id
    private String id;
    private String serial;
    @Field("fw")
    private String firmwareVersion;
    private Map<String, Double> lastReadings;
    private List<Alert> alerts;
    private Instant registeredAt;
}

record Alert(String level, String message, Instant raisedAt) {}
Đầu ra (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Alert trong List<Alert> là record, nên các component level, message và raisedAt của nó thành field. Map<String, Double> thành {"key": 0}, và Instant là chuỗi UTC kết thúc bằng Z. @Field("fw") chỉ đổi tên field lưu trong MongoDB, nên key JSON vẫn là firmwareVersion.

Tính năng hỗ trợ

  • Component của Java record, như trong record Alert(String level, ...), được đọc làm field.
  • List và Set thành mảng một phần tử; Map<String, T> thành {"key": value}.
  • Instant, ZonedDateTime và OffsetDateTime cho 1970-01-01T00:00:00Z, còn LocalDateTime cho chuỗi không có offset.
  • Field có kiểu ObjectId nhận chuỗi ObjectId hex mẫu.
  • Class liên kết bằng @DBRef thành object lồng nhau khi chúng có trong đầu vào.
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties và field kế thừa theo cùng quy tắc với trang JPA.

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

Response có nhiều document nhúng

Những cấu trúc mà MongoDB gói vào một document, như danh sách review, map option và mảng lịch sử, tạo ra ví dụ response rất dài. Dán các class vào là mọi cấp lồng nhau được viết ra giúp bạn.

So sánh hình dạng lưu trữ và hình dạng trả về

Tên rút gọn qua @Field hay field ánh xạ sang _id làm key trong database khác key của API. Output cho thấy phía API, để bạn đặt hai bên cạnh nhau.

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

  • Annotation ánh xạ như @Field("..."), @Indexed và @TextIndexed không đổi key JSON nên không được phản ánh.
  • @Id String id được lưu thành _id nhưng khi ra khỏi Jackson là id, và output hiển thị đúng như vậy.
  • Jackson mặc định của Spring Boot ghi org.bson.types.ObjectId thành object có timestamp và date, không phải chuỗi hex. Để gửi dạng chuỗi như hiển thị ở đây, hãy đăng ký ToStringSerializer hoặc dùng id kiểu String.
  • Class không có trong đầu vào, kể cả kiểu của Spring Data như GeoJsonPoint, thành null.

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

@Id nên là ObjectId hay String?

Với String, Spring Data chuyển nó thành ObjectId khi lưu và API trả về chuỗi hex gọn gàng. Giữ kiểu ObjectId nghĩa là bạn cần cấu hình Jackson thêm cho response.

Field @DBRef có thật sự trả về dạng object lồng nhau không?

@DBRef phân giải document được tham chiếu khi đọc (lần truy cập đầu tiên nếu là lazy), nên response chứa object lồng nhau. Tham chiếu thủ công chỉ lưu id ObjectId hoặc String thì chỉ trả về id.

Field Map<String, Object> tự do trông như thế nào?

Kiểu giá trị của nó không xác định nên thành {"key": null}. Hãy thay bằng loại giá trị bạn thực sự lưu trước khi đưa vào tài liệu.