I-convert ang mga JPA entity sa JSON!

Maglagay ng mga JPA entity para gumawa ng halimbawang JSON! Sinusuportahan ang JPA @Entity, Hibernate, Spring Boot. Magagamit sa API docs at test request body (mock request body).
JPA
Resulta
 

I-convert ang mga JPA entity sa JSON!

I-paste ang mga Spring Boot JPA @Entity class at tingnan ang halimbawang JSON sa hugis na ginagawa ng Jackson kapag ibinabalik ng isang controller ang mga entity na iyon. Inaasikaso ayon sa default na Jackson setup ng Spring Boot ang mga field name, @JsonIgnore at @JsonProperty, mga field na minana mula sa isang @MappedSuperclass, at mga Java 8 date type.

Gamitin ito para sa mga REST Docs o Swagger example, mga Postman request body, o para suriin kung aling mga field ang tumatagas kapag inilalabas ang isang entity nang walang DTO.

Paano gamitin

  1. I-paste ang mga entity class sa JPA box. Puwedeng iwan ang mga import at Lombok annotation; isama ang mga parent class, kaugnay na entity at enum para mapunan ang mga value nila.
  2. Ang class na hindi nire-reference ng ibang class ang nagiging root. Kapag nagre-reference sa isa't isa ang mga entity, ang public class ang pinipili.
  3. Kopyahin ang resulta papunta sa test o dokumentasyon mo.

Halimbawa

Input (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;
}
Output (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": []
  }
}

Nagre-reference sa isa't isa ang Appointment at Patient, kaya ang public class na Appointment ang root at pinuputol bilang empty array ang Patient.appointments sa halip na mag-loop nang walang hanggan. Nauuna ang id at createdAt mula sa BaseEntity, at wala na ang residentNumber dahil sa @JsonIgnore. ISO string na walang offset ang LocalDateTime, at ipinapakita ng enum ang unang constant nito, "BOOKED".

Mga sinusuportahang feature

  • Nilalaktawan ang mga static at transient na field at mga field na may @JsonIgnore, pati ang mga pangalang nakalista sa class-level na @JsonIgnoreProperties({"..."}).
  • Pinapalitan ng @JsonProperty("doctor_name") ang pangalan ng JSON key.
  • Kapag nasa input ang parent class (@MappedSuperclass o anumang extends), nauuna ang mga field nito.
  • Lumalabas bilang value na iyon ang entity default gaya ng private Status status = Status.ACTIVE; o private int visits = 0;, at lumalabas bilang dagdag na key ang mga computed getter na walang backing field (public int getAge()), gaya ng ilalabas ng Jackson.
  • Sinusunod ng date output ang mga default ng Spring Boot: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • 0 ang ibinibigay ng mga numeric wrapper gaya ng BigDecimal at Long, UUID na puro zero ang UUID, at ang base64 string na "AA==" ang byte[].
  • Array na may isang element ang ibinibigay ng List/Set, object na tugma ang key ({"0": ""}) ang Map<Long, String>, at ina-unwrap sa inner value nito ang Optional<T>.
  • Pinuputol gamit ang null o empty array ang mga bidirectional association (@OneToMany kasama ang @ManyToOne) kung saan bumabalik sila sa sarili.

Mga gamit

Mga Spring REST Docs at Swagger example

I-generate ang JSON para sa @Schema(example = ...) o mga documentation snippet nang direkta mula sa entity, at mag-paste ulit tuwing may nagbabagong field para manatiling tugma ang docs.

Pagsusuri sa mga nakalantad na entity

Kung nagbabalik ka ng mga entity nang walang DTO, i-check kung napupunta sa mga response ang mga field gaya ng password o national ID number. Ang mga field sa output ay ang mga isa-serialize ng Jackson.

Mga MockMvc request body

Gamitin ang output bilang skeleton para sa mockMvc.perform(post("/appointments").content(...)), at tanggalin ang na-generate na id at timestamps bago punan ang mga value.

Mga paalala at limitasyon

  • Sa totoong Jackson, walang katapusang recursion (StackOverflowError) ang nangyayari sa mga bidirectional association. Kung mukhang putol ang output, iyon ang hudyat para gumamit ng @JsonManagedReference/@JsonBackReference, @JsonIgnore o isang DTO.
  • Hindi pinapansin ng Jackson bilang default ang JPA annotation na @Transient, kaya nananatili sa output ang ganoong mga field; ang mga field lang na may Java keyword na transient ang tinatanggal.
  • Sa praktika, puwedeng pumalya ang serialization ng mga FetchType.LAZY association bilang Hibernate proxy; ipinapalagay ng output na naka-load ang lahat.
  • Lumalabas na null ang mga field na wala sa input ang class, at hindi ina-apply ang mga @Column constraint gaya ng nullable o length.

Mga madalas itanong

Dapat ba talagang string ang mga petsa at hindi array gaya ng [2024,1,1]?

Dina-disable ng Spring Boot ang WRITE_DATES_AS_TIMESTAMPS, kaya isinusulat bilang ISO string ang LocalDateTime. Puwede namang array ang isulat ng isang mano-manong binuong ObjectMapper na JavaTimeModule lang ang naka-register.

Lumalabas ba ang lahat ng field kahit walang Lombok @Getter?

Mula sa mga field declaration gumagana ang tool. Sa totoong Jackson, sa pamamagitan ng mga getter (o public field) nagse-serialize bilang default, kaya puwedeng wala sa totoong response ang mga private field na walang getter.

Puwede rin ba akong mag-paste ng mga MongoDB @Document class?

Parehong Jackson rules ang sinusunod nila, pero sa page na Spring Data MongoDB to JSON tinatalakay ang mga caveat na partikular sa MongoDB gaya ng ObjectId at @Field.