Trabajar con datos JSON ampliados

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

Utiliza las Clases de Documento

Para leer una string JSON extendida en un objeto de documento de Java, llame al método estático parse() de la clase Document o BsonDocument. Este método analiza la string 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 Extended JSON en un objeto Document:

String ejsonStr = "{ \"_id\": { \"$oid\": \"507f1f77bcf86cd799439011\" },"
        + " \"myNumber\": { \"$numberLong\": \"4794261\" } }";
Document doc = Document.parse(ejsonStr);
System.out.println(doc);

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

Usa la clase JsonReader

Para leer una string JSON extendida en objetos de Java sin usar las clases de documento, utilice la clase JsonReader de la librería BSON. Esta clase contiene métodos para analizar secuencialmente los campos y valores de la string JSON extendida y devolverlos como objetos de Java. Las clases de documentos del driver también utilizan esta clase para analizar JSON extendido.

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

String string = "{ \"_id\": { \"$oid\": \"507f1f77bcf86cd799439011\" },"
        + " \"myNumber\": { \"$numberLong\": \"4794261\" } }";
JsonReader jsonReader = new JsonReader(string);
jsonReader.readStartDocument();
// Reads the "_id" field value
jsonReader.readName("_id");
ObjectId id = jsonReader.readObjectId();
// Reads the "myNumber" field value
jsonReader.readName("myNumber");
long myNumber = jsonReader.readInt64();
jsonReader.readEndDocument();
System.out.println(id + " is type: " + id.getClass().getName());
System.out.println(myNumber + " is type: " + Long.class.getName());
jsonReader.close();

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

Utiliza las Clases de Documento

Para guardar una cadena Extended JSON a partir de un objeto Document o BsonDocument, llama al método toJson(). Puedes pasar a este método un parámetro de objeto JsonWriterSettings para especificar el formato JSON ampliado.

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

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

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

Utiliza la clase JsonWriter

Para generar una string JSON extendida a partir de datos almacenados en objetos Java, puede usar la clase JsonWriter de la librería BSON. Para construir un objeto JsonWriter, pase una subclase de un Writer de Java para especificar cómo desea generar el JSON extendido. Opcionalmente, puede pasar una instancia de JsonWriterSettings para especificar opciones, como el formato JSON extendido. Por defecto, JsonWriter utiliza el formato de modo relajado. Las clases de documentos BSON también utilizan 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:

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

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