Java - JPA - anotação @Version

Como a @Versionanotação funciona no JPA?

Encontrei várias respostas cujo extrato é o seguinte:

JPA usa um campo de versão em suas entidades para detectar modificações simultâneas no mesmo registro de armazenamento de dados. Quando o tempo de execução JPA detecta uma tentativa de modificar simultaneamente o mesmo registro, ele lança uma exceção para a última tentativa de confirmação da transação.

Mas ainda não tenho certeza de como funciona.

Também a partir das seguintes linhas:

Você deve considerar os campos de versão imutáveis. A alteração do valor do campo tem resultados indefinidos.

Isso significa que devemos declarar nosso campo de versão como final?

Mas ainda não tenho certeza de como funciona?

Digamos que uma entidade MyEntitytenha uma versionpropriedade anotada :

@Entity
public class MyEntity implements Serializable {    

    @Id
    @GeneratedValue
    private Long id;

    private String name;

    @Version
    private Long version;

    //...
}

Na atualização, o campo anotado com @Versionserá incrementado e adicionado à WHEREcláusula, algo assim:

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

Se a WHEREcláusula não corresponder a um registro (porque a mesma entidade já foi atualizada por outro encadeamento), o provedor de persistência lançará um OptimisticLockException.

Isso significa que devemos declarar nosso campo de versão como final

Não, mas você pode considerar a possibilidade de tornar o setter protegido como você não deveria chamá-lo.

Embora a resposta @Pascal seja perfeitamente válida, por experiência própria considero o código abaixo útil para realizar o bloqueio otimista:

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

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

    // ...
}

Por quê? Porque:

1. O bloqueio otimista não funcionará se o campo anotado com @Versionfor acidentalmente definido como null.
2. Como esse campo especial não é necessariamente uma versão comercial do objeto, para evitar enganos, prefiro nomear esse campo como algo semelhante optlocka version.

O primeiro ponto não importa se o aplicativo usa apenas JPA para inserir dados no banco de dados, pois o fornecedor de JPA aplicará 0para o @versioncampo no momento da criação. Mas quase sempre instruções SQL simples também estão em uso (pelo menos durante os testes de unidade e integração).

Cada vez que uma entidade é atualizada no banco de dados, o campo de versão será aumentado em um. Cada operação que atualiza a entidade no banco de dados será anexada WHERE version = VERSION_THAT_WAS_LOADED_FROM_DATABASEà sua consulta.

Ao verificar as linhas afetadas de sua operação, a estrutura jpa pode certificar-se de que não houve modificação simultânea entre carregar e persistir sua entidade, porque a consulta não encontraria sua entidade no banco de dados quando seu número de versão foi aumentado entre carregar e persistir.

Versão usada para garantir que apenas uma atualização de cada vez. O provedor JPA verificará a versão, se a versão esperada já aumentar, então alguém já atualizou a entidade, então uma exceção será lançada.

Portanto, atualizar o valor da entidade seria mais seguro, mais otimista.

Se o valor muda frequentemente, você pode considerar não usar o campo de versão. Por exemplo, "uma entidade que possui campo contador, que aumentará cada vez que uma página da web for acessada"

Apenas adicionando um pouco mais de informação.

JPA gerencia a versão por baixo do capô para você, no entanto, não o faz quando você atualiza seu registro via JPAUpdateClause; nesses casos, você precisa adicionar manualmente o incremento de versão à consulta.

O mesmo pode ser dito sobre a atualização via JPQL, ou seja, não uma simples mudança na entidade, mas um comando de atualização no banco de dados, mesmo que seja feito pelo hibernate

Pedro