I-convert ang mga MongoDB document class sa JSON!

Maglagay ng mga MongoDB document class para gumawa ng halimbawang JSON! Sinusuportahan ang Spring Data MongoDB @Document. Magagamit sa API docs at test request body (mock request body).
Spring Data MongoDB
Resulta
 

I-convert ang mga MongoDB document class sa JSON!

Bigyan ito ng isang Spring Data MongoDB @Document class kasama ang mga embedded class at record nito, at bubuo ito ng halimbawang JSON para sa ibinabalik ng isang controller kapag ipinapadala nito ang document na iyon. Sinusunod ng hugis ang default na Jackson serialization ng Spring Boot, kaya inilalarawan nito ang API response, hindi ang BSON na naka-store sa MongoDB.

Nakakatipid ito ng oras sa mga MongoDB document na puno ng embedded list, Map field at Instant timestamp, kung saan nakakapagod ang mano-manong pagsulat ng response sample, at nakikita nito ang agwat sa pagitan ng storage format at response format.

Paano gamitin

  1. I-paste sa Spring Data MongoDB box ang @Document class at ang mga embedded class o record nito.
  2. Ang document class na hindi nire-reference ng ibang class ang nagiging root ng output.
  3. Palitan ng makatotohanang value ang mga placeholder ng id at petsa bago gamitin ang JSON sa docs o test.

Halimbawa

Input (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) {}
Output (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Record ang Alert sa List<Alert>, kaya nagiging field ang mga component nitong level, message at raisedAt. Nagiging {"key": 0} ang Map<String, Double>, at UTC string na nagtatapos sa Z ang Instant. Pinapalitan lang ng @Field("fw") ang pangalan ng naka-store na field sa MongoDB, kaya nananatiling firmwareVersion ang JSON key.

Mga sinusuportahang feature

  • Binabasa bilang field ang mga component ng Java record, gaya ng sa record Alert(String level, ...).
  • Nagiging array na may isang element ang List at Set; nagiging {"key": value} ang Map<String, T>.
  • 1970-01-01T00:00:00Z ang ibinibigay ng Instant, ZonedDateTime at OffsetDateTime, habang string na walang offset ang ibinibigay ng LocalDateTime.
  • Nakakakuha ng sample na hex ObjectId string ang mga field na may type na ObjectId.
  • Nagiging nested object ang mga class na naka-link gamit ang @DBRef kapag bahagi sila ng input.
  • Sinusunod ng @JsonIgnore, @JsonProperty, @JsonIgnoreProperties at mga minanang field ang parehong rules ng JPA page.

Mga gamit

Mga response na maraming embedded document

Humahaba ang mga response example dahil sa mga istrukturang isinisiksik ng MongoDB sa iisang document, gaya ng listahan ng review, option map at history array. I-paste ang mga class at maisusulat para sa iyo ang bawat nested na level.

Pagkumpara sa hugis na naka-store at ibinabalik

Nagiging iba ang mga database key sa mga API key dahil sa maiikling pangalan gamit ang @Field o mga field na naka-map sa _id. Ang panig ng API ang ipinapakita ng output, kaya mapagtatabi mo ang dalawa.

Mga paalala at limitasyon

  • Hindi binabago ng mga mapping annotation gaya ng @Field("..."), @Indexed at @TextIndexed ang mga JSON key at hindi sila naipapakita.
  • Naka-store bilang _id ang @Id String id pero lumalabas sa Jackson bilang id, na siyang ipinapakita ng output.
  • Isinusulat ng default na Jackson ng Spring Boot ang org.bson.types.ObjectId bilang object na may timestamp at date, hindi bilang hex string. Para maipadala ang anyong string na ipinapakita rito, mag-register ng ToStringSerializer o gumamit ng String na id.
  • Nagiging null ang mga class na wala sa input, kasama ang mga Spring Data type gaya ng GeoJsonPoint.

Mga madalas itanong

ObjectId ba o String dapat ang @Id ko?

Sa String, kino-convert ito ng Spring Data sa ObjectId kapag nagse-save at malinis na hex string ang ibinabalik ng API. Kapag pinanatili ang type na ObjectId, kailangan mo ng dagdag na Jackson configuration para sa mga response.

Talaga bang bumabalik bilang nested object ang mga @DBRef field?

Nire-resolve ng @DBRef ang nire-reference na document kapag nagbabasa (sa unang access kung lazy), kaya may nested object ang mga response. Ang mga manual reference na ObjectId o String na id lang ang sine-save ay id lang ang ibinabalik.

Ano ang itsura ng isang free-form na Map<String, Object> field?

Hindi alam ang value type nito, kaya nagiging {"key": null} ito. Palitan ito ng uri ng value na talagang sine-save mo bago ilagay sa docs.