2. 程式人生 > >Spring Data之EntityManagerFactory建立及原始碼分析

Spring Data之EntityManagerFactory建立及原始碼分析

阿新 • • 發佈：2018-11-30

背景

在Spring Data之JPA開篇中可以看到Spring Boot的啟動日誌，先是建立了HikariDataSource，然後緊接著構建了EntityManagerFactory

2018-10-25 09:32:20.645  INFO 37469 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2018-10-25 09:32:20.791  INFO 37469 --- [           main] com.zaxxer.hikari.
 
HikariDataSource       : HikariPool-1 - Start completed.
2018-10-25 09:32:20.846  INFO 37469 --- [           main] j.LocalContainerEntityManagerFactoryBean : Building JPA container EntityManagerFactory for persistence unit 'default'

其中HikariDataSource的建立在Spring Data之DataSource建立及原始碼分析中進行了介紹，這篇文章我們就來探尋一下EntityManagerFactory是如何自動創建出來的。

JPA規範

首先有必要了解一下JPA規範（JSR 338）以便更好的理解EntityManagerFactory的建立過程。

JSR 338主要定義瞭如何通過普通的Java domain進行關係資料庫的操作及對映，其中主要概念包含如下：

  • Entity
    • 必須是頂級類
    • @Entity註解的類
    • 必須有一個無參的public 或 protected的構造方法
    • 不能是final類，且不能有final方法或final變數
    • 一個Entity類通常與資料庫的一張表進行對應
    • 一個Entity例項表現為資料庫的一條資料
    • 對Entity的操作即對資料庫的操作
    • 生命週期包含初始、託管、釋放、消亡
  • EntityManager
    • 對Entity持久化操作的主要物件
    • 通過EntityManagerFactory獲取例項
    • 一個例項代表一個數據庫連線
    • 每個執行緒擁有自己的EntityManager例項
    • 主要方法有persist、remove、merge、createQuery、find
    • 可使用@PersistenceContext注入
  • EntityManagerFactory
    • 建立EntityManager的工廠
    • EntityManagerFactory的建立成本很高，對於給定的資料庫，系統應該只建立一個與之關聯的Factory
    • 可使用@PersistenceUnit注入
  • EntityTransaction
    • 表示資料庫事務，在增、刪、改時使用
    • 可通過EntityManager.getTransaction()獲取
  • Persistence Context
    • 維護一組託管狀態的Entity例項
    • 與EntityManager是相關聯的
  • Persistence Unit
    • 一組Entity及相關設定的邏輯單元
    • 定義建立EntityManagerFactory所需要的引數
    • 通過persistence.xml定義或者通過一個PersistenceUnitInfo物件

總結一下，通過Persistence Unit建立EntityManagerFactory，再通過EntityManagerFactory獲取EntityManager。下面我們就按照這個方向進行原始碼分析。

自動配置

同DataSource一樣，EntityManagerFactory的建立也是通過一些列@Conditional的註解最終找到Hibernate的實現。我們先看下自動配置的入口類HibernateJpaAutoConfiguration

@Configuration
//先校驗是否存在LocalContainerEntityManagerFactoryBean
//該類是spring-orm包中的類，從名稱上看就知道是跟EntityManagerFactory的建立有關的
//要使用JPA，EntityManager自然也是要存在的
@ConditionalOnClass({ LocalContainerEntityManagerFactoryBean.class, EntityManager.class })
//自定義的校驗類，校驗是否存在CLASS_NAMES中的類
@Conditional(HibernateEntityManagerCondition.class)
//在application.properties中配置的spring.jpa開頭的設定，會注入到JpaProperties中
//換句話說在spring.jpa能設定什麼，要看JpaProperties有什麼屬性
@EnableConfigurationProperties(JpaProperties.class)
//這個設定很關鍵，意思是要在DataSource之後再建立，因為JPA會用到DataSource
@AutoConfigureAfter({ DataSourceAutoConfiguration.class })
//上面的校驗都滿足後，則進入HibernateJpaConfiguration
@Import(HibernateJpaConfiguration.class)
public class HibernateJpaAutoConfiguration {

	@Order(Ordered.HIGHEST_PRECEDENCE + 20)
	static class HibernateEntityManagerCondition extends SpringBootCondition {

		private static final String[] CLASS_NAMES = {
				"org.hibernate.ejb.HibernateEntityManager",
				"org.hibernate.jpa.HibernateEntityManager" };

