Spring Data JPA 实战 - -@Version与@Lock

在Spring Data JPA中，@Version和@Lock是非常有用的注解，它们分别用于实现乐观锁和悲观锁机制。这两种锁机制可以用来解决并发更新的问题，确保数据的一致性。

1. 乐观锁 (@Version)

乐观锁是一种非阻塞的并发控制策略，通常用于处理那些冲突较少的情况。在JPA中，乐观锁通常是通过版本号（version）的方式来实现的。当实体被更新时，版本号也会随之递增。如果两个事务尝试更新同一个实体，那么后一个事务必须检查其版本号是否与数据库中的版本号一致。如果不一致，则说明实体已经被另一个事务更新过，这时后一个事务就会失败。

1.1 添加版本字段

在实体类中添加一个版本字段，并使用@Version注解标记它。

import javax.persistence.*;

@Entity
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    @Version
    private int version;  // 版本号字段

    // Getters and setters
}

1.2 更新实体

当你尝试更新实体时，Spring Data JPA会自动检查版本号是否一致。

@Service
public class ProductService {

    private final ProductRepository productRepository;

    public ProductService(ProductRepository productRepository) {
        this.productRepository = productRepository;
    }

    public void updateProduct(Long id, String newName) {
        Product product = productRepository.findById(id).orElseThrow(() -> new RuntimeException("Product not found"));
        product.setName(newName);  // 修改名字
        productRepository.save(product);  // 保存
    }
}

如果两个线程同时尝试更新同一个实体，后一个线程的更新将会抛出OptimisticLockException异常，表明实体已经被另一个事务更新。

2. 悲观锁 (@Lock)

悲观锁是一种较为保守的并发控制策略，它假设最坏的情况会发生。悲观锁通常在更新数据之前就锁定数据，直到事务结束。在JPA中，悲观锁可以通过@Lock注解来实现。

2.1 使用@Lock

要使用悲观锁，你需要在Repository方法上添加@Lock注解，并指定锁定模式。

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Lock;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.transaction.annotation.Transactional;

import javax.persistence.LockModeType;

public interface ProductRepository extends JpaRepository<Product, Long> {

    @Lock(LockModeType.PESSIMISTIC_WRITE)
    Optional<Product> findByIdWithPessimisticLock(Long id);

    @Transactional
    @Modifying
    @Query("UPDATE Product p SET p.name = :name WHERE p.id = :id")
    int updateProductNameById(@Param("id") Long id, @Param("name") String name);
}

这里我们定义了一个findByIdWithPessimisticLock方法，它使用悲观锁来加载实体。我们还定义了一个updateProductNameById方法，用于更新产品的名称。

2.2 使用悲观锁

在服务层中，你可以调用findByIdWithPessimisticLock方法来获取并锁定实体。

@Service
public class ProductService {

    private final ProductRepository productRepository;

    public ProductService(ProductRepository productRepository) {
        this.productRepository = productRepository;
    }

    public void updateProduct(Long id, String newName) {
        Optional<Product> optionalProduct = productRepository.findByIdWithPessimisticLock(id);
        if (optionalProduct.isPresent()) {
            Product product = optionalProduct.get();
            product.setName(newName);  // 修改名字
            productRepository.updateProductNameById(id, newName);  // 保存
        } else {
            throw new RuntimeException("Product not found");
        }
    }
}

3. 示例代码

下面是一个完整的示例，展示如何使用@Version和@Lock注解。

3.1 Product Entity

import javax.persistence.*;

@Entity
public class Product {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    @Version
    private int version;  // 版本号字段

    // Getters and setters
}

3.2 Product Repository

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Lock;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.transaction.annotation.Transactional;

import javax.persistence.LockModeType;

public interface ProductRepository extends JpaRepository<Product, Long> {

    @Lock(LockModeType.PESSIMISTIC_WRITE)
    Optional<Product> findByIdWithPessimisticLock(Long id);

    @Transactional
    @Modifying
    @Query("UPDATE Product p SET p.name = :name WHERE p.id = :id")
    int updateProductNameById(@Param("id") Long id, @Param("name") String name);
}

3.3 Product Service

@Service
public class ProductService {

    private final ProductRepository productRepository;

    public ProductService(ProductRepository productRepository) {
        this.productRepository = productRepository;
    }

    public void updateProduct(Long id, String newName) {
        Optional<Product> optionalProduct = productRepository.findByIdWithPessimisticLock(id);
        if (optionalProduct.isPresent()) {
            Product product = optionalProduct.get();
            product.setName(newName);  // 修改名字
            productRepository.updateProductNameById(id, newName);  // 保存
        } else {
            throw new RuntimeException("Product not found");
        }
    }
}

总结

通过使用@Version和@Lock注解，你可以很容易地在Spring Data JPA中实现乐观锁和悲观锁。这两种锁机制各有优缺点，选择哪种取决于你的具体应用场景。乐观锁适用于冲突较少的情况，而悲观锁则适用于冲突较多的情况。