拡張JSONデータとの連携

拡張 JSON の例

次の例は、それぞれの拡張 JSON 形式で表される ObjectId、date、long 数値フィールドを含むドキュメントを示しています。 表示する例の形式に対応するタブをクリックします。

{
  "_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")
}

ドキュメント クラス

BsonDocument で parse() 静的メソッドを呼び出し、その結果を Scala Document インスタンスでラップすることで、拡張 JSON string を Scala ドキュメント オブジェクトに読み込むことができます。このアプローチでは、拡張 JSON string をいずれかの形式でパースし、データを含む Document を返します。

次の例は、BsonDocument.parse()を呼び出し、その結果をDocumentファクトリに渡すことで、拡張 JSON string を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}))

To learn more about documents in MongoDB, see Documents in the MongoDB Server manual.

BSON ライブラリ

JsonReader クラスを使用すると、Scala ドライバーのドキュメント クラスを使用せずに Extended JSON string を Scala オブジェクトに読み込むこともできます。このクラスには、Extended JSON string のあらゆる形式でフィールドと値を順序にパースし、それらを Scala オブジェクトとして返すメソッドが含まれています。ドライバーのドキュメント クラスでも、Extended JSON をパースするためにこのクラスを使用します。

次のコード例は、JsonReader クラスを使用して拡張 JSON string を 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ドキュメント を参照してください。

ドキュメント クラス

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 ライブラリ

BSON ライブラリと JsonWriter クラスを使用して、Scala オブジェクトのデータから Extended JSON string を出力することもできます。JsonWriter のインスタンスを構築するには、Java Writer のサブクラスを渡して Extended JSON の出力方法を指定します。オプションで、JsonWriterSettings インスタンスを渡して Extended JSON 形式などのオプションを指定することができます。デフォルトでは、JsonWriter は緩和モード形式を使用します。Scala ドライバーのドキュメント クラスも、BSON を Extended JSON に変換するためにこのクラスを使用します。

次のコード例は、JsonWriter を使用して拡張JSON string を作成し、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 ドキュメントを参照してください。

• JsonWriter

• JsonWriterSettings

• outputMode()