		/**
		 * 通過ClassUtils.isPresent檢查是否存在CLASS_NAMES中指定的類
		 */
		@Override
		public ConditionOutcome getMatchOutcome(ConditionContext context,
				AnnotatedTypeMetadata metadata) {
			ConditionMessage.Builder message = ConditionMessage
					.forCondition("HibernateEntityManager");
			for (String className : CLASS_NAMES) {
				if (ClassUtils.isPresent(className, context.getClassLoader())) {
					return ConditionOutcome
							.match(message.found("class").items(Style.QUOTE, className));
				}
			}
			return ConditionOutcome.noMatch(message.didNotFind("class", "classes")
					.items(Style.QUOTE, Arrays.asList(CLASS_NAMES)));
		}
	}
}

主要邏輯已在程式碼中添加註釋說明，接下來就看下@Import的HibernateJpaConfiguration

@Configuration
@ConditionalOnSingleCandidate(DataSource.class)
class HibernateJpaConfiguration extends JpaBaseConfiguration {
	//省略。。。
	
	@Override
	protected AbstractJpaVendorAdapter createJpaVendorAdapter() {
		return new HibernateJpaVendorAdapter();
	}
	
	//省略。。。
}

省略了一些不重要的程式碼，只留下createJpaVendorAdapter方法。再接著看父類JpaBaseConfiguration

@EnableConfigurationProperties(JpaProperties.class)
@Import(DataSourceInitializedPublisher.Registrar.class)
public abstract class JpaBaseConfiguration implements BeanFactoryAware {

	private final DataSource dataSource;

	private final JpaProperties properties;

	private final JtaTransactionManager jtaTransactionManager;

	private final TransactionManagerCustomizers transactionManagerCustomizers;

	private ConfigurableListableBeanFactory beanFactory;

	protected JpaBaseConfiguration(DataSource dataSource, JpaProperties properties,
			ObjectProvider<JtaTransactionManager> jtaTransactionManager,
			ObjectProvider<TransactionManagerCustomizers> transactionManagerCustomizers) {
		this.dataSource = dataSource;
		this.properties = properties;
		this.jtaTransactionManager = jtaTransactionManager.getIfAvailable();
		this.transactionManagerCustomizers = transactionManagerCustomizers
				.getIfAvailable();
	}

	@Bean
	@ConditionalOnMissingBean
	public PlatformTransactionManager transactionManager() {
		JpaTransactionManager transactionManager = new JpaTransactionManager();
		if (this.transactionManagerCustomizers != null) {
			this.transactionManagerCustomizers.customize(transactionManager);
		}
		return transactionManager;
	}

	@Bean
	@ConditionalOnMissingBean
	public JpaVendorAdapter jpaVendorAdapter() {
		AbstractJpaVendorAdapter adapter = createJpaVendorAdapter();
		adapter.setShowSql(this.properties.isShowSql());
		adapter.setDatabase(this.properties.determineDatabase(this.dataSource));
		adapter.setDatabasePlatform(this.properties.getDatabasePlatform());
		adapter.setGenerateDdl(this.properties.isGenerateDdl());
		return adapter;
	}

	@Bean
	@ConditionalOnMissingBean
	public EntityManagerFactoryBuilder entityManagerFactoryBuilder(
			JpaVendorAdapter jpaVendorAdapter,
			ObjectProvider<PersistenceUnitManager> persistenceUnitManager) {
		EntityManagerFactoryBuilder builder = new EntityManagerFactoryBuilder(
				jpaVendorAdapter, this.properties.getProperties(),
				persistenceUnitManager.getIfAvailable());
		builder.setCallback(getVendorCallback());
		return builder;
	}

	@Bean
	@Primary
	@ConditionalOnMissingBean({ LocalContainerEntityManagerFactoryBean.class,
			EntityManagerFactory.class })
	public LocalContainerEntityManagerFactoryBean entityManagerFactory(
			EntityManagerFactoryBuilder factoryBuilder) {
		Map<String, Object> vendorProperties = getVendorProperties();
		customizeVendorProperties(vendorProperties);
		return factoryBuilder.dataSource(this.dataSource).packages(getPackagesToScan())
				.properties(vendorProperties).mappingResources(getMappingResources())
				.jta(isJta()).build();
	}

	protected abstract AbstractJpaVendorAdapter createJpaVendorAdapter();

}

