Formato de datos de documento: JSON extendido

Ejemplos de JSON extendido

Los siguientes ejemplos muestran un documento que contiene un campo ObjectId, una fecha y un número largo representado en cada formato Extendido de JSON. Haz clic en la pestaña que corresponda al formato del ejemplo que desees 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 Extended JSON en un objeto de documento Kotlin llamando al método estático parse() de la clase Document o BsonDocument, dependiendo del tipo de objeto Realm que necesites. Este método analiza la string Extended JSON en cualquiera de los formatos y devuelve una instancia de esa clase que contiene los datos.

El siguiente ejemplo muestra cómo puedes usar la clase Document para leer una string JSON extendida de ejemplo en un objeto Document usando 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, consulta nuestra página de Fundamentos sobre Guía de Documentos.

Uso de la librería BSON

También puedes leer una string Extended JSON a objetos de Kotlin sin utilizar las clases de documento del driver MongoDB Kotlin usando la clase JsonReader. Esta clase contiene métodos para analizar secuencialmente los campos y valores en cualquier formato de la string Extended JSON, y los devuelve como objetos de Kotlin. Las clases de documentos del driver también utilizan esta clase para analizar JSON extendido.

El siguiente ejemplo de código muestra cómo puede usar la clase JsonReader para convertir una cadena JSON extendida en objetos de 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 más información, consulta la JsonReader Documentación de la API.

Uso de las clases de documentos

Se puede crear una string Extended JSON a partir de una instancia de Document o BsonDocument llamando al método toJson(), pasando opcionalmente una instancia de JsonWriterSettings para especificar el formato Extended JSON.

En este ejemplo, producimos 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 puedes generar una Extended JSON string a partir de datos en objetos de Kotlin utilizando la librería BSON con la clase JsonWriter. Para construir una instancia de JsonWriter, pasa una subclase de una Writer Java para especificar cómo deseas generar la salida del extended JSON. Opcionalmente, se puede pasar una instancia de JsonWriterSettings para especificar opciones como el formato JSON extendido. Por defecto, el JsonWriter utiliza el formato de modo relajado. Las clases de documentos del driver MongoDB Kotlin también usan 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 la API:

• JsonWriter

• Configuración de JsonWriter

• outputMode()