Cómo manejar identificadores autogenerados con JPA

/ Java Básico, JPA / Por

Cómo manejar identificadores autogenerados con JPA

1. Introducción

En este tutorial, discutiremos cómo manejar identificadores autogenerados con JPA. Hay dos conceptos clave que debemos entender antes de mirar un ejemplo práctico, a saber, el ciclo de vida de las entidades y la estrategia de generación de identificadores.

2. Ciclo de Vida de las Entidades y Generación de Identificadores

Cada entidad tiene cuatro estados posibles durante su ciclo de vida. Estos estados son nuevo, gestionado, desconectado y eliminado. Nuestro enfoque se centrará en los estados nuevo y gestionado. Durante la creación del objeto, una entidad se encuentra en el estado nuevo. En consecuencia, el EntityManager no tiene conocimiento de este objeto. Al llamar al método persist en EntityManager, el objeto pasa de un estado nuevo a un estado gestionado. Este método requiere una transacción activa.

JPA define cuatro estrategias para la generación de identificadores. Podemos agrupar estas cuatro estrategias en dos categorías:

  • Los identificadores están preasignados y disponibles para EntityManager antes del commit.
  • Los identificadores se asignan después del commit de la transacción.

Para obtener más detalles sobre cada estrategia de generación de identificadores, consulte nuestro artículo, ¿Cuándo establece JPA la clave primaria?.

3. Declaración del Problema

Devolver un identificador de un objeto puede convertirse en una tarea problemática. Debemos entender los principios mencionados en la sección anterior para evitar inconvenientes. Dependiendo de la configuración de JPA, los servicios pueden devolver objetos con identificador igual a cero (o nulo). El enfoque se centrará en la implementación de la clase de servicio y cómo diferentes modificaciones pueden proporcionarnos una solución.

Crearemos un módulo Maven con la especificación JPA y Hibernate como su implementación. Para mayor simplicidad, utilizaremos una base de datos en memoria H2.

Comencemos creando una entidad de dominio y mapeándola a una tabla de base de datos. Para este ejemplo, crearemos una entidad User con algunas propiedades básicas:


@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private long id;
    private String username;
    private String password;

    // Getters y Setters
}

Después de la clase de dominio, crearemos una clase UserService. Este servicio simple tendrá una referencia a EntityManager y un método para guardar objetos User en la base de datos:


public class UserService {
    EntityManager entityManager;

    public UserService(EntityManager entityManager) {
        this.entityManager = entityManager;
    }

    @Transactional
    public long saveUser(User user){
        entityManager.persist(user);
        return user.getId();
    }
}

Esta configuración es una trampa común que mencionamos anteriormente. Podemos demostrar que el valor de retorno del método saveUser es cero con una prueba:


@Test
public void whenNewUserIsPersisted_thenEntityHasNoId() {
    User user = new User();
    user.setUsername("test");
    user.setPassword(UUID.randomUUID().toString());

    long index = service.saveUser(user);

    Assert.assertEquals(0L, index);
}

En las secciones siguientes, retrocederemos para entender por qué ocurrió esto y cómo podemos solucionarlo.

4. Control de Transacciones Manual

Después de la creación del objeto, nuestra entidad User está en el estado nuevo. El estado de la entidad cambia a gestionado después de la llamada al método persist en el método saveUser. Recordamos de la sección anterior que el objeto gestionado recibe un identificador después del commit de la transacción. Como el método saveUser aún se está ejecutando, la transacción creada por la anotación @Transactional aún no se ha confirmado. Nuestra entidad gestionada obtiene un identificador cuando finaliza la ejecución de saveUser.

Una posible solución es llamar al método flush en EntityManager manualmente. Por otro lado, podemos controlar manualmente las transacciones y garantizar que nuestro método devuelva el identificador correctamente. Podemos hacer esto con EntityManager:


@Test
public void whenTransactionIsControlled_thenEntityHasId() {
    User user = new User();
    user.setUsername("test");
    user.setPassword(UUID.randomUUID().toString());
    
    entityManager.getTransaction().begin();
    long index = service.saveUser(user);
    entityManager.getTransaction().commit();
    
    Assert.assertEquals(2L, index);
}

5. Usando Estrategias de Generación de Identificadores

Hasta ahora, hemos utilizado la segunda categoría, donde la asignación del identificador ocurre después del commit de la transacción. Las estrategias de preasignación pueden proporcionarnos identificadores antes del commit, ya que mantienen un conjunto de identificadores en memoria. Esta opción no siempre es posible de implementar porque no todos los motores de bases de datos soportan todas las estrategias de generación. Cambiar la estrategia a GenerationType.SEQUENCE puede resolver nuestro problema. Esta estrategia utiliza una secuencia de base de datos en lugar de una columna de autoincremento como en GenerationType.IDENTITY.

Para cambiar la estrategia, editamos nuestra clase de entidad de dominio:


@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.SEQUENCE)
    private long id;

    // Otras propiedades y métodos
}

6. Conclusión

En este artículo, cubrimos técnicas de generación de identificadores en JPA. Primero, hicimos un pequeño resumen de los aspectos clave más importantes de la generación de identificadores. Luego, cubrimos configuraciones comunes utilizadas en JPA, junto con sus ventajas y desventajas.

Consejos Prácticos

  • Comprender el Ciclo de Vida: Es esencial comprender el ciclo de vida de las entidades para evitar problemas de generación de identificadores.
  • Control de Transacciones: Si es necesario, maneja las transacciones de forma manual para asegurarte de que los identificadores se generen correctamente.
  • Pruebas Exhaustivas: Siempre realiza pruebas adecuadas para asegurarte de que tu implementación de JPA funcione como se espera.
  • Elegir Estrategia Adecuada: Asegúrate de elegir la estrategia de generación de identificadores que mejor se adapte a tu base de datos y requisitos específicos.

Al seguir estos consejos, puedes mejorar la eficacia de tu aplicación y evitar problemas comunes al trabajar con identificadores en JPA.

Si deseas leer más sobre JPA y sus diversas configuraciones, puedes consultar el artículo mencionado anteriormente para profundizar en este tema: ¿Cuándo establece JPA la clave primaria?.