可以看到該類有4個@Bean註解的方法，咱們按順序分析

  1. transactionManager
    建立JPA事務的管理器

  2. jpaVendorAdapter
    JpaVendorAdapter是一個介面，裡面有一個方法是getPersistenceProvider，而PersistenceProvider是JPA規範中定義的建立EntityManagerFactory的介面方法。
    createJpaVendorAdapter的實現是在HibernateJpaConfiguration中返回的是 HibernateJpaVendorAdapter.

    public class HibernateJpaVendorAdapter extends AbstractJpaVendorAdapter{
   private final HibernateJpaDialect jpaDialect = new HibernateJpaDialect();

   private final PersistenceProvider persistenceProvider;

   private final Class<? extends EntityManagerFactory> entityManagerFactoryInterface;

   private final Class<? extends EntityManager> entityManagerInterface;

  /**
  	* 明確指明瞭persistenceProvider的實現是SpringHibernateJpaPersistenceProvider
  	*/
   @SuppressWarnings("deprecation")
   public HibernateJpaVendorAdapter() {
       this.persistenceProvider = new SpringHibernateJpaPersistenceProvider();
       this.entityManagerFactoryInterface = org.hibernate.jpa.HibernateEntityManagerFactory.class;
       this.entityManagerInterface = org.hibernate.jpa.HibernateEntityManager.class;
   }
}


    /**
 * 繼承了Hibernate的PersistenceProvider
 */
class SpringHibernateJpaPersistenceProvider extends HibernatePersistenceProvider{

   /**
    * 重要方法，呼叫了Hibernate的EntityManagerFactoryBuilderImpl，通過build創建出了EntityManagerFactory
    */
   public EntityManagerFactory createContainerEntityManagerFactory(PersistenceUnitInfo info, Map properties) {
   	final List<String> mergedClassesAndPackages = new ArrayList<>(info.getManagedClassNames());
   	if (info instanceof SmartPersistenceUnitInfo) {
   		mergedClassesAndPackages.addAll(((SmartPersistenceUnitInfo) info).getManagedPackages());
   	}
   	return new EntityManagerFactoryBuilderImpl(
   			new PersistenceUnitInfoDescriptor(info) {
   				@Override
   				public List<String> getManagedClassNames() {
   					return mergedClassesAndPackages;
   				}
   			}, properties).build();
   }
}

  3. entityManagerFactoryBuilder
    建造者模式，將需要的原料都準備好

  4. entityManagerFactory
    LocalContainerEntityManagerFactoryBean就是啟動日誌中打印出*Building JPA container EntityManagerFactory for persistence unit ‘default’*的類。
    該類及其父類AbstractEntityManagerFactoryBean包含了建立EntityManagerFactory的所有元素，前面的步驟都是在為LocalContainerEntityManagerFactoryBean的屬性準備資料賦值

    public class LocalContainerEntityManagerFactoryBean extends AbstractEntityManagerFactoryBean
   implements ResourceLoaderAware, LoadTimeWeaverAware {
    /**
   	*根據provider（前面提到的SpringHibernateJpaPersistenceProvider）建立EntityManagerFactory
   	*/
    protected EntityManagerFactory createNativeEntityManagerFactory() throws PersistenceException {
   	Assert.state(this.persistenceUnitInfo != null, "PersistenceUnitInfo not initialized");

   	PersistenceProvider provider = getPersistenceProvider();
   	if (provider == null) {
   		String providerClassName = this.persistenceUnitInfo.getPersistenceProviderClassName();
   		if (providerClassName == null) {
   			throw new IllegalArgumentException(
   					"No PersistenceProvider specified in EntityManagerFactory configuration, " +
   					"and chosen PersistenceUnitInfo does not specify a provider class name either");
   		}
   		Class<?> providerClass = ClassUtils.resolveClassName(providerClassName, getBeanClassLoader());
   		provider = (PersistenceProvider) BeanUtils.instantiateClass(providerClass);
   	}

   	if (logger.isInfoEnabled()) {
   		logger.info("Building JPA container EntityManagerFactory for persistence unit '" +
   				this.persistenceUnitInfo.getPersistenceUnitName() + "'");
   	}
   	EntityManagerFactory emf =
   			provider.createContainerEntityManagerFactory(this.persistenceUnitInfo, getJpaPropertyMap());
   	postProcessEntityManagerFactory(emf, this.persistenceUnitInfo);

   	return emf;
   }
}

