개요
이 가이드 에서는 MongoDB 문서와 상호 작용할 때 확장 JSON 데이터 형식을 사용하는 방법을 학습 수 있습니다.
JSON 객체, 배열, 숫자, 문자열, 부울 및 null 값을 나타내는 사람이 읽을 수 있는 데이터 형식입니다. 이 형식은 MongoDB 데이터를 저장 데 사용하는 형식인 BSON 데이터 유형의 하위 집합만 지원합니다. 확장 JSON 형식은 더 많은 BSON 유형을 지원하며, BSON 의 각 유형에 직접적으로 대응하는 필드 유형 정보를 나타내기 위해 '$' 접두사가 붙은 예약된 키 설정하다 를 정의합니다.
JSON, BSON 및 확장 JSON에 대해 자세히 학습하려면 JSON 및 BSON 리소스와 확장 JSON MongoDB Server 수동 항목을 참조하세요.
확장 JSON 형식
MongoDB 확장 JSON BSON 데이터를 나타내는 문자열 형식을 제공합니다. 각 형식은 JSON RFC 를 준수하며 특정 사용 사례를 충족합니다.
다음 표에서는 각 확장 JSON 형식에 대해 설명합니다.
이름 | 설명 |
|---|---|
확장 또는 표준 | 데이터 변환 중에 BSON 유형 정보의 손실을 방지하는 문자열 형식입니다. |
완화 | 일부 유형 정보가 손실된 BSON 문서를 설명하는 문자열 형식입니다. |
Shell | MongoDB 셸 에서 사용되는 구문과 일치하는 문자열 형식입니다. |
참고
스칼라 운전자 문자열에서 확장 $uuid JSON 유형을 바이너리 Binary 하위 유형 의 4 객체 로 구문 분석합니다.$uuid 필드 분석에 대한 자세한 내용은 확장 JSON 사양의 $uuid 필드 구문 분석을 위한 특별 규칙 섹션을 참조하세요.
확장 JSON 예시
다음 예시에서는 각 확장 JSON 형식으로 표시되는 ObjectId, 날짜, 긴 숫자 필드가 포함된 문서를 보여 줍니다. 원하는 형식의 예시 탭을 클릭합니다.
{ "_id": { "$oid": "573a1391f29313caabcd9637" }, "createdAt": { "$date": { "$numberLong": "1601499609" }}, "numViews": { "$numberLong": "36520312" } }
{ "_id": { "$oid": "573a1391f29313caabcd9637" }, "createdAt": { "$date": "2020-09-30T18:22:51.648Z" }, "numViews": 36520312 }
{ "_id": ObjectId("573a1391f29313caabcd9637"), "createdAt": ISODate("2020-09-30T18:22:51.648Z"), "numViews": NumberLong("36520312") }
확장 JSON 읽기
Scala 드라이버의 문서 클래스를 사용하거나 BSON 라이브러리를 직접 사용하여 Extended JSON string을 Scala 객체로 읽을 수 있습니다. 다음 섹션에서는 각 접근 방식을 사용하는 방법을 보여줍니다.
문서 클래스
BsonDocument에서 parse() 정적 메서드를 호출하고 그 결과를 Scala Document 인스턴스로 래핑하여 확장 JSON 문자열을 Scala 문서 객체로 읽을 수 있습니다. 이 방법은 모든 형식의 확장 JSON 문자열을 구문 분석하고 데이터가 포함된 Document를 반환합니다.
다음 예시에서는 확장 JSON string을 Document 객체로 읽는 방법을 보여 줍니다. BsonDocument.parse()을 호출하고 결과를 Document 팩토리에 전달하여 수행합니다.
val ejsonStr = """{"_id": {"$oid": "507f1f77bcf86cd799439011"}, "myNumber": {"$numberLong": "4794261"}}""" val document = Document(BsonDocument.parse(ejsonStr)) println(document)
Iterable((_id,BsonObjectId{value=507f1f77bcf86cd799439011}), (myNumber,BsonInt64{value=4794261}))
BSON 라이브러리
JsonReader 클래스를 사용하여 Scala 드라이버의 문서 클래스를 사용하지 않고도 확장 JSON string을 Scala 객체로 읽을 수 있습니다. 이 클래스에는 모든 형식의 확장 JSON string에서 필드와 값을 순차적으로 구문 분석하고 이를 Scala 객체로 반환하는 메서드가 포함되어 있습니다. 드라이버의 문서 클래스도 이 클래스를 사용하여 확장 JSON을 구문 분석합니다.
다음 코드 예에서는 JsonReader 클래스를 사용하여 확장 JSON 문자열을 Scala 객체로 변환하는 방법을 보여줍니다.
val ejsonStr = """{"_id": {"$oid": "507f1f77bcf86cd799439011"}, "myNumber": {"$numberLong": "4794261"}}""" val reader = new JsonReader(ejsonStr) reader.readStartDocument() val id = reader.readObjectId("_id") val myNumber = reader.readInt64("myNumber") reader.readEndDocument() println(s"$id is type: ${id.getClass.getName}") println(s"$myNumber is type: ${myNumber.getClass.getName}")
507f1f77bcf86cd799439011 is type: org.bson.types.ObjectId 4794261 is type: long
자세한 내용은 JsonReader API 문서를 참조하세요.
확장 JSON 쓰기
Scala 드라이버의 문서 클래스를 사용하거나 BSON 라이브러리를 직접 사용하여 데이터에서 Extended JSON string을 쓰수 있습니다. 다음 섹션에서는 각 접근 방식을 사용하는 방법을 보여줍니다.
문서 클래스
toJson() 메서드를 호출하여 Document 또는 BsonDocument의 인스턴스에서 확장된 JSON string을 쓰수 있습니다. 기본적으로 toJson() 메서드는 완화 모드 형식으로 string을 출력합니다. 다른 형식을 사용하려면 JsonWriterSettings 클래스의 인스턴스를 toJson() 메서드에 전달합니다.
다음 예시에서는 인수 없이 toJson() 메서드를 호출하여 기본 완화 모드 형식으로 확장 JSON을 출력합니다.
val document = Document( "_id" -> BsonObjectId(new ObjectId("507f1f77bcf86cd799439012")), "myNumber" -> BsonInt64(11223344L) ) val ejsonStr = document.toJson() println(ejsonStr)
{"_id": {"$oid": "507f1f77bcf86cd799439012"}, "myNumber": 11223344}
BSON 라이브러리
JsonWriter 클래스와 함께 BSON 라이브러리를 사용하여 Scala 객체의 데이터에서 확장 JSON 문자열을 출력할 수도 있습니다. JsonWriter 인스턴스를 생성하려면 Java Writer의 서브클래스를 전달하여 확장 JSON을 출력할 방법을 지정합니다. 선택적으로 JsonWriterSettings 인스턴스를 전달하여 확장 JSON 형식과 같은 옵션을 지정할 수 있습니다. 기본적으로 JsonWriter은(는) 완화 모드 형식을 사용합니다. Scala 드라이버의 문서 클래스도 이 클래스를 사용하여 BSON을 확장 JSON으로 변환합니다.
다음 코드 예시는 JsonWriter를 사용하여 확장 JSON 문자열을 만들고 System.out으로 출력하는 방법을 보여줍니다. outputMode() 빌더 메서드에 JsonMode.EXTENDED 상수를 전달하여 형식을 지정합니다.
val writer = new StringWriter() val jsonWriter = new JsonWriter(writer, JsonWriterSettings.builder().outputMode(JsonMode.EXTENDED).build()) jsonWriter.writeStartDocument() jsonWriter.writeObjectId("_id", new ObjectId("507f1f77bcf86cd799439012")) jsonWriter.writeInt64("myNumber", 11223344L) jsonWriter.writeEndDocument() println(writer.toString())
{"_id": {"$oid": "507f1f77bcf86cd799439012"}, "myNumber": {"$numberLong": "11223344"}}
이 섹션에 언급된 메서드 및 클래스에 대한 자세한 내용은 다음 API 문서를 참조하세요.
사용자 지정 BSON 유형 변환
JSON 출력 형식을 지정하는 outputMode() 외에도 JsonWriterSettings.Builder 인스턴스에 변환기를 추가하여 출력을 추가로 사용자 지정할 수 있습니다. 이러한 변환기 메서드는 특정 BSON types를 감지하고 전달된 Converter에 의해 정의된 로직을 실행합니다.
다음 샘플 코드는 Lambda 표현식으로 정의된 변환기를 추가하여 완화 모드 JSON 출력을 간소화하는 방법을 보여 줍니다.
val settings = JsonWriterSettings.builder() .outputMode(JsonMode.RELAXED) .objectIdConverter((value, writer) => writer.writeString(value.toHexString)) .timestampConverter((value, writer) => { val instant = Instant.ofEpochSecond(value.getTime.toLong) writer.writeString( DateTimeFormatter.ISO_LOCAL_DATE_TIME.withZone(ZoneOffset.UTC).format(instant)) }) .build() val document = Document( "_id" -> BsonObjectId(new ObjectId("507f1f77bcf86cd799439012")), "createdAt" -> new BsonTimestamp(1601516589, 1), "myNumber" -> BsonInt64(4794261L) ) println(document.toJson(settings))
{"_id": "507f1f77bcf86cd799439012", "createdAt": "2020-10-01T01:43:09", "myNumber": 4794261} // Without specifying the converters, the Relaxed mode JSON output // would look something like this: {"_id": {"$oid": "507f1f77bcf86cd799439012"}, "createdAt": {"$timestamp": {"t": 1601516589, "i": 1}}, "myNumber": 4794261}
이 섹션에 언급된 메서드 및 클래스에 대한 자세한 내용은 다음 API 문서를 참조하세요.