使用SpringBoot-JPA進行自定義的儲存及批量儲存

鵬徙南暝發表於2019-06-14
Spring Boot

更多精彩博文，歡迎訪問我的個人部落格

說明

SpringBoot版本：2.1.4.RELEASE

java版本：1.8

文中所說JPA皆指spring-boot-starter-data-jpa

使用JPA儲存一個Student物件

在JPA中儲存一個物件，僅需要該物件，一個倉儲即可。
StudentDO實體類：

@Getter
@Setter
@Entity
@Table(name = "t_student")
public class StudentDO {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column
    private Long id;
    @Column
    private String seq;
    @Column
    private String name;
    @Column
    private int sex;
}

JPA倉儲：

@Repository
public interface StudentRepo extends JpaRepository<StudentDO, String> {
}

一般的，我們只需要呼叫StudentRepo.save()方法即可完成對實體物件的儲存操作。

    @Test
    public void testSave() {
        StudentDO student = new StudentDO();
        student.setName("張三");
        student.setSex(1);
        student.setSeq("123456");
        studentRepo.save(student);
        Assert.assertNotNull(student.getId());
    }

在插入過程中使用mysql函式

如果我們希望student的seq值由系統自動生成，且生成規則為“yyMMdd + 8位自增序列”（例如19060310000000）又該如何實現呢？

首先想到的是該如何生成這一串序列，mysql不像oracle自身支援sequence，因此在這裡可以借用函式以及額外的sequence表來實現這一操作，網上有很多實現方式，這裡就不再贅述。

現在已經有了函式getseq('student_seq')可以獲取到該序列，該如何將其應用到儲存物件的方法中？顯然的一個問題是，像上面那樣再直接呼叫save方法已經行不通了，應該得需要自定義插入的sql實現。

一個容易想到的辦法是，在StudentDO類上使用註解@SQLInsert來定義insert的實現，它寫起來應該會像這個樣子：

@SQLInsert(sql = "INSERT INTO t_student(seq, name, sex) VALUES (getseq('student_seq'), ?, ?")

這條sql語句本身並沒有什麼問題，再次呼叫save()方法也確實能夠執行。但是很可惜，它確會丟擲一個sql異常：

java.sql.SQLException: Parameter index out of range (3 > number of parameters, which is 2).

顯然是程式認為有多少個引數，就得有多少個“?”與之匹配，目前我並沒有找到解決這個問題的方案，所以這種方法宣告失敗。

既然@SQLInsert行不通，或許可以考慮使用@Query註解來自定義一個實現。我們可以在StudentRepo中定義這樣一個方法：

    @Transactional
    @Modifying
    @Query(value = "INSERT INTO t_student(seq, name, sex) VALUES (getseq('student_seq'), :#{#student.name}, :#{#student.sex})", nativeQuery = true)
    int insert(@Param("student") StudentDO student);

試著執行一下，結果很成功，物件被正常的儲存到資料庫中，並且seq的取值也正常。看上去我們的問題已經得到了解決，但事實真的如此麼？

自定義的批量儲存

上面的例子中，我們成功通過JPA呼叫了mysql函式將物件儲存到資料庫中。但上面的例子只提供了單個儲存的方法，如果我們想批量儲存呢？@Query裡面的sql能夠進行改造麼？我並沒有找到@Query中使用List作為引數的insert方法，但是這並不代表這一操作不能執行。JPA仍舊提供給了使用者原始的使用方式：利用EntityManager來構造sql並執行。

    @PersistenceContext
    private EntityManager entityManager;

    private int batchInsert(List<StudentDO> students) {
        StringBuilder sb = new StringBuilder();
        sb.append("INSERT INTO t_student(seq, name, sex) VALUES ");
        for(StudentDO student : students) {
            sb.append("(getseq('student_seq'), ?, ?),");
        }
        String sql = sb.toString().substring(0, sb.length() - 1);
        Query query = entityManager.createNativeQuery(sql);
        int paramIndex = 1;
        for(StudentDO student : students) {
            query.setParameter(paramIndex++, student.getName());
            query.setParameter(paramIndex++, student.getSex());
        }
        return query.executeUpdate();
    }

就像MyBatis一樣，使用者也可以自定義SQL來執行，試試看，同樣沒有問題，再多的資料也可以被儲存到資料庫中！批量儲存的效果達到了。

再仔細想一想，通過上面的過程，還有什麼問題麼？對比JPA自帶的save()方法，似乎我們的自定義儲存返回的都是int結果，也就是操作影響的資料庫行數。使用過JPA的人都應該瞭解，JPA的save()方法（或者其他JPA方法）返回的物件是經過持久化的，得益於這一特性，使用者可以在呼叫save()方法之後獲取到物件的id等必須先插入到資料庫之後才會有的值。顯然這裡的操作已經失去了這一特性，那如果我們把返回值對應的改為Object或者List可以做到麼？答案是並不能，我們會得到如下異常：

org.springframework.dao.InvalidDataAccessApiUsageException: Modifying queries can only use void or int/Integer as return type!; nested exception is java.lang.IllegalArgumentException: Modifying queries can only use void or int/Integer as return type!

insert方法必須使用@Modifying進行註解，而@Modifying註解的方法又只能返回int型別的結果。這種情況下或許只能先利用查詢得到seq的值再進行操作。

總結

對於JPA的使用還不夠了解，一些複雜的情況下沒有找到最理想的實現方案。

  1. @Query註解中是否能夠使用List以及實現動態拼接引數的效果沒有得到解決
  2. 自定義的sql語句返回持久化物件的問題沒有方案

在以後的使用瞭解中希望能夠找到解決辦法，將問題記錄在這裡，以便後續檢視。

更多精彩博文，歡迎訪問我的個人部落格

相關文章