需要注意的是AbstractEntityManagerFactoryBean有兩個EntityManagerFactory型別的屬性，一個是通過PersistenceProvider獲取的原生物件，另一個是Spring建立的代理物件ManagedEntityManagerFactoryInvocationHandler，它的目的是為了攔截EntityManager的建立，至少為什麼要代理，下篇文件會進行分析。

結束語

到這裡EntityManagerFactory就創建出來了，總的來說整個過程是遵循JPA規範定義的介面的，例如SpringHibernateJpaPersistenceProvider實現的createContainerEntityManagerFactory方法。只不過Spring作為骨幹框架，使用了很多中間物件和過程。
最後用一張類圖，再串一下建立的過程
在這裡插入圖片描述

  1. 首先以左下角的HibernateJpaAutoConfiguration為入口，經過@Conditional的判斷，@Import進入HibernateJpaConfiguration

  2. 在HibernateJpaConfiguration中依賴類HibernateJpaVendorAdapter，而HibernateJpaVendorAdapter又依賴了SpringHibernateJpaPersistenceProvider，PersistenceProvider的具體實現就確定了

  3. 在JpaBaseConfiguration中通過EntityManagerFactoryBuilder創建出了LocalContainerEntityManagerFactoryBean，該類是整個結構的紐帶。可以看到它關聯了PersistenceProvider和PersistenceUnitManager，而PersistenceUnitManager是產生PersistenceUnitInfo的，PersistenceProvider和PersistenceUnitInfo是createEntityFactory的兩個必要物件

  4. 最後在LocalContainerEntityManagerFactoryBean中呼叫SpringHibernateJpaPersistenceProvider.createContainerEntityManagerFactory創建出了EntityManagerFactory

那麼EntityManagerFactory創建出來後有什麼用呢，當然是用來獲取EntityManager，下篇文章我們繼續分析EntityManager的建立過程。

相關推薦

Spring Data之EntityManagerFactory建立及原始碼分析

