分享JPA的幾個小技巧

更新時間：2021年03月12日 09:59:41 作者：小姐姐味道

這篇文章主要分享了JPA的幾個小技巧，幫助大家更好的理解和學習使用Java，感興趣的朋友可以了解下

了解到一些大廠（阿里、騰訊、抖音等），JPA的使用也越來越廣泛了，包括我們公司，這是把合適的工具放到了合適的地方。如果想要快速開發(fā)，JPA無疑是一個比較好的選擇。你無需關注數據庫表的結構，使用代碼驅動即可完成工作，管它后面是MySQL還是Oracle。JPA把數據庫相關的知識給弱化了，讓你專注于業(yè)務開發(fā)。

我個人曾是非常排斥JPA這種弱化SQL的工具的，這源于對早起Hibernate版本的錯誤認識。但嘗試過mybatis、spring-data-jdbc、jooq后，發(fā)現這個東西是真的香！一個遲到的贊，送給JPA。

這對一些管理系統(tǒng)來說，非常合適。因為性能并不是這些系統(tǒng)主要的痛點，業(yè)務復雜性才是。

本文將介紹一個簡單的實體類，需要準備哪些基本字段。這些字段，又是如何在代碼中被使用的。

1. 基本字段介紹

首先看一下我們的基礎定義類。

代碼不多，信息卻不少。

下面來一行行解析。

@Data

Data注解是屬于lombok類的，lombok是地球人都知道的代碼簡化工具，提供了非常多的注解。如果你不想記憶太多的注解，直接加上一個Data，是最偷懶的選擇。

@MappedSuperclass

這個注解是JPA的，用來標識父類。標注為@MappedSuperclass的類將不是一個完整的實體類，不會映射到數據庫表，但是它的屬性都將映射到子類的數據庫字段中。放在這里再合適不過了。

@EntityListeners(AuditingEntityListener.class)

開啟自動審計功能，這個和下面的兩個日期字段是相互配合的，我們稍后介紹。

@JsonIgnoreProperties(value = {"hibernateLazyInitializer", "handler"}) //直接使用bean時，避免json序列號失敗

有時候，我們想要再controller層直接使用JPA的實體。但JPA內部其實是有很多附加變量的，比如hibernateLazyInitializer。

為了讓實體在json序列化的時候能夠正常進行，需要忽略這兩個字段。所以這個注解，是屬于jackson json的。

2. 自定義ID生成器

JPA其實提供了非常多的ID生成策略。不過，在互聯網應用下，應用較多的還是雪花算法，因為它有著良好的擴展性，在數據遷移的時候也不會有很多沖突。

為了指定雪花算法，我們需要下面幾行代碼。

 static final String ID_GEN = "cn.xjjdog.bcmall.utils.db.DistributedId";
 @Id
 @GenericGenerator(name = "IdGen", strategy = ID_GEN)
 @GeneratedValue(generator = "IdGen")

其中的一個關鍵，就是使用我們名稱叫做IdGen的ID生成器。這里的代碼，是有一點小遺憾的。由于JVM類加載的緣故，我們無法在注解中直接使用類的名稱(*.class.getName()) 來獲取它的包路徑，只能作為字符串寫死在這里。

下面我們就來看一下這個ID生成器的處理。

public class DistributedId implements IdentifierGenerator {
 @Override
 public Serializable generate(SharedSessionContractImplementor sharedSessionContractImplementor, Object obj) throws HibernateException {
  if (obj == null) throw new HibernateException(new NullPointerException()) ;
  if ((((AbstractEntity) obj).getId()) == null) {
   return String.valueOf(Snowflake.createId());
  } else {
   return ((AbstractEntity) obj).getId();
  }
 }
}

代碼如上。在直接使用之前，我們還做了一點小處理。當我們判斷實體的ID為空的時候，才使用雪花算法構造一個新的ID；否則使用實體原來設置好的ID，保持不變。

為什么這樣做？因為這是有需求的。像訂單這種業(yè)務，你需要先生成一個訂單號，然后再更新一些數據庫信息，發(fā)布一些消息等；而不是在保存動作出發(fā)的時候才生成一個。

如果你不做上面代碼的處理。JPA將每次保存的時候都自動生成一個，覆蓋了你原有的。我就在這里吃過虧，通過debug代碼才進行的修復。

3. 自動填充字段

上面說到createdDate和lastModifiedDate兩個字段，其實在使用的時候，是不需要手動去設值的。這兩個值，將通過審計功能自動完成。

@EntityListeners(AuditingEntityListener.class)

當然，我們還要用特有的注解，來標識這兩個字段。

/**
* 創(chuàng)建時間
*/
@CreatedDate
private Date createdDate;

/**
 * 更新時間
*/
@LastModifiedDate
private Date lastModifiedDate;

最后，不要忘了在全局配置中通過Config開啟這個功能。

@Configuration
@EnableJpaAuditing
public class JpaConfig {
}

當然，審計是不能沒有用戶的。所以這個系列還有@CreatedBy注解，用來標注是誰創(chuàng)建的。你需要在代碼中組裝它們，比如下面的代碼，就是從Spring Sercurity中獲取用戶信息。

@Configuration
@Slf4j
public class UserAuditor implements AuditorAware<String> {
 @Override
 public Optional<String> getCurrentAuditor() {
  UserDetails user;
  try {
   user = (UserDetails) SecurityContextHolder.getContext().getAuthentication().getPrincipal();
   return Optional.ofNullable(user.getUsername());
  }catch (Exception e){
   return Optional.empty();
  }
 }
}