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

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

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

背景

前一篇文章介紹了EntityManagerFactory的建立過程，有了EntityManagerFactory接下來就是要獲取EntityManager了，但EntityManager的建立不再是通過@Conditional註解，而是使用的@PersistenceContext註解，那麼Spring Data是如何識別@PersistenceContext註解，並注入EntityManager例項的，又是怎樣通過上一步建立的EntityManagerFactory來獲取EntityManager的呢？這篇文章就來分析這兩個問題。

動態註冊Bean

日常開發中我們一般會在類上使用@Service、@Component或者在方法上使用@Bean註解，被註解的類或者方法的返回值的物件例項會被Spring維護到ApplicationContext中，在使用的時可以通過@Autowired、@Resource註解的類變數自動注入物件例項。

如果不使用註解，通過程式設計的方式也能建立一個物件例項交由ApplicationContext管理。

BeanDefinitionBuilder

 /**
 * Description：通過編碼的方式建立一個Bean例項
 */
public class BeanDefinitionBuilderTest {

    public static void main(String[] args) {
        DefaultListableBeanFactory beanFactory = new DefaultListableBeanFactory();

        //使用builder構建一個MyBean的Bean定義
 

        BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(MyBean.class);

        //為name屬性賦值，會預設呼叫setName方法，如果沒有setName方法會報錯
        builder.addPropertyValue("name","張三");

        //往BeanFactory註冊beanName為myBean的Bean定義
        beanFactory.registerBeanDefinition("myBean", builder.
 
getRawBeanDefinition());

        //獲取剛才註冊的Bean
        MyBean myBean = beanFactory.getBean(MyBean.class);
        myBean.say();
    }

    private static class MyBean{
        private String name;

        public void setName(String name) {
            this.name = name;
        }

        public void say(){
            System.out.println("MyBean name is "+ name);
        }
    }
}

控制檯輸出

MyBean name is 張三

可以看到MyBean並未使用任何註解，而是通過BeanDefinitionBuilder建立了一個MyBean的例項並註冊到beanFactory中，再從beanFactory獲取出來呼叫say方法，為name設定的值被正確輸出。

BeanFactoryPostProcessor

/**
 * Description：通過實現BeanFactoryPostProcessor介面建立物件例項
 *
 * @author fangliangsheng
 * @date 2018/11/18
 */
public class BeanFactoryPostProcessorTest {

    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
        MyBean myBean = context.getBean(MyBean.class);

        myBean.say();
    }

    @Configuration
    public static class MyConfig{

        @Bean
        public MyConfigBean myConfigBean(){
            return new MyConfigBean();
        }
        
    }

    private static class MyConfigBean implements BeanFactoryPostProcessor{

        @Override
        public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
            BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(MyBean.class);
            builder.addPropertyValue("name","張三");

            ((DefaultListableBeanFactory) beanFactory)
                    .registerBeanDefinition("myBean", builder.getRawBeanDefinition());
        }
    }

    private static class MyBean{
        private String name;

        public void setName(String name) {
            this.name = name;
        }

        public void say(){
            System.out.println("MyBean name is "+ name);
        }
    }
}

控制檯輸出

MyBean name is 張三

BeanFactoryPostProcessor介面只有一個方法postProcessBeanFactory，該方法的呼叫時機是Application Context的Bean Factory初始化完成後。

InstantiationAwareBeanPostProcessor

private static class MyConfigBean3 implements InstantiationAwareBeanPostProcessor{
        @Override
        public PropertyValues postProcessPropertyValues(PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) throws BeansException {
            if (bean instanceof MyBean){
                System.out.println("set property value:" + beanName +" "+ pvs.getPropertyValues()[0].getName() + " "+pvs.getPropertyValues()[0].getValue());
            }

            return pvs;
        }
    }

控制檯輸出

set property value:myBean name 張三

InstantiationAwareBeanPostProcessor介面能夠攔截物件例項化時對屬性的賦值操作，實現該介面並判斷想要監控的類及屬性，在注入值時可以實現自己想要的邏輯。例如根據一個配置再賦值時選擇不同的例項，或者通過程式設計的方式再動態建立一個例項。

這裡介紹BeanDefinitionBuilder、BeanFactoryPostProcessor、InstantiationAwareBeanPostProcessor主要是因為在建立EntityManager時Spring Data就是通過這些介面的協作完成的。

