原文連結: 191119-SpringBoot系列教程JPA之指定id儲存

前幾天有位小夥伴問了一個很有意思的問題，使用 JPA 儲存資料時，即便我指定了主鍵 id，但是新插入的資料主鍵卻是 mysql 自增的 id；那麼是什麼原因導致的呢？又可以如何解決呢?

本文將介紹一下如何使用 JPA 的 AUTO 儲存策略來指定資料庫主鍵 id

I. 環境準備

實際開始之前，需要先走一些必要的操作，如安裝測試使用 mysql，建立 SpringBoot 專案工程，設定好配置資訊等，關於搭建專案的詳情可以參考前一篇文章 190612-SpringBoot 系列教程 JPA 之基礎環境搭建

下面簡單的看一下後續的程式碼中，需要的配置 （我們使用的是 mysql 資料庫）

1. 表準備

沿用前一篇的表，結構如下

CREATE TABLE `money` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT '' COMMENT '使用者名稱',
  `money` int(26) NOT NULL DEFAULT '0' COMMENT '錢',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
  `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '建立時間',
  `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新時間',
  PRIMARY KEY (`id`),
  KEY `name` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;
 

2. 專案配置

配置資訊，與之前有一點點區別，我們新增了更詳細的日誌列印；本篇主要目標集中在新增記錄的使用姿勢，對於配置說明，後面單獨進行說明

## DataSource
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=
## jpa相關配置
spring.jpa.database=MYSQL
spring.jpa.hibernate.ddl-auto=none
spring.jpa.show-sql=true
spring.jackson.serialization.indent_output=true
spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
 

II. Insert 教程

首先簡單的看一下，我們一般使用預設的資料庫自增生成主鍵的使用方式，以便後面的自定義主鍵生成策略的對比

對於 jpa 的插入資料的知識點不太清楚的同學，可以看一下之前的博文： 190614-SpringBoot 系列教程 JPA 之新增記錄使用姿勢

1. 自增主鍵

首先我們需要定義 PO，與資料庫中的表繫結起來

@Data
@DynamicUpdate
@DynamicInsert
@Entity
@Table(name = "money")
public class MoneyPO {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Integer id;

    @Column(name = "name")
    private String name;

    @Column(name = "money")
    private Long money;

    @Column(name = "is_deleted")
    private Byte isDeleted;

    @Column(name = "create_at")
    @CreatedDate
    private Timestamp createAt;

    @Column(name = "update_at")
    @CreatedDate
    private Timestamp updateAt;
}

注意上面的主鍵生成策略用的是 GenerationType.IDENTITY，配合 mysql 的使用就是利用資料庫的自增來生成主鍵 id

/**
 * 新增資料
 * Created by @author yihui in 11:00 19/6/12.
 */
public interface MoneyCreateRepositoryV2 extends JpaRepository<MoneyPO, Integer> {
}

接下來儲存資料就很簡單了

private void addWithId() {
    MoneyPO po1 = new MoneyPO();
    po1.setId(20);
    po1.setName("jpa 一灰灰 1x");
    po1.setMoney(2200L + ((long) (Math.random() * 100)));
    po1.setIsDeleted((byte) 0x00);
    MoneyPO r1 = moneyCreateRepositoryV2.save(po1);
    System.out.println("after insert res: " + r1);
}

強烈建議實際的體驗一下上面的程式碼執行

首次執行確保資料庫中不存在 id 為 20 的記錄，雖然我們的 PO 物件中，指定了 id 為 20，但是執行完畢之後，新增的資料 id 卻不是 20

Hibernate: select moneypo0_.id as id1_0_0_, moneypo0_.create_at as create_a2_0_0_, moneypo0_.is_deleted as is_delet3_0_0_, moneypo0_.money as money4_0_0_, moneypo0_.name as name5_0_0_, moneypo0_.update_at as update_a6_0_0_ from money moneypo0_ where moneypo0_.id=?
Hibernate: insert into money (is_deleted, money, name) values (?, ?, ?)
after insert res: MoneyPO(id=104, name=jpa 一灰灰 1x, money=2208, isDeleted=0, createAt=null, updateAt=null)

