Java - JPA - anotación @Version

¿Cómo funciona la @Versionanotación en JPA?

Encontré varias respuestas cuyo extracto es el siguiente:

JPA usa un campo de versión en sus entidades para detectar modificaciones simultáneas en el mismo registro de almacén de datos. Cuando el tiempo de ejecución de JPA detecta un intento de modificar simultáneamente el mismo registro, lanza una excepción a la transacción que intenta confirmarse en último lugar.

Pero todavía no estoy seguro de cómo funciona.

También a partir de las siguientes líneas:

Debe considerar los campos de versión inmutables. Cambiar el valor del campo tiene resultados indefinidos.

¿Significa que deberíamos declarar nuestro campo de versión como final?

¿Pero todavía no estoy seguro de cómo funciona?

Digamos que una entidad MyEntitytiene una versionpropiedad anotada :

@Entity
public class MyEntity implements Serializable {    

    @Id
    @GeneratedValue
    private Long id;

    private String name;

    @Version
    private Long version;

    //...
}

En la actualización, el campo anotado con @Versionse incrementará y se agregará a la WHEREcláusula, algo como esto:

UPDATE MYENTITY SET ..., VERSION = VERSION + 1 WHERE ((ID = ?) AND (VERSION = ?))

Si la WHEREcláusula no coincide con un registro (porque la misma entidad ya ha sido actualizada por otro hilo), el proveedor de persistencia arrojará un OptimisticLockException.

¿Significa que deberíamos declarar nuestro campo de versión como final?

No, pero podría considerar hacer que el colocador esté protegido, ya que se supone que no debe llamarlo.

Aunque la respuesta de @Pascal es perfectamente válida, desde mi experiencia, encuentro que el siguiente código es útil para lograr un bloqueo optimista:

@Entity
public class MyEntity implements Serializable {    
    // ...

    @Version
    @Column(name = "optlock", columnDefinition = "integer DEFAULT 0", nullable = false)
    private long version = 0L;

    // ...
}

¿Por qué? Porque:

1. El bloqueo optimista no funcionará si el campo anotado con @Versionse establece accidentalmente en null.
2. Dado que este campo especial no es necesariamente una versión comercial del objeto, para evitar una confusión, prefiero nombrar dicho campo como algo parecido optlocka version.

Primer punto no importa si utiliza la aplicación única APP para insertar datos en la base de datos, como proveedor JPA hará cumplir 0de @versioncampo durante la creación. Pero casi siempre también se utilizan sentencias SQL simples (al menos durante las pruebas unitarias y de integración).

Cada vez que se actualiza una entidad en la base de datos, el campo de versión aumentará en uno. Cada operación que actualice la entidad en la base de datos se agregará WHERE version = VERSION_THAT_WAS_LOADED_FROM_DATABASEa su consulta.

Al verificar las filas afectadas de su operación, el marco jpa puede asegurarse de que no haya una modificación simultánea entre la carga y la persistencia de su entidad porque la consulta no encontraría su entidad en la base de datos cuando su número de versión se ha incrementado entre la carga y la persistencia.

Versión utilizada para garantizar que solo se actualice una vez por vez. El proveedor de JPA verificará la versión, si la versión esperada ya aumentó, entonces alguien más ya actualizó la entidad, por lo que se lanzará una excepción.

Entonces, actualizar el valor de la entidad sería más seguro, más optimista.

Si el valor cambia con frecuencia, entonces podría considerar no usar el campo de versión. Por ejemplo, "una entidad que tiene un campo contador, que aumentará cada vez que se acceda a una página web".

Solo agrego un poco más de información.

JPA administra la versión bajo el capó por usted, sin embargo, no lo hace cuando actualiza su registro a través de JPAUpdateClause, en tales casos, debe agregar manualmente el incremento de la versión a la consulta.

Lo mismo se puede decir sobre la actualización a través de JPQL, es decir, no un simple cambio en la entidad, sino un comando de actualización de la base de datos, incluso si se hace mediante hibernación.

Pedro