Introducción a Spring Session MongoDB

Verificar los prerrequisitos.

Antes de comenzar este tutorial, asegúrese 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

Cree un nuevo proyecto Spring Boot.

Completa el tutorial de integración de Spring Data Framework para crear una nueva aplicación Spring Boot. También puedes ver y clonar el código de la aplicación visitando el repositorio SpringDataMongoBulkInsert en GitHub.

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

Actualice las dependencias de su proyecto.

En tu pom.xml archivo, reemplace su dependencia spring-boot-starter-parent 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 su cadena de conexión para su implementación de MongoDB, inicie sesión en su cuenta Atlas y navegue hasta Clusters Página en la sección Database. Haga clic en el botón Connect para su nueva implementación.

Si aún no tiene un usuario de base de datos configurado, MongoDB le solicitará que cree y configure un nuevo usuario.

Haga clic en el botón Drivers debajo de Connect to your application y seleccione "Java" en el menú de selección Driver y la versión que mejor coincida con la versión que instaló en 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 usarlo en un próximo paso.

Verifique su conexión MongoDB.

Navegue hasta su application.properties archivo en el src/main/resources directorio. Asegúrese de que este archivo especifique su base de datos MongoDB, la URI de conexión y el número de documentos que desea insertar, como se describe en la sección "Configurar su MongoClient" del tutorial de Spring Data. Si la configuración es correcta, su archivo contendrá el siguiente código:

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

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

Crea tu clase de configuración de Spring Session.

Crea un nuevo archivo 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 su aplicación Spring Boot.

Crear 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 la sesión al interactuar con los datos de producto existentes. Este archivo define los siguientes puntos finales 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/history:Recupera datos del historial de búsqueda de la sesión del usuario almacenados en MongoDB

Actualice su clase de aplicación principal.

Antes de probar los nuevos puntos de conexión web, actualice la clase principal de la aplicación para mantenerla en ejecución y generar información sobre los puntos de conexión. 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.

Pruebe 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. Buscar productos: Para consultar los documentos insertados en la bulk.products colección, visite http://localhost:8080/products/search?name= y añada el nombre del producto a la URL. Por ejemplo, puede buscar documentos cuyo name valor "goose" sea visitando http://localhost:8080/products/search?name=goose.

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

   {
       "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 su historial de búsqueda, visite http://localhost:8080/products/history.

   La salida contiene su ID de sesión, una lista de nombres de productos que buscó y la cantidad total de búsquedas, como se muestra en el siguiente ejemplo de salida:

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

Reinicia la aplicación.

Si detiene su aplicación y la ejecuta nuevamente, MongoDB conserva los datos de su sesión.

Detenga la aplicación en su IDE o terminal. Luego, reiníciela.

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

./mvnw spring-boot:run

Si visita la URL http://localhost:8080/products/history, podrá ver su historial de búsquedas anterior a pesar del reinicio de la aplicación. Estos datos siguen disponibles porque se almacenaron en MongoDB y no en la memoria.