Java - JPA - annotazione @Version

Come funziona l' @Versionannotazione in JPA?

Ho trovato varie risposte il cui estratto è il seguente:

JPA utilizza un campo versione nelle entità per rilevare modifiche simultanee allo stesso record dell'archivio dati. Quando il runtime JPA rileva un tentativo di modificare contemporaneamente lo stesso record, genera un'eccezione alla transazione che tenta di eseguire il commit per ultimo.

Ma non sono ancora sicuro di come funzioni.

Anche dalle seguenti righe:

Dovresti considerare i campi della versione immutabili. La modifica del valore del campo ha risultati indefiniti.

Significa che dovremmo dichiarare il nostro campo versione come final?

Ma ancora non sono sicuro di come funzioni?

Supponiamo che un'entità MyEntityabbia una versionproprietà annotata :

@Entity
public class MyEntity implements Serializable {    

    @Id
    @GeneratedValue
    private Long id;

    private String name;

    @Version
    private Long version;

    //...
}

All'aggiornamento, il campo annotato con @Versionverrà incrementato e aggiunto alla WHEREclausola, in questo modo:

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

Se la WHEREclausola non riesce a trovare una corrispondenza con un record (perché la stessa entità è già stata aggiornata da un altro thread), il provider di persistenza genererà un file OptimisticLockException.

Significa che dovremmo dichiarare il nostro campo versione come finale

No, ma potresti considerare di proteggere il setter come non dovresti chiamarlo.

Sebbene la risposta di @Pascal sia perfettamente valida, dalla mia esperienza trovo il codice seguente utile per ottenere un blocco ottimistico:

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

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

    // ...
}

Perché? Perché:

1. Il blocco ottimistico non funzionerà se il campo annotato con @Versionè impostato accidentalmente su null.
2. Poiché questo campo speciale non è necessariamente una versione aziendale dell'oggetto, per evitare un errore fuorviante, preferisco denominare tale campo con qualcosa di simile optlockpiuttosto che version.

Primo punto non importa se usi applicativi solo APP per l'inserimento dei dati nel database, come APP vendor valere 0per @versionsettore al momento della creazione. Ma quasi sempre vengono utilizzate anche semplici istruzioni SQL (almeno durante i test di unità e di integrazione).

Ogni volta che un'entità viene aggiornata nel database, il campo della versione verrà aumentato di uno. Ogni operazione che aggiorna l'entità nel database verrà aggiunta WHERE version = VERSION_THAT_WAS_LOADED_FROM_DATABASEalla sua query.

Nel controllare le righe interessate della tua operazione, il framework jpa può assicurarsi che non ci siano state modifiche simultanee tra il caricamento e la persistenza dell'entità perché la query non troverà la tua entità nel database quando il suo numero di versione è stato aumentato tra caricamento e persistere.

Versione utilizzata per garantire un solo aggiornamento alla volta. Il provider JPA controllerà la versione, se la versione prevista aumenta già, qualcun altro aggiorna già l'entità, quindi verrà generata un'eccezione.

Quindi l'aggiornamento del valore dell'entità sarebbe più sicuro, più ottimista.

Se il valore cambia frequentemente, potresti considerare di non utilizzare il campo della versione. Per un esempio "un'entità che ha un campo contatore, che aumenterà ogni volta che si accede a una pagina web"

Sto solo aggiungendo qualche informazione in più.

JPA gestisce la versione sotto il cofano per te, tuttavia non lo fa quando aggiorni il tuo record tramite JPAUpdateClause, in questi casi devi aggiungere manualmente l'incremento di versione alla query.

Lo stesso si può dire dell'aggiornamento tramite JPQL, cioè non una semplice modifica all'entità, ma un comando di aggiornamento al database anche se viene fatto da ibernazione

Pedro