JPA 엔티티를 JSON으로 변환하세요!

Spring Boot JPA 엔티티(@Entity, Hibernate)를 입력하면 예시 JSON을 만듭니다! API 테스트용 요청 본문(sample JSON)에.
JPA
결과
 

JPA 엔티티를 JSON으로 변환하세요!

Spring Boot의 JPA @Entity 클래스를 붙여넣으면, 그 엔티티를 컨트롤러에서 반환했을 때 Jackson이 만드는 JSON 모양의 예시를 보여 줍니다. 필드 이름, @JsonIgnore·@JsonProperty, 상속받은 @MappedSuperclass 필드, Java 8 날짜 타입까지 Spring Boot 기본 Jackson 설정 기준으로 채웁니다.

REST Docs나 Swagger 예시, Postman 요청 본문을 만들 때, 또는 엔티티를 그대로 노출하면 어떤 필드가 새어 나가는지 점검할 때 씁니다.

사용 방법

  1. JPA 칸에 엔티티 클래스를 붙여넣습니다. import·Lombok 어노테이션이 있어도 되고, 부모 클래스와 연관 엔티티, enum을 함께 넣으면 값이 채워집니다.
  2. 다른 클래스가 참조하지 않는 클래스가 최상위가 되고, 엔티티끼리 서로 참조하면 public 클래스가 최상위가 됩니다.
  3. 결과를 복사해 테스트 코드나 문서에 붙입니다.

예시

입력 (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;
}
출력 (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": []
  }
}

Appointment와 Patient가 서로 참조하므로 public인 Appointment가 최상위가 됐고, Patient.appointments는 무한 반복 대신 빈 배열로 끊겼습니다. BaseEntity의 id·createdAt이 앞에 들어가고, @JsonIgnore가 붙은 residentNumber는 빠졌습니다. LocalDateTime은 시간대 없는 ISO 문자열, enum은 첫 상수 "BOOKED"입니다.

지원 기능

  • static·transient 필드와 @JsonIgnore 필드를 빼고, 클래스의 @JsonIgnoreProperties({"..."}) 목록도 제외합니다.
  • @JsonProperty("doctor_name")이 있으면 그 이름을 JSON 키로 씁니다.
  • extends한 부모 클래스(@MappedSuperclass 등)가 입력에 있으면 부모 필드를 먼저 넣습니다.
  • private Status status = Status.ACTIVE;나 private int visits = 0;처럼 엔티티에 둔 기본값은 그 값으로 나오고, 필드 없이 계산만 하는 getter(public int getAge())도 Jackson처럼 키로 추가됩니다.
  • LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00으로 Spring Boot 기본 출력 형식을 따릅니다.
  • BigDecimal, Long 등 숫자 래퍼는 0, UUID는 0으로 채운 UUID, byte[]는 base64 문자열 "AA=="입니다.
  • List·Set은 원소 하나짜리 배열, Map<Long, String>은 {"0": ""}처럼 키 타입에 맞춘 객체, Optional<T>는 안쪽 값이 됩니다.
  • 양방향 연관관계(@OneToMany·@ManyToOne)는 두 번째로 돌아오는 지점에서 null이나 빈 배열로 끊습니다.

사용 사례

Spring REST Docs·Swagger 예시

@Schema(example = ...)나 문서용 스니펫에 넣을 JSON을 엔티티에서 바로 만들 수 있습니다. 필드가 추가될 때마다 다시 붙여넣으면 문서를 맞추기 쉽습니다.

엔티티 노출 점검

엔티티를 DTO 없이 반환하고 있다면 비밀번호나 주민번호 같은 필드가 응답에 들어가는지 확인해 보세요. 결과에 보이는 필드는 Jackson이 실제로 직렬화하는 필드입니다.

MockMvc 테스트 요청 본문

mockMvc.perform(post("/appointments").content(...))에 넣을 JSON의 뼈대로 쓰고, 자동 생성되는 id와 날짜는 지운 뒤 값을 채웁니다.

주의사항

  • 실제 Jackson은 양방향 연관관계를 그대로 직렬화하면 무한 재귀(StackOverflowError)가 납니다. 결과가 끊겨 보인다면 @JsonManagedReference/@JsonBackReference나 @JsonIgnore, DTO 변환이 필요하다는 신호입니다.
  • JPA의 @Transient 어노테이션은 Jackson이 기본으로 무시하지 않으므로 결과에 남습니다. 자바 키워드 transient 필드만 빠집니다.
  • FetchType.LAZY 연관은 실제로는 Hibernate 프록시 직렬화 오류가 날 수 있습니다. 결과는 로딩이 끝난 상태를 가정합니다.
  • 입력에 없는 클래스 타입 필드는 null로 나오고, @Column의 nullable, length 같은 제약은 반영하지 않습니다.

자주 묻는 질문

날짜가 배열([2024,1,1])이 아니라 문자열로 나오는 게 맞나요?

Spring Boot는 WRITE_DATES_AS_TIMESTAMPS를 꺼 두기 때문에 LocalDateTime이 ISO 문자열로 나갑니다. 순수 ObjectMapper를 직접 만들어 쓰고 JavaTimeModule만 등록했다면 배열이 나올 수 있습니다.

Lombok @Getter가 없어도 필드가 다 나오나요?

이 도구는 필드 선언을 기준으로 합니다. 실제 Jackson은 기본적으로 getter(또는 public 필드)를 통해 직렬화하므로, getter가 없는 private 필드는 응답에 빠질 수 있다는 점을 감안하세요.

MongoDB @Document 클래스도 넣어도 되나요?

같은 Jackson 규칙으로 변환되지만, ObjectId나 @Field 같은 MongoDB 특유의 주의점은 Spring Data MongoDB → JSON 페이지에 따로 정리해 두었습니다.