此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Data JPA 3.5.2! |
配置
本节介绍通过以下任一方式配置Spring Data JPA:
-
“基于注释的配置”(Java 配置)
-
“Spring 命名空间”(XML 配置)
基于注释的配置
Spring Data JPA 存储库支持可以通过 JavaConfig 和自定义 XML 命名空间激活,如以下示例所示:
@Configuration
@EnableJpaRepositories
@EnableTransactionManagement
class ApplicationConfig {
@Bean
public DataSource dataSource() {
EmbeddedDatabaseBuilder builder = new EmbeddedDatabaseBuilder();
return builder.setType(EmbeddedDatabaseType.HSQL).build();
}
@Bean
public LocalContainerEntityManagerFactoryBean entityManagerFactory() {
HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
vendorAdapter.setGenerateDdl(true);
LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean();
factory.setJpaVendorAdapter(vendorAdapter);
factory.setPackagesToScan("com.acme.domain");
factory.setDataSource(dataSource());
return factory;
}
@Bean
public PlatformTransactionManager transactionManager(EntityManagerFactory entityManagerFactory) {
JpaTransactionManager txManager = new JpaTransactionManager();
txManager.setEntityManagerFactory(entityManagerFactory);
return txManager;
}
}
您必须创建LocalContainerEntityManagerFactoryBean 而不是EntityManagerFactory 直接,因为前者除了创建异常翻译机制外,还参与了异常翻译机制EntityManagerFactory . |
前面的配置类使用EmbeddedDatabaseBuilder
API 的spring-jdbc
.然后,Spring Data 设置一个EntityManagerFactory
并使用 Hibernate 作为示例持久性提供者。此处声明的最后一个基础设施组件是JpaTransactionManager
.最后,该示例通过使用@EnableJpaRepositories
注释,它本质上具有与 XML 命名空间相同的属性。如果未配置基本包,则使用配置类所在的包。
Spring 命名空间
Spring Data 的 JPA 模块包含一个自定义命名空间,允许定义存储库 bean。它还包含 JPA 特有的某些特性和元素属性。通常,可以使用repositories
元素,如以下示例所示:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jpa="http://www.springframework.org/schema/data/jpa"
xsi:schemaLocation="http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/data/jpa
https://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
<jpa:repositories base-package="com.acme.repositories" />
</beans>
JavaConfig 和 XML 哪个更好?XML 是很久以前 Spring 的配置方式。在当今 Java、记录类型、注释等快速增长的时代,新项目通常使用尽可能多的纯 Java。虽然没有立即取消 XML 支持的计划,但某些最新功能可能无法通过 XML 获得。 |
使用repositories
元素,它激活所有注释的 bean 的持久性异常转换@Repository
,让 JPA 持久性提供者抛出的异常转换为 Spring 的DataAccessException
等级制度。
自定义命名空间属性
超出repositories
元素,JPA 命名空间提供了额外的属性,让您可以更详细地控制存储库的设置:
|
显式连接 |
|
显式连接 |
Spring Data JPA 需要一个PlatformTransactionManager 名为 beantransactionManager 如果没有明确的,则在场transaction-manager-ref 被定义。 |
引导模式
默认情况下,Spring Data JPA 存储库是默认的 Spring bean。
它们是单例作用域并急切初始化的。
在启动期间,他们已经与 JPA 进行了交互EntityManager
用于验证和元数据分析目的。
Spring Framework 支持初始化 JPAEntityManagerFactory
在后台线程中,因为该进程通常会在 Spring 应用程序中占用大量启动时间。
为了有效地利用该后台初始化,我们需要确保尽可能晚地初始化 JPA 存储库。
从 Spring Data JPA 2.1 开始,您现在可以配置BootstrapMode
(通过@EnableJpaRepositories
注释或 XML 命名空间),该名称采用以下值:
-
DEFAULT
(默认) — 存储库会急切地实例化,除非显式注释@Lazy
. 仅当没有客户机 Bean 需要存储库的实例时,lazification 才有效,因为这将需要初始化存储库 Bean。 -
LAZY
— 隐式声明所有存储库 Bean 为延迟,并导致创建延迟初始化代理以注入客户端 Bean。 这意味着,如果客户端 Bean 只是将实例存储在字段中并且在初始化期间不使用存储库,则存储库将不会被实例化。 存储库实例将在首次与存储库交互时进行初始化和验证。 -
DEFERRED
— 从根本上与LAZY
,但触发存储库初始化以响应ContextRefreshedEvent
以便在应用程序完全启动之前验证存储库。
建议
如果您没有使用异步 JPA 引导,请坚持使用默认引导模式。
如果您异步引导 JPA,DEFERRED
是一个合理的默认值,因为它将确保 Spring Data JPA 引导程序只等待EntityManagerFactory
setup 如果它本身比初始化所有其他应用程序组件花费的时间更长。
尽管如此,它仍然确保在应用程序发出启动信号之前正确初始化和验证存储库。
LAZY
是测试场景和本地开发的不错选择。
一旦您非常确定存储库可以正确引导,或者在测试应用程序的其他部分的情况下,对所有存储库运行验证可能会不必要地增加启动时间。
这同样适用于本地开发,在本地开发中,您只访问可能需要初始化单个存储库的应用程序部分。