Spring JPA save 实现主键重复抛异常

Introduction

先说说要做的功能

希望用数据库的 duplicate primary key 来实现一个简易的锁功能，加锁成功与否取决于是否成功 insert，此时必须要明确的执行 insert sql，而不是 update sql

本文以一个简单地订单锁作为例子，数据库字段信息如下：

create table order_lock (
    order_number varchar(20) not null primary key,
    user_name varchar(100) not null,
    created_time datetime default CURRENT_TIMESTAMP null

再说说 JPA 的 save

JPA 的 save 默认会判断是否为新数据，若为新的则 insert / persist，否则 update / merge，而 JPA 对于是否为“新”的定义是。。。。

实际上在 save 时会生成两条 sql 语句分别执行：

Hibernate: 
    select
        orderl0_.order_number as order_nu1_12_0_,
        orderl0_.created_time as created_2_12_0_,
        orderl0_.user_name as user_nam4_12_0_ 
        order_lock orderl0_ 
    where
        orderl0_.order_number=?
[V][2019-11-04 15:03:06,602][INFO ][http-nio-9091-exec-9][OrderLockService][lockOrder][][][][] - order lock start lock: order number:aaaaaaaaaaaaaaaa, user name: zzz2
Hibernate: 
    insert 
        order_lock
        (created_time user_name, order_number) 
    values
        (?, ?, ?)

当我们第一次调用的时候，createdTime 自动生成，当第二次调用的时候，因为包含了这个字段，select 有了结果，第二个 sql 成为了 update：

Hibernate: 
    select
        orderl0_.order_number as order_nu1_12_0_,
        orderl0_.created_time as created_2_12_0_,
        orderl0_.user_name as user_nam4_12_0_ 
        order_lock orderl0_ 
    where
        orderl0_.order_number=?
Hibernate: 
    update
            order_lock 
            created_time=? 
        where
            order_number=?

good，我们第二次创建没有报错，但是 createdTime 成了 null

作为数据库的主键，唯一性已经保证了不会出现一个订单有多个锁的情况，若不希望自己主动地 find 后再 save，那就必须让 JPA 固定的生成 insert sql，利用 db 报错来发现重复锁的问题

除此以外第二个问题，每次 save 都会先 select，对于 db 通过主键就能判断成功与否的需求，却执行了两个 sql 性能上浪费 50%

结论

时间很宝贵，先给出最后的结论，再记录翻源码的过程

方案 1 – 优雅的解决问题

自定义的 Entity class 实现 Persistable interface 的 isNew method，固定返回 true，则在 JPA save 时一定会执行 insert sql，对于简单地订单锁的 Entity 如下：

@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
@Table(name = "order_lock")
public class OrdertLock implements Persistable {
    private String orderNumber;
    @Column(updatable = false, nullable = false)
    private String userName;
    @CreationTimestamp
    private Date createdTime;
    @Override
    public Object getId() {
        return orderNumber;
    @Override
    public boolean isNew() {
        return true;
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        if (o == null || getClass() != o.getClass()) {
            return false;
        OrderEditLock orderEditLock = (OrderEditLock) o;
        return Objects.equals(orderNumber, orderEditLock.orderNumber);
    @Override
    public int hashCode() {
        return Objects.hash(orderNumber);

看看修改后的 JPA 行为

JPA 直接生成了 insert 语句，select 也没有生成，一个 sql 解决问题。

Hibernate: 
    insert 
        order_lock
        (created_time, user_name, order_number) 
    values
        (?, ?, ?)

当主键重复的时候抛出 org.springframework.dao.DataIntegrityViolationException；com.mysql.jdbc.exceptions.jdbc4.MySQLIntegrityConstraintViolationException: Duplicate entry 'XXXXXXXXX' for key 'PRIMARY'

方案 2 – 万能的 @Query 解决一切

Entity 不做改变，直接 Repository 自定义 Query

@Modifying
@Query(nativeQuery = true,
       value = "INSERT INTO " +
       "order_lock(order_number, user_name) " +
       "VALUES (:orderNumber, :userName);")
void lockOrder(@Param("orderNumber") String orderNumber,
               @Param("userName") String userName);

此时也是生成一个 sql：

Hibernate: 
    INSERT 
        service_order_edit_lock
        (order_number, user_name) 
    VALUES
        (?, ?);

若主键重复抛出异常一样是： org.springframework.dao.DataIntegrityViolationException；com.mysql.jdbc.exceptions.jdbc4.MySQLIntegrityConstraintViolationException: Duplicate entry 'XXXXXXXXX' for key 'PRIMARY'

注意：生成的 sql 对于未填写的字段处理方式不同，一个是 field 全量生成 sql， 一个是可以自定义传递哪些 field

沉入源码

先上个关系图，Markdown写的，不是 UML，箭头指向方向为实现/继承/依赖……反正就是起点用到了终点。。。。原谅我偷懒