Trabajar con datos JSON extendidos

Ejemplos de JSON extendidos

Los siguientes ejemplos muestran un documento que contiene un campo ObjectId, una fecha y un número largo, representados en cada formato JSON extendido. Haga clic en la pestaña correspondiente al formato del ejemplo que desea ver:

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

Utilice las clases de documentos

Para leer una cadena JSON extendida en un objeto de documento Kotlin, llame al método estático parse() de la clase Document o BsonDocument. Este método analiza la cadena JSON extendida y almacena sus datos en una instancia de la clase de documento especificada.

El siguiente ejemplo utiliza el método parse() para leer una cadena JSON extendida en un objeto Document:

val ejsonStr = """
    {
        "_id": { "$${"oid"}": "507f1f77bcf86cd799439011" },
        "myNumber": { "$${"numberLong"}": "4794261" }
    }
""".trimIndent()
val doc = Document.parse(ejsonStr)
println(doc)

Document{{_id=507f1f77bcf86cd799439011, myNumber=4794261}}

Utilice la clase JsonReader

Para leer una cadena JSON extendida en objetos Kotlin sin usar las clases de documento del controlador Kotlin Sync, utilice la clase JsonReader de la biblioteca BSON. Esta clase contiene métodos para analizar secuencialmente los campos y valores de la cadena JSON extendida y devolverlos como objetos Kotlin. Las clases de documento del controlador también utilizan esta clase para analizar JSON extendida.

El siguiente código utiliza métodos proporcionados por la clase JsonReader para convertir una cadena JSON extendida en objetos Kotlin:

val string = """
    {
        "_id": { "$${"oid"}": "507f1f77bcf86cd799439011" },
        "myNumber": { "$${"numberLong"}": "4794261" }
    }
""".trimIndent()
val jsonReader = JsonReader(string)
jsonReader.readStartDocument()
// Reads the "_id" field value
jsonReader.readName("_id")
val id = jsonReader.readObjectId()
// Reads the "myNumber" field value 
jsonReader.readName("myNumber")
val myNumber = jsonReader.readInt64()
jsonReader.readEndDocument()
println("$id is type: ${id::class.qualifiedName}")
println("$myNumber is type: ${myNumber::class.qualifiedName}")
jsonReader.close()

507f1f77bcf86cd799439011 is type: org.bson.types.ObjectId
4794261 is type: kotlin.Long

Utilice las clases de documentos

Para escribir una cadena JSON extendida desde un objeto Document o BsonDocument, llame al método toJson(). Puede pasarle a este método un parámetro de objeto JsonWriterSettings para especificar el formato JSON extendido.

El siguiente ejemplo escribe datos Document como JSON extendido en modo relajado:

val doc = Document()
    .append("_id", ObjectId("507f1f77bcf86cd799439012"))
    .append("createdAt", Date.from(Instant.ofEpochMilli(1601499609000L)))
    .append("myNumber", 4794261)
val settings = JsonWriterSettings.builder()
    .outputMode(JsonMode.RELAXED)
    .build()
println(doc.toJson(settings))

{"_id": {"$oid": "507f1f77bcf86cd799439012"}, "createdAt": {"$date": "2020-09-30T21:00:09Z"}, "myNumber": 4794261}

Utilice la clase JsonWriter

Para generar una cadena JSON extendida a partir de datos almacenados en objetos Kotlin, puede usar la clase JsonWriter de la biblioteca BSON. Para construir un objeto JsonWriter, pase una subclase de Java Writer para especificar cómo desea generar el JSON extendido. Opcionalmente, puede pasar una instancia JsonWriterSettings para especificar opciones, como el formato JSON extendido. De forma predeterminada, JsonWriter usa el formato de modo relajado. Las clases de documento del controlador Kotlin Sync también usan esta clase para convertir BSON a JSON extendido.

El siguiente ejemplo utiliza un objeto JsonWriter para crear valores de string Extended JSON en modo canónico y exportarlos a System.out:

 val settings = JsonWriterSettings.builder()
    .outputMode(JsonMode.EXTENDED)
    .build()
JsonWriter(BufferedWriter(OutputStreamWriter(System.out)), settings).use { jsonWriter ->
    jsonWriter.writeStartDocument()
    jsonWriter.writeName("_id")
    jsonWriter.writeObjectId(ObjectId("507f1f77bcf86cd799439012"))
    jsonWriter.writeName("myNumber")
    jsonWriter.writeInt64(11223344L)
    jsonWriter.writeEndDocument()
    jsonWriter.flush()
}

{"_id": {"$oid": "507f1f77bcf86cd799439012"}, "myNumber": {"$numberLong": "11223344"}}