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

更多精彩博文，歡迎訪問個人我的博客

---

說明

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, Long> {
}
複製代碼

通常的，咱們只須要調用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語句返回持久化對象的問題沒有方案

在之後的使用瞭解中但願可以找到解決辦法，將問題記錄在這裏，以便後續查看。

---

更多精彩博文，歡迎訪問個人我的博客