建立EntityManager

先看自動配置的入口類

@Configuration
//當存在DataSource例項和JpaRepository類時生效
@ConditionalOnBean(DataSource.class)
@ConditionalOnClass(JpaRepository.class)
//當還沒有JpaRepositoryFactoryBean和JpaRepositoryConfigExtension例項時生效
//因為後面會建立這兩個類的例項，意思就是不能重複建立
@ConditionalOnMissingBean({ JpaRepositoryFactoryBean.class,
		JpaRepositoryConfigExtension.class })
@ConditionalOnProperty(prefix = "spring.data.jpa.repositories", name = "enabled", havingValue = "true", matchIfMissing = true)
//條件校驗通過後引入JpaRepositoriesAutoConfigureRegistrar
@Import(JpaRepositoriesAutoConfigureRegistrar.class)
//在HibernateJpaAutoConfiguration之後自動配置，這點很關鍵，因為要現有EntityManagerFactory，這步的EntityManager才能建立
@AutoConfigureAfter(HibernateJpaAutoConfiguration.class)
public class JpaRepositoriesAutoConfiguration {

}

Import的JpaRepositoriesAutoConfigureRegistrar繼承了AbstractRepositoryConfigurationSourceSupport，我們先看這個抽象類。
在這裡插入圖片描述
該抽象類有很多子類，看到類名是不是有點眼熟，這些就是Spring JPA支援的持久化實現。

public abstract class AbstractRepositoryConfigurationSourceSupport
		implements BeanFactoryAware, ImportBeanDefinitionRegistrar, ResourceLoaderAware,
		EnvironmentAware {
		
	@Override
	public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata,
			BeanDefinitionRegistry registry) {
		new RepositoryConfigurationDelegate(getConfigurationSource(registry),
				this.resourceLoader, this.environment).registerRepositoriesIn(registry,
						getRepositoryConfigurationExtension());
	}
}

它繼承了ImportBeanDefinitionRegistrar介面實現了registerBeanDefinitions方法，這是一個重要的切入點。registerBeanDefinitions方法的第二個入參是BeanDefinitionRegistry，通過這個registry介面就可以往Bean Factory註冊各種例項了。具體的建立是交給RepositoryConfigurationDelegate待辦的。

/**
* 定義Repository的建立步驟
* 通過RepositoryConfigurationSource的配置來源和RepositoryConfigurationExtension的具體實現
*/
public class RepositoryConfigurationDelegate {

	private final RepositoryConfigurationSource configurationSource;

	/**
	 * 將找到的repositories註冊到BeanDefinitionRegistry中
	 * 類似於模版方法
	 */
	public List<BeanComponentDefinition> registerRepositoriesIn(BeanDefinitionRegistry registry,
			RepositoryConfigurationExtension extension) {

		extension.registerBeansForRoot(registry, configurationSource);

		RepositoryBeanDefinitionBuilder builder = new RepositoryBeanDefinitionBuilder(registry, extension, resourceLoader,
				environment);
		List<BeanComponentDefinition> definitions = new ArrayList<>();

		//找到Repository介面的子類並封裝為RepositoryConfiguration
		//Repository的子類也就是我們平時開發所定義的例如UserRepository
		for (RepositoryConfiguration<? extends RepositoryConfigurationSource> configuration : extension
				.getRepositoryConfigurations(configurationSource, resourceLoader, inMultiStoreMode)) {

			//將configuration轉化為BeanDefinitionBuilder，用於建立具體的例項
			BeanDefinitionBuilder definitionBuilder = builder.build(configuration);

			//EntityManager如何建立的答案就在這個地方了
			//這裡extension的子類是JpaRepositoryConfigExtension
			extension.postProcess(definitionBuilder, configurationSource);

			if (isXml) {
				extension.postProcess(definitionBuilder, (XmlRepositoryConfigurationSource) configurationSource);
			} else {
				extension.postProcess(definitionBuilder, (AnnotationRepositoryConfigurationSource) configurationSource);
			}

			AbstractBeanDefinition beanDefinition = definitionBuilder.getBeanDefinition();
			String beanName = configurationSource.generateBeanName(beanDefinition);

			if (LOGGER.isDebugEnabled()) {
				LOGGER.debug(REPOSITORY_REGISTRATION, extension.getModuleName(), beanName,
						configuration.getRepositoryInterface(), configuration.getRepositoryFactoryBeanClassName());
			}

			beanDefinition.setAttribute(FACTORY_BEAN_OBJECT_TYPE, configuration.getRepositoryInterface());

			registry.registerBeanDefinition(beanName, beanDefinition);
			definitions.add(new BeanComponentDefinition(beanDefinition, beanName));
		}

		return definitions;
	}
}

