Formato de datos del documento: JSON extendido

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

{
  "_id:": { "$oid": "573a1391f29313caabcd9637" },
  "createdAt": { "$date": 1601499609 },
  "numViews": { "$numberLong": "36520312" }
}

Uso de las clases de documentos

Puedes leer una cadena JSON extendida en un objeto de documento Kotlin llamando al método estático parse() desde la clase Document o BsonDocument, según el tipo de objeto que necesites. Este método analiza la cadena JSON extendida en cualquier formato y devuelve una instancia de esa clase que contiene los datos.

El siguiente ejemplo muestra cómo puede utilizar la clase Document para leer una cadena JSON extendida de ejemplo en un objeto Document utilizando el método parse():

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

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

Para obtener más información, consulte nuestra página de Fundamentos en Guía de documentos.

Uso de la librería BSON

También puede leer una cadena JSON extendida en objetos Kotlin sin usar las clases de documento del controlador Kotlin de MongoDB mediante la clase JsonReader. Esta clase contiene métodos para analizar secuencialmente los campos y valores de la cadena JSON extendida en cualquier formato y los devuelve como objetos Kotlin. Las clases de documento del controlador también utilizan esta clase para analizar JSON extendida.

El siguiente ejemplo de código muestra cómo puede utilizar la clase JsonReader para convertir una cadena JSON extendida en objetos Kotlin:

val ejsonStr = """
    { "_id": { "${"$"}oid": "507f1f77bcf86cd799439011"},
      "myNumber": {"${"$"}numberLong": "4794261" }}
    """.trimIndent()
val jsonReader = JsonReader(ejsonStr)
jsonReader.readStartDocument()
jsonReader.readName("_id")
val id = jsonReader.readObjectId()
jsonReader.readName("myNumber")
val myNumber = jsonReader.readInt64()
jsonReader.readEndDocument()
println(id.toString() + " is type: " + id.javaClass.name)
println(myNumber.toString() + " is type: " + myNumber.javaClass.name)
jsonReader.close()

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

Para obtener más información, consulte la documentación de la API de JsonReader.

Uso de las clases de documentos

Puede escribir una cadena JSON extendida desde una instancia de Document o BsonDocument llamando al método toJson(), pasándole opcionalmente una instancia de JsonWriterSettings para especificar el formato JSON extendido.

En este ejemplo, generamos el JSON extendido en el formato de modo relajado.

val myDoc = Document().append("_id", ObjectId("507f1f77bcf86cd799439012"))
    .append("myNumber", 11223344)
val settings = JsonWriterSettings.builder().outputMode(JsonMode.RELAXED).build()
myDoc.toJson(settings)

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

Uso de la librería BSON

También puede generar una cadena JSON extendida a partir de datos en objetos Kotlin utilizando la biblioteca BSON con la clase JsonWriter. Para construir una instancia de 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 utiliza el formato de modo relajado. Las clases de documento del controlador Kotlin de MongoDB también utilizan esta clase para convertir BSON a JSON extendido.

El siguiente ejemplo de código muestra cómo puedes usar JsonWriter para crear una string JSON extendida y enviarla a System.out. Especificamos el formato pasando el método builder outputMode() la constante JsonMode.EXTENDED:

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

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

Para obtener más información sobre los métodos y clases mencionados en esta sección, consulte la siguiente documentación de API:

• Escritor Json

• Configuración de JsonWriter

• outputMode()