Formato de datos del documento: POJOs

Overview

En esta guía, aprenderá a almacenar y recuperar datos modelados por objetos Java tradicionales (POJO). Los POJO se utilizan a menudo para la encapsulación de datos, que consiste en separar la lógica de negocio de la representación de los datos.

El ejemplo de esta guía demuestra cómo realizar las siguientes tareas:

• Configurar el controlador para serializar y deserializar POJO

• Realizar operaciones CRUD que utilicen datos modelados por POJO

Ejemplo POJO

Las secciones de esta guía utilizan la siguiente clase POJO de ejemplo, que describe las características de las flores:

public class Flower {
    private ObjectId id;
    private String name;
    private List<String> colors;
    private Boolean isBlooming;
    private Float height;
    // public empty constructor needed for retrieving the POJO
    public Flower() {
    }
    public Flower(String name, Boolean isBlooming, Float height, List<String> colors) {
        this.name = name;
        this.isBlooming = isBlooming;
        this.height = height;
        this.colors = colors;
    }
    public ObjectId getId() {
        return id;
    }
    public void setId(ObjectId id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Boolean getIsBlooming() {
        return isBlooming;
    }
    public void setIsBlooming(Boolean isBlooming) {
        this.isBlooming = isBlooming;
    }
    public Float getHeight() {
        return height;
    }
    public void setHeight(Float height) {
        this.height = height;
    }
    public List<String> getColors() {
        return colors;
    }
    public void setColors(List<String> colors) {
        this.colors = colors;
    }
    @Override
    public String toString() {
        return "\nFlower {\n\tid: " + id + "\n\tname: " + name + "\n\tcolors: " + colors + "\n\tisBlooming: " + isBlooming + "\n\theight: " + height + "\n}";
    }
}

Al definir un POJO para almacenar y recuperar datos dentro de MongoDB, utilice las siguientes pautas:

• La clase POJO no puede implementar interfaces ni extender clases desde un marco.

• Incluya todos los campos para los cuales desea almacenar y recuperar datos y asegúrese de que no estén marcados como static o transient.

• Si incluye métodos getter o setter públicos mediante las convenciones de nomenclatura de JavaBean en su POJO, el controlador los invoca al serializar o deserializar datos. Si omite los métodos getter o setter para un campo de propiedad pública, el controlador accede a ellos o los asigna directamente.

Configurar el controlador para POJO

Para configurar el controlador para utilizar POJO, debe especificar los siguientes componentes:

• PojoCodecProvider instancia que tiene Códecs que definen cómo codificar y decodificar los datos entre el formato POJO y BSON. El proveedor también especifica a qué clases o paquetes POJO se aplican los códecs.

• CodecRegistry instancia que contiene los códecs y otra información relacionada.

• MongoDatabase o instancia MongoCollection que está configurada para utilizar CodecRegistry.

• MongoCollection instancia que se crea con la clase de documento POJO vinculada al tipo genérico TDocument.

Realice los siguientes pasos para cumplir con los requisitos de configuración definidos en la sección anterior:

1. Configure PojoCodecProvider. En este ejemplo, usamos la configuración automatic(true) de PojoCodecProvider.Builder para aplicar los códecs a cualquier clase y sus propiedades.

   CodecProvider pojoCodecProvider = PojoCodecProvider.builder().automatic(true).build();

   Nota

   Los proveedores de códecs también contienen otros objetos, como ClassModel Convention instancias y, que definen con más detalle el comportamiento de la serialización. Para obtener más información sobre los proveedores de códecs y la personalización, consulte la guía sobre personalización de POJO.

2. Agregue la instancia PojoCodecProvider a un CodecRegistry. El CodecRegistry le permite especificar uno o más proveedores de códecs para codificar los datos POJO. En este ejemplo, llamamos a los siguientes métodos:

   • fromRegistries() para combinar múltiples instancias CodecRegistry en una sola instancia

   • getDefaultCodecRegistry() para recuperar una instancia CodecRegistry de una lista de proveedores de códecs

   • fromProviders() para crear una instancia CodecRegistry a partir de PojoCodecProvider

   El siguiente código muestra cómo instanciar CodecRegistry:

   // Include the following static imports before your class definition
   import static com.mongodb.MongoClientSettings.getDefaultCodecRegistry;
   import static org.bson.codecs.configuration.CodecRegistries.fromProviders;
   import static org.bson.codecs.configuration.CodecRegistries.fromRegistries;
   ...
   CodecRegistry pojoCodecRegistry = fromRegistries(getDefaultCodecRegistry(), fromProviders(pojoCodecProvider));

3. Configure la instancia MongoDatabase o MongoCollection para usar los códecs en CodecRegistry. Puede configurar una base de datos o una colección para especificar los códecs.

   En este ejemplo, establecemos CodecRegistry en un MongoDatabase llamado sample_pojos usando el método withCodecRegistry():

   MongoClient mongoClient = MongoClients.create(uri);
   MongoDatabase database = mongoClient.getDatabase("sample_pojos").withCodecRegistry(pojoCodecRegistry);

4. Pase su clase POJO a su llamada a getCollection() como parámetro de clase de documento y especifíquelo como el argumento de tipo de su instancia MongoCollection, como se muestra en el siguiente código:

   MongoCollection<Flower> collection = database.getCollection("flowers", Flower.class);

// Insert three Flower instances
Flower roseFlower = new Flower("rose", false, 25.4f, Arrays.asList(new String[] {"red", "pink"}));
Flower daisyFlower = new Flower("daisy", true, 21.1f, Arrays.asList(new String[] {"purple", "white"}));
Flower peonyFlower = new Flower("peony", false, 19.2f, Arrays.asList(new String[] {"red", "green"}));
collection.insertMany(Arrays.asList(roseFlower, daisyFlower, peonyFlower));
// Update a document
collection.updateOne(
        Filters.lte("height", 22),
        Updates.addToSet("colors", "pink")
);
// Delete a document
collection.deleteOne(Filters.eq("name", "rose"));
// Return and print all documents in the collection
List<Flower> flowers = new ArrayList<>();
collection.find().into(flowers);
System.out.println(flowers);

[
Flower {
    id: 65b178ffa38ac42044ca1573
    name: daisy
    colors: [purple, white, pink]
    isBlooming: true
    height: 21.1
},
Flower {
    id: 65b178ffa38ac42044ca1574
    name: peony
    colors: [red, green]
    isBlooming: false
    height: 19.2
}]

Preguntas frecuentes

Esta sección responde preguntas que pueden surgir al almacenar POJO en MongoDB.

private String getField();
public String setField(String x);