Comenzar con Spring Session MongoDB

Verificar los prerrequisitos.

Antes de comenzar este tutorial, asegúrate de instalar y configurar los siguientes requisitos previos:

• JDK versión 17 o posterior

• Maven

• MongoDB Atlas cluster

• Entorno de desarrollo integrado (IDE), como IntelliJ IDEA o Eclipse

Crear un nuevo proyecto de Spring Boot.

Completa el tutorial Integración del marco de datos de Spring para crear una nueva aplicación Spring Boot. También puede ver y clonar el código de la aplicación visitando el repositorio SpringDataMongoBulkInsert en GitHub.

Después de completar este tutorial previo, tendrás una nueva aplicación que utiliza Spring Data MongoDB para realizar una operación de inserción masiva en una colección de MongoDB.

Actualiza las dependencias de tu proyecto.

En tu pom.xml archivo, sustituye tu spring-boot-starter-parent dependencia con el siguiente código:

<parent>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-parent</artifactId>
   <version>4.0.0</version>
   <relativePath/> <!-- Lookup parent from repository -->
</parent>

Esto garantiza que su aplicación utilice Spring Boot 4.0, que es compatible con Spring Session 4.0.

Luego, agregue la siguiente dependencia a la lista de dependencias de su archivo para usar Spring Session MongoDB:

<dependency>
   <groupId>org.mongodb</groupId>
   <artifactId>mongodb-spring-session</artifactId>
   <version>4.0.0-rc0</version>
</dependency>

Después de configurar las dependencias, es necesario garantizar que estén disponibles para el proyecto ejecutando el administrador de dependencias y actualizando el proyecto en el IDE.

Encuentra tu cadena de conexión de MongoDB Atlas.

Para recuperar tu cadena de conexión para tu implementación de MongoDB, inicia sesión en tu cuenta de Atlas y navega al Clusters la página en la sección Database. Haz clic en el botón Connect para tu nueva implementación.

Si aún no tienes configurado un usuario de base de datos, MongoDB te pedirá que crees y configures un nuevo usuario.

Haga clic en el botón Drivers bajo Connect to your application y seleccione "Java" desde el menú de selección Driver y la versión que mejor coincida con la versión que instaló desde el menú de selección Version.

Asegúrate de que la opción View full code sample esté desmarcada para ver solo la cadena de conexión.

Copie su cadena de conexión.

Haz clic en el botón a la derecha de la cadena de conexión para copiarla en el portapapeles, como se muestra en la siguiente captura de pantalla:

Actualiza el marcador de posición de la contraseña.

Pega esta cadena de conexión en un archivo en tu editor de texto preferido y reemplaza el marcador de posición <db_password> con la contraseña de tu usuario de base de datos. La cadena de conexión ya está completada con el nombre de usuario de tu usuario de base de datos.

Guarde este archivo en una ubicación segura para su uso en un paso próximo.

Verifique su conexión MongoDB.

Navega a tu archivo application.properties en el directorio src/main/resources. Asegúrate de que este archivo especifique tu base de datos MongoDB, el URI de conexión y el número de documentos a insertar, como se describe en la sección Configura tu MongoClient del tutorial de Spring Data. Si se configura correctamente, su archivo contiene el siguiente código:

mongodb.database=bulk
mongodb.uri=<connection URI>
documentCount=25000

Reemplace el marcador de posición <connection URI> por el URI de conexión que guardó en la sección anterior.

Crea tu clase de configuración de Spring Session.

Crea un archivo nuevo llamado SessionConfig.java en el directorio del paquete base de tu proyecto y pega el siguiente código:

package com.mongodb.examples.springdatabulkinsert;
import org.mongodb.spring.session.config.annotation.web.http.EnableMongoHttpSession;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableMongoHttpSession
public class SessionConfig {
}

Esta clase de configuración habilita la gestión de sesiones HTTP respaldada por MongoDB para tu aplicación Spring Boot.

Cree un controlador web.

Crea un archivo llamado ProductWebController.java en el directorio del paquete base de tu proyecto y pega el siguiente código:

package com.mongodb.examples.springdatabulkinsert;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import jakarta.servlet.http.HttpSession;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
@RestController
public class ProductWebController {
    @Autowired
    private MongoTemplate mongoTemplate;
    @GetMapping("/products/search")
    public Map<String, Object> searchProducts(
            @RequestParam(required = false) String name,
            HttpSession session) {
        
        @SuppressWarnings("unchecked")
        List<String> searchHistory = (List<String>) session.getAttribute("searchHistory");
        if (searchHistory == null) {
            searchHistory = new ArrayList<>();
        }
        
        // Defines the default search if no name is provided
        if (name == null || name.trim().isEmpty()) {
            name = "product";
        }
        
        // Adds the current search to history
        searchHistory.add(name);
        session.setAttribute("searchHistory", searchHistory);
        
        // Queries the "name" field in the "products" collection
        Query query = new Query(Criteria.where("name").regex(name, "i"));
        
        List<Product> products = mongoTemplate.find(query, Product.class, "products");
        
        return Map.of(
            "products", products,
            "sessionId", session.getId()
        );
    }
    
