使用SpringBoot-JPA進(jìn)行自定義保存及批量保存功能

更新時(shí)間：2019年06月14日 14:41:28 作者：鵬徙南暝

這篇文章主要介紹了使用SpringBoot-JPA進(jìn)行自定義的保存及批量保存功能，本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值,需要的朋友可以參考下

說(shuō)明

SpringBoot版本：2.1.4.RELEASE

java版本：1.8

文中所說(shuō)JPA皆指spring-boot-starter-data-jpa

使用JPA保存一個(gè)Student對(duì)象

在JPA中保存一個(gè)對(duì)象，僅需要該對(duì)象，一個(gè)倉(cāng)儲(chǔ)即可。
StudentDO實(shí)體類：

@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倉(cāng)儲(chǔ)：

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

一般的，我們只需要調(diào)用StudentRepo.save()方法即可完成對(duì)實(shí)體對(duì)象的保存操作。

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

在插入過(guò)程中使用mysql函數(shù)

如果我們希望student的seq值由系統(tǒng)自動(dòng)生成，且生成規(guī)則為“yyMMdd + 8位自增序列”（例如19060310000000）又該如何實(shí)現(xiàn)呢？

首先想到的是該如何生成這一串序列，mysql不像oracle自身支持sequence，因此在這里可以借用函數(shù)以及額外的sequence表來(lái)實(shí)現(xiàn)這一操作，網(wǎng)上有很多實(shí)現(xiàn)方式，這里就不再贅述。

現(xiàn)在已經(jīng)有了函數(shù)getseq('student_seq')可以獲取到該序列，該如何將其應(yīng)用到保存對(duì)象的方法中？顯然的一個(gè)問(wèn)題是，像上面那樣再直接調(diào)用save方法已經(jīng)行不通了，應(yīng)該得需要自定義插入的sql實(shí)現(xiàn)。

一個(gè)容易想到的辦法是，在StudentDO類上使用注解@SQLInsert來(lái)定義insert的實(shí)現(xiàn)，它寫起來(lái)應(yīng)該會(huì)像這個(gè)樣子：

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

這條sql語(yǔ)句本身并沒(méi)有什么問(wèn)題，再次調(diào)用save()方法也確實(shí)能夠執(zhí)行。但是很可惜，它確會(huì)拋出一個(gè)sql異常：

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

顯然是程序認(rèn)為有多少個(gè)參數(shù)，就得有多少個(gè)“?”與之匹配，目前我并沒(méi)有找到解決這個(gè)問(wèn)題的方案，所以這種方法宣告失敗。

既然@SQLInsert行不通，或許可以考慮使用@Query注解來(lái)自定義一個(gè)實(shí)現(xiàn)。我們可以在StudentRepo中定義這樣一個(gè)方法：

@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);

試著運(yùn)行一下，結(jié)果很成功，對(duì)象被正常的存儲(chǔ)到數(shù)據(jù)庫(kù)中，并且seq的取值也正常?？瓷先ノ覀兊膯?wèn)題已經(jīng)得到了解決，但事實(shí)真的如此么？

自定義的批量存儲(chǔ)

上面的例子中，我們成功通過(guò)JPA調(diào)用了mysql函數(shù)將對(duì)象存儲(chǔ)到數(shù)據(jù)庫(kù)中。但上面的例子只提供了單個(gè)保存的方法，如果我們想批量保存呢？@Query里面的sql能夠進(jìn)行改造么？我并沒(méi)有找到@Query中使用List作為參數(shù)的insert方法，但是這并不代表這一操作不能執(zhí)行。JPA仍舊提供給了使用者原始的使用方式：利用EntityManager來(lái)構(gòu)造sql并執(zhí)行。

 @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來(lái)執(zhí)行，試試看，同樣沒(méi)有問(wèn)題，再多的數(shù)據(jù)也可以被保存到數(shù)據(jù)庫(kù)中！批量保存的效果達(dá)到了。

再仔細(xì)想一想，通過(guò)上面的過(guò)程，還有什么問(wèn)題么？對(duì)比JPA自帶的save()方法，似乎我們的自定義保存返回的都是int結(jié)果，也就是操作影響的數(shù)據(jù)庫(kù)行數(shù)。使用過(guò)JPA的人都應(yīng)該了解，JPA的save()方法（或者其他JPA方法）返回的對(duì)象是經(jīng)過(guò)持久化的，得益于這一特性，使用者可以在調(diào)用save()方法之后獲取到對(duì)象的id等必須先插入到數(shù)據(jù)庫(kù)之后才會(huì)有的值。顯然這里的操作已經(jīng)失去了這一特性，那如果我們把返回值對(duì)應(yīng)的改為Object或者List可以做到么？答案是并不能，我們會(huì)得到如下異常：

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進(jìn)行注解，而@Modifying注解的方法又只能返回int類型的結(jié)果。這種情況下或許只能先利

用查詢得到seq的值再進(jìn)行操作。

總結(jié)

對(duì)于JPA的使用還不夠了解，一些復(fù)雜的情況下沒(méi)有找到最理想的實(shí)現(xiàn)方案。