接下來看下JpaRepositoryConfigExtension的實現

public class JpaRepositoryConfigExtension extends RepositoryConfigurationExtensionSupport
	//該方法是在上一個類的registerRepositoriesIn中呼叫的
	//給builder指定類entityManager屬性的賦值方法
	@Override
	public void postProcess(BeanDefinitionBuilder builder, RepositoryConfigurationSource source) {

		Optional<String> transactionManagerRef = source.getAttribute("transactionManagerRef");
		builder.addPropertyValue("transactionManager", transactionManagerRef.orElse(DEFAULT_TRANSACTION_MANAGER_BEAN_NAME));
		builder.addPropertyValue("entityManager", getEntityManagerBeanDefinitionFor(source, source.getSource()));
		builder.addPropertyReference("mappingContext", JPA_MAPPING_CONTEXT_BEAN_NAME);
	}

	//通過BeanDefinitionBuilder定義了SharedEntityManagerCreator的createSharedEntityManager
	//為entityManager的建立方法
	private static AbstractBeanDefinition getEntityManagerBeanDefinitionFor(RepositoryConfigurationSource config,
			@Nullable Object source) {

		BeanDefinitionBuilder builder = BeanDefinitionBuilder
				.rootBeanDefinition("org.springframework.orm.jpa.SharedEntityManagerCreator");
		builder.setFactoryMethod("createSharedEntityManager");
		builder.addConstructorArgReference(getEntityManagerBeanRef(config));

		AbstractBeanDefinition bean = builder.getRawBeanDefinition();
		bean.setSource(source);

		return bean;
	}
}

結合動態註冊Bean章節的內容，可以知道BeanDefinitionBuilder的作用。所以EntityManager的實際建立是通過SharedEntityManagerCreator的createSharedEntityManager方法。以上只是定義好了BeanDefinitionBuilder，builder中屬性的賦值操作是物件實際例項時呼叫的。

接下來我們再看PersistenceAnnotationBeanPostProcessor，該類繼承了InstantiationAwareBeanPostProcessor實現了postProcessPropertyValues方法，在動態註冊Bean章節中，介紹了postProcessPropertyValues的作用。

public class PersistenceAnnotationBeanPostProcessor
		implements InstantiationAwareBeanPostProcessor, DestructionAwareBeanPostProcessor,
		MergedBeanDefinitionPostProcessor, PriorityOrdered, BeanFactoryAware, Serializable{

    //攔截例項化物件時的賦值操作
	@Override
	public PropertyValues postProcessPropertyValues(
			PropertyValues pvs, PropertyDescriptor[] pds, Object bean, String beanName) {

		//找到@PersistenceContext、@PersistenceUnit註解的方法
		InjectionMetadata metadata = findPersistenceMetadata(beanName, bean.getClass(), pvs);
		try {
			metadata.inject(bean, beanName, pvs);
		}
		catch (Throwable ex) {
			throw new BeanCreationException(beanName, "Injection of persistence dependencies failed", ex);
		}
		return pvs;
	}
}

PersistenceAnnotationBeanPostProcessor的作用是實現PersistenceContext和PersistenceUnit註解的作用，即JPA規範定義通過@PersistenceContext註解的方法或者屬性將會注入EntityManger例項，@PersistenceUnit註解的方法或者屬性將會注入EntityManagerFactory例項.

結束

這篇文章主要分析了EntityManger的建立過程，

  1. AbstractRepositoryConfigurationSourceSupport的registerBeanDefinitions為切入點
  2. RepositoryConfigurationDelegate定義建立步驟
  3. JpaRepositoryConfigExtension通過BeanDefinitionBuilder指定了EntityManager的具體建立方法

以上涉及到的相關類，用一張類圖展示
在這裡插入圖片描述

EntityManager是為誰建立的呢，創建出來後又是如何使用的呢，下一篇文章繼續分析。

相關推薦

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

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

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

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

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

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

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