MongoDB 도큐먼트 클래스를 JSON으로 변환하세요!

Spring Data MongoDB 도큐먼트 클래스(@Document)를 입력하면 예시 JSON을 만듭니다! API 테스트용 요청 본문(sample JSON)에.
Spring Data MongoDB
결과
 

MongoDB 도큐먼트 클래스를 JSON으로 변환하세요!

Spring Data MongoDB의 @Document 클래스와 그 안에 임베드되는 클래스·record를 넣으면, 컨트롤러가 이 도큐먼트를 반환할 때의 JSON 예시를 만듭니다. Spring Boot 기본 Jackson 규칙으로 직렬화한 모양이라, MongoDB에 저장되는 BSON이 아니라 API 응답 기준입니다.

임베디드 리스트, Map 필드, Instant 같은 날짜가 많은 MongoDB 도큐먼트에서 응답 예시를 손으로 쓰기 번거로울 때, 또 저장 형식과 응답 형식의 차이를 확인할 때 씁니다.

사용 방법

  1. Spring Data MongoDB 칸에 @Document 클래스와 임베디드 클래스·record를 함께 붙여넣습니다.
  2. 다른 클래스에서 참조되지 않는 도큐먼트 클래스가 결과의 최상위가 됩니다.
  3. 결과에서 id와 날짜 값을 실제처럼 바꾼 뒤 문서나 테스트에 씁니다.

예시

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

List<Alert>의 Alert는 record라서 컴포넌트 level, message, raisedAt이 그대로 필드가 됐습니다. Map<String, Double>은 {"key": 0}, Instant는 Z가 붙은 UTC 문자열입니다. @Field("fw")는 MongoDB에 저장될 이름만 바꾸므로 JSON 키는 firmwareVersion 그대로입니다.

지원 기능

  • record Alert(String level, ...)처럼 Java record의 컴포넌트를 필드로 읽습니다.
  • List, Set은 원소 하나짜리 배열, Map<String, T>는 {"key": 값}으로 채웁니다.
  • Instant, ZonedDateTime, OffsetDateTime은 1970-01-01T00:00:00Z, LocalDateTime은 시간대 없는 문자열로 구분합니다.
  • ObjectId 타입 필드는 예시 ObjectId 16진 문자열로 채웁니다.
  • @DBRef로 연결된 클래스가 입력에 있으면 그 필드로 채운 중첩 객체가 됩니다.
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties와 상속 필드를 JPA 페이지와 같은 규칙으로 처리합니다.

사용 사례

임베디드 도큐먼트가 많은 응답

리뷰 목록, 옵션 맵, 이력 배열처럼 MongoDB에서 한 도큐먼트에 몰아 넣는 구조는 응답 예시가 길어지기 쉽습니다. 클래스만 붙여넣으면 중첩 구조가 빠짐없이 나옵니다.

저장 형식과 응답 형식 비교

@Field로 짧은 이름을 쓰거나 _id로 매핑되는 필드가 있으면 DB에서 보는 키와 API 키가 달라집니다. 결과는 API 쪽 키를 보여 주므로 둘을 나란히 놓고 비교할 수 있습니다.

주의사항

  • @Field("..."), @Indexed, @TextIndexed 같은 매핑 어노테이션은 JSON 키에 영향을 주지 않으며 결과에도 반영하지 않습니다.
  • @Id String id는 저장할 때 _id로 바뀌지만 Jackson 응답에서는 id로 나갑니다. 결과도 id입니다.
  • Spring Boot 기본 Jackson은 org.bson.types.ObjectId를 16진 문자열이 아니라 timestamp·date가 든 객체로 직렬화합니다. 결과의 문자열처럼 보내려면 ToStringSerializer를 등록하거나 String id를 쓰세요.
  • 입력에 없는 클래스 타입은 null이 됩니다. GeoJsonPoint 같은 Spring Data 타입도 마찬가지입니다.

자주 묻는 질문

@Id를 ObjectId로 둘지 String으로 둘지 고민됩니다.

String으로 두면 Spring Data가 저장할 때 ObjectId로 바꿔 주고, API 응답에서도 깔끔한 16진 문자열이 됩니다. ObjectId 타입을 유지한다면 응답 직렬화 설정이 따로 필요합니다.

@DBRef 필드는 실제로도 중첩 객체로 나오나요?

@DBRef는 조회할 때 참조된 도큐먼트를 불러오므로 응답에서는 중첩 객체가 됩니다(lazy 설정이면 접근 시점에 로딩). 대신 ObjectId나 String id만 저장하는 수동 참조라면 응답에도 id만 나갑니다.

Map<String, Object>로 선언한 자유 형식 필드는 어떻게 보이나요?

값 타입을 알 수 없어 {"key": null}이 됩니다. 실제로 들어가는 값 예시로 바꿔서 문서에 쓰세요.