    @GetMapping("/products/history")
    public Map<String, Object> getSearchHistory(HttpSession session) {
        // Retrieves the search history from the session
        @SuppressWarnings("unchecked")
        List<String> searchHistory = (List<String>) session.getAttribute("searchHistory");
        if (searchHistory == null) {
            searchHistory = new ArrayList<>();
        }
        
        return Map.of(
            "searchHistory", searchHistory,
            "sessionId", session.getId(),
            "searchCount", searchHistory.size()
        );
    }
    
}

ProductWebController.java es un controlador REST que demuestra la funcionalidad de sesión al interactuar con tus datos de producto existentes. Este archivo define los siguientes endpoints web:

• /products/search: Busca productos en la colección bulk.products y almacena cada término de búsqueda en la sesión del usuario

• /products/historyRecupera los datos de historial de búsqueda de la sesión del usuario almacenada en MongoDB

Actualiza tu clase principal de aplicación.

Antes de probar los nuevos puntos finales web, actualiza tu clase principal de aplicación para mantener la aplicación en ejecución y proporcionar información sobre los puntos finales. Reemplace el contenido de SpringDataBulkInsertApplication.java con el siguiente código:

package com.mongodb.examples.springdatabulkinsert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringDataBulkInsertApplication implements CommandLineRunner {
    @Value("${documentCount}")
    private int count;
    private static final Logger LOG = LoggerFactory
            .getLogger(SpringDataBulkInsertApplication.class);
    @Autowired
    private ProductRepository repository;
    public static void main(String[] args) {
        SpringApplication.run(SpringDataBulkInsertApplication.class, args);
    }
    @Override
    public void run(String... args) throws Exception {
        repository.bulkInsertProducts(count);
        LOG.info("Bulk insert completed. Web endpoints are now available.");
        LOG.info("You can visit these URLs:");
        LOG.info("  http://localhost:8080/products/search?name=goose");
        LOG.info("  http://localhost:8080/products/history");
    }
}

Ejecute y pruebe su aplicación actualizada.

Ejecute su aplicación en su IDE o ejecute el siguiente comando en su terminal:

./mvnw spring-boot:run

Su aplicación se inicia, realiza la operación de inserción masiva y luego proporciona puntos finales web en http://localhost:8080.

Prueba la funcionalidad de la sesión.

Abra su navegador web o utilice una herramienta como curl para probar los siguientes puntos finales habilitados para sesión:

1. Búsqueda de productos: Para consultar los documentos insertados en la colección bulk.products, visita http://localhost:8080/products/search?name= y añade el nombre de un producto a la URL. Por ejemplo, puedes buscar documentos que tengan un name valor de "goose" visitando http://localhost:8080/products/search?name=goose.

   La salida contiene el ID de tu sesión y una lista de documentos que coinciden con tu query de campo name, como se muestra en el siguiente ejemplo de muestra:

   {
       "sessionId": "...",
       "products": [
           {
               "name": "goose",
               "qty": 788,
               "price": 9680,
               "available": "...",
               "unavailable": "...",
               "skuId": "276-68-7836"
           },
           {
               "name": "goose",
               "qty": 984,
               "price": 2307,
               "available": "...",
               "unavailable": "...",
               "skuId": "068-88-9345"
           },
           ...
       ]
   }

2. Ver historial de búsqueda: Para ver tu historial de búsqueda, visita http://localhost:8080/products/history.

   La salida contiene tu ID de sesión, una lista de los nombres de productos que buscaste y el número total de búsquedas, como se muestra en la siguiente muestra de salida:

   {
      "sessionId": "...",
      "searchHistory": [
          "goose",
          "bear"
      ],
      "searchCount": 2
   }

Reinicia la aplicación.

Si detienes tu aplicación y la ejecutas nuevamente, MongoDB persiste los datos de tu sesión.

Detén tu aplicación en tu IDE o terminal. Después, reinícialo/a.

en su IDE, o ejecute el siguiente comando en su terminal:

./mvnw spring-boot:run

Si visitas la URL http://localhost:8080/products/history, puedes ver tu historial de búsquedas anteriores a pesar de que la aplicación se reinicie. Estos datos aún están disponibles porque se almacenaron en MongoDB en lugar de en la memoria.