背景 在Spring Data之JPA開篇中可以看到Spring Boot的啟動日誌，先是建立了HikariDataSource，然後緊接著構建了EntityManagerFactory 2018-10-25 09:32:20.645 INFO 37469 --- [

Spring Data之Repository建立及原始碼分析

背景 在上一篇文章Spring Data之EntityManager建立及原始碼分析介紹了EntityManager的建立過程，我們使用Spring Data JPA開發時一般是通過自定義一個例如UserRepository的介面，然後繼承JpaRepository或者CrudRepos

Spring Data之EntityManager建立及原始碼分析

背景 前一篇文章介紹了EntityManagerFactory的建立過程，有了EntityManagerFactory接下來就是要獲取EntityManager了，但EntityManager的建立不再是通過@Conditional註解，而是使用的@PersistenceContext註

Spring Data之DataSource建立及原始碼分析

背景 俗話說萬變不離其宗，程式碼中對資料庫的操作，首先是要獲取資料庫連線，而Java中最原生的連線方式就是通過DriverManager private static String driver = "org.h2.Driver"; private static String url

Spring監聽器之ApplicationListener原理及原始碼解析及例項

一、原理及原始碼解析 事件：ContextRefreshedEvent、IOCTest_Ext$1[source=我釋出的事件]、ContextClosedEvent；  *  1）、ContextRefreshedEvent事件：  *      1）、容器建立物件：re

rxJava的使用--Observable的建立及原始碼分析(一)

       最近新開的專案需要用到rxJava.在網上找了一下資料,感覺資料好少,有一些資料雖然有例子,但例子都好複雜,對一個新手來說操作是挺麻煩的.因此,本人根據自己的理解寫了一些例子還有原始碼分析,給記憶力不好的自己,留作複習用,也希望能幫助大家.文章可能

Spring Data Redis整合Redis流程原始碼分析

一：版本資訊如下.     1.1 SpringBoot的版本：1.5.10.RELEASE. <parent> <groupId>org.springframework.boot</groupId> <art

spring-data-redis-cache 使用及原始碼走讀

預期讀者 準備使用 spring 的 data-redis-cache 的同學 瞭解 @CacheConfig，@Cacheable，@CachePut，@CacheEvict，@Caching 的使用 深入理解 data-redis-cache 的實現原理 文章內容說明 如何使用 redis-cach

Spring Boot + Spring Security 防止使用者在多處同時登入（一個使用者同時只能登入一次）及原始碼分析

網上很多文章的實現方法寫得比較複雜 這裡介紹一個簡單的方法。 實現 @Configuration @EnableWebSecurity public class SecurityConfiguration extends WebSecurityConfig

Android ORM資料庫之GreenDao使用教程及原始碼分析

一、簡介 1.Android ORM介紹  在平時的開發過程中，大家一定會或多或少地接觸到 SQLite。然而在使用它時，我們往往需要做許多額外的工作，像編寫 SQL 語句與解析查詢結果等。所以，適用於 Android 的ORM 框架也就孕育而生了，現在市面

Android 之 三級快取（記憶體!!!、本地、網路）及記憶體LruCache擴充套件 及原始碼分析--- 學習和程式碼講解

一. 三級快取簡介 如上圖所示，目前App中UI介面經常會涉及到圖片，特別是像“今日關注”新聞這類app中，圖片運用的機率十分頻繁。當手機上需要顯示大量圖片類似listView、gridView控制元件並且使用者會上下滑動，即將瀏覽過的圖片又載入一遍，

Spring AOP介紹及原始碼分析

一、AOP介紹 舉個例子來說明一下吧！現在系統中有很多的業務方法，如上傳產品資訊、修改產品資訊、釋出公司庫等；現在需要對這些方法的執行做效能監控，看每個業務方法的執行時間；在不改變原業務程式碼的基礎上，也許我們會這麼做： Offer介面： Offer實現： Offer代

Spring Boot啟動命令引數詳解及原始碼分析

使用過Spring Boot，我們都知道通過java -jar可以快速啟動Spring Boot專案。同時，也可以通過在執行jar -jar時傳遞引數來進行配置。本文帶大家系統的瞭解一下Spring Boot命令列引數相關的功能及相關原始碼分析。 命令列引數使用 啟動Spring Boot專案時，我們可以通過

Spring Boot從入門到精通（五）多資料來源配置實現及原始碼分析

多資料來源配置在專案軟體中是比較常見的開發需求，Spring和Spring Boot中對此都有相應的解決方案可供大家參考。在Spring Boot中，如MyBatis、JdbcTemplate以及Jpa都可以配置多資料來源。 本文在前一篇“Spring Boot從入門到精通（四）連線MySQL資料庫（附原始碼

Spring事務原始碼分析專題（一）JdbcTemplate使用及原始碼分析

Spring中的資料訪問，JdbcTemplate使用及原始碼分析 # 前言 本系列文章為事務專欄分析文章，整個事務分析專題將按下面這張圖完成 ![image-20200718220712800](https://gitee.com/wx_cc347be696/blogImage/raw/master

004-spring-data-elasticsearch 3.0.0.0使用【二】-spring-data之定義方法、創建repository實例、從聚合根發布事件

-- ble sch current 4.3 ... reference tex manager 續上文 1.4、定義方法 　　存儲庫代理有兩種方法可以從方法名稱派生特定於存儲的查詢。它可以直接從方法名稱派生查詢，或者使用手動定義的查詢。可用選項取決於實際store。但

Spring Data 之 Repository 接口

name executor www aging 識別 TE ger ace posit 1. 介紹 Repository是一個空接口,即是一個標記性接口; 若我們定義的接口繼承了Repository,則該接口會被IOC容器識別為一個 Repository Bean; 也可

mybatis原理，配置介紹及原始碼分析

前言 mybatis核心元件有哪些？它是工作原理是什麼？ mybatis配置檔案各個引數是什麼含義？ mybatis只添加了介面類，沒有實現類，為什麼可以直接查詢呢？ mybatis的mapper對映檔案各個引數又是什麼含義？ mybatis-spring提供哪些機制簡化了原生mybatis？ m

Android與JS之JsBridge使用與原始碼分析

在Android開發中，由於Native開發的成本較高，H5頁面的開發更靈活，修改成本更低，因此前端網頁JavaScript(下面簡稱JS)與Java之間的互相呼叫越來越常見。 JsBridge就是一個簡化Android與JS通訊的框架，原始碼：https://github.com/lzyzsd

Netty NioEventLoop 建立過程原始碼分析

原文：https://wangwei.one/posts/netty-nioeventloop-analyse-for-create.html 前面 ，我們分析了Netty中的Channel元件，本篇我們來介紹一下與Channel關聯的另一個核心的元件 —— EventLo