上面是執行的 sql 日誌，注意插入的 sql，是沒有指定 id 的，所以新增的記錄的 id 就會利用 mysql 的自增策略

當我們的 db 中存在 id 為 20 的記錄時，再次執行，檢視日誌發現實際執行的是更新資料

Hibernate: select moneypo0_.id as id1_0_0_, moneypo0_.create_at as create_a2_0_0_, moneypo0_.is_deleted as is_delet3_0_0_, moneypo0_.money as money4_0_0_, moneypo0_.name as name5_0_0_, moneypo0_.update_at as update_a6_0_0_ from money moneypo0_ where moneypo0_.id=?
Hibernate: update money set create_at=?, money=?, name=?, update_at=? where id=?
after insert res: MoneyPO(id=20, name=jpa 一灰灰 1x, money=2234, isDeleted=0, createAt=null, updateAt=null)

大膽猜測，save 的執行過程邏輯如

• 首先根據 id 到資料庫中查詢對應的資料
• 如果資料不存在，則新增（插入 sql 不指定 id）
• 如果資料存在，則判斷是否有變更，以確定是否需要更新

2. 指定 id

那麼問題來了，如果我希望當我的 po 中指定了資料庫 id 時，db 中沒有這條記錄時，就插入 id 為指定值的記錄；如果存在記錄，則更新

要實現上面這個功能，自定義主鍵 id，那麼我們就需要修改一下主鍵的生成策略了，官方提供了四種

取值	說明
GenerationType.TABLE	使用一個特定的資料庫表格來儲存主鍵
GenerationType.SEQUENCE	根據底層資料庫的序列來生成主鍵，條件是資料庫支援序列
GenerationType.IDENTITY	主鍵由資料庫自動生成（主要是自動增長型）
GenerationType.AUTO	主鍵由程式控制

從上面四種生成策略說明中，很明顯我們要使用的就是 AUTO 策略了，我們新增一個 PO，並指定儲存策略

@Data
@DynamicUpdate
@DynamicInsert
@Entity
@Table(name = "money")
public class AutoMoneyPO {
    @Id
    @GeneratedValue(strategy = GenerationType.AUTO, generator = "myid")
    @GenericGenerator(name = "myid", strategy = "com.git.hui.boot.jpa.generator.ManulInsertGenerator")
    @Column(name = "id")
    private Integer id;

    @Column(name = "name")
    private String name;

    @Column(name = "money")
    private Long money;

    @Column(name = "is_deleted")
    private Byte isDeleted;

    @Column(name = "create_at")
    @CreatedDate
    private Timestamp createAt;

    @Column(name = "update_at")
    @CreatedDate
    private Timestamp updateAt;
}

採用自定義的生成策略，需要注意，@GenericGenerator(name = "myid", strategy = "com.git.hui.boot.jpa.generator.ManulInsertGenerator")這個需要有，否則執行會拋異常

這一行程式碼的意思是，主鍵 id 是由ManulInsertGenerator來生成

/**
 *  自定義的主鍵生成策略，如果填寫了主鍵id，如果資料庫中沒有這條記錄，則新增指定id的記錄；否則更新記錄
 *
 *  如果不填寫主鍵id，則利用資料庫本身的自增策略指定id
 *
 * Created by @author yihui in 20:51 19/11/13.
 */
public class ManulInsertGenerator extends IdentityGenerator {

    @Override
    public Serializable generate(SharedSessionContractImplementor s, Object obj) throws HibernateException {
        Serializable id = s.getEntityPersister(null, obj).getClassMetadata().getIdentifier(obj, s);

        if (id != null && Integer.valueOf(id.toString()) > 0) {
            return id;
        } else {
            return super.generate(s, obj);
        }
    }
}

具體的主鍵生成方式也比較簡單了，首先是判斷 PO 中有沒有主鍵，如果有則直接使用 PO 中的主鍵值；如果沒有，就利用IdentityGenerator策略來生成主鍵（而這個主鍵生成策略，正好是GenerationType.IDENTITY利用資料庫自增生成主鍵的策略）

接下來我們再次測試插入

// 使用自定義的主鍵生成策略
AutoMoneyPO moneyPO = new AutoMoneyPO();
moneyPO.setId(20);
moneyPO.setName("jpa 一灰灰 ex");
moneyPO.setMoney(2200L + ((long) (Math.random() * 100)));
moneyPO.setIsDeleted((byte) 0x00);
AutoMoneyPO res = moneyCreateRepositoryWithId.save(moneyPO);
System.out.println("after insert res: " + res);

moneyPO.setMoney(3200L + ((long) (Math.random() * 100)));
res = moneyCreateRepositoryWithId.save(moneyPO);
System.out.println("after insert res: " + res);

moneyPO = new AutoMoneyPO();
moneyPO.setName("jpa 一灰灰 2ex");
moneyPO.setMoney(2200L + ((long) (Math.random() * 100)));
moneyPO.setIsDeleted((byte) 0x00);
res = moneyCreateRepositoryWithId.save(moneyPO);
System.out.println("after insert res: " + res);

上面的程式碼執行時，確保資料庫中沒有主鍵為 20 的資料，輸出 sql 日誌如下

# 第一次插入
Hibernate: select automoneyp0_.id as id1_0_0_, automoneyp0_.create_at as create_a2_0_0_, automoneyp0_.is_deleted as is_delet3_0_0_, automoneyp0_.money as money4_0_0_, automoneyp0_.name as name5_0_0_, automoneyp0_.update_at as update_a6_0_0_ from money automoneyp0_ where automoneyp0_.id=?
Hibernate: insert into money (is_deleted, money, name, id) values (?, ?, ?, ?)
after insert res: AutoMoneyPO(id=20, name=jpa 一灰灰 ex, money=2238, isDeleted=0, createAt=null, updateAt=null)

# 第二次指定id插入
Hibernate: select automoneyp0_.id as id1_0_0_, automoneyp0_.create_at as create_a2_0_0_, automoneyp0_.is_deleted as is_delet3_0_0_, automoneyp0_.money as money4_0_0_, automoneyp0_.name as name5_0_0_, automoneyp0_.update_at as update_a6_0_0_ from money automoneyp0_ where automoneyp0_.id=?
Hibernate: update money set create_at=?, money=?, update_at=? where id=?
after insert res: AutoMoneyPO(id=20, name=jpa 一灰灰 ex, money=3228, isDeleted=0, createAt=null, updateAt=null)

# 第三次無id插入
Hibernate: insert into money (is_deleted, money, name) values (?, ?, ?)
after insert res: AutoMoneyPO(id=107, name=jpa 一灰灰 2ex, money=2228, isDeleted=0, createAt=null, updateAt=null)

注意上面的日誌輸出

• 第一次插入時拼裝的寫入 sql 是包含 id 的，也就達到了我們指定 id 新增資料的要求
• 第二次插入時，因為 id=20 的記錄存在，所以執行的是更新操作
• 第三次插入時，因為沒有 id，所以插入的 sql 中也沒有指定 id，使用 mysql 的自增來生成主鍵 id

II. 其他

0. 專案&博文

• 190612-SpringBoot 系列教程 JPA 之基礎環境搭建
• 190614-SpringBoot 系列教程 JPA 之新增記錄使用姿勢
• 190623-SpringBoot 系列教程 JPA 之 update 使用姿勢
• 190702-SpringBoot 系列教程 JPA 之 delete 使用姿勢詳解

• 190717-SpringBoot 系列教程 JPA 之 query 使用姿勢詳解之基礎篇

• 工程：https://github.com/liuyueyi/spring-boot-demo

• module: https://github.com/liuyueyi/spring-boot-demo/blob/master/spring-boot/102-jpa

1. 一灰灰 Blog

盡信書則不如，以上內容，純屬一家之言，因個人能力有限，難免有疏漏和錯誤之處，如發現 bug 或者有更好的建議，歡迎批評指正，不吝感激

下面一灰灰的個人部落格，記錄所有學習和工作中的博文，歡迎大家前去逛逛

• 一灰灰 Blog 個人部落格 https://blog.hhui.top
• 一灰灰 Blog-Spring 專題部落格 http://spring.hhui.top

相關推薦