Hibernate

我们从 Spring 环境中的 Hibernate 5 涵盖范围开始，使用它来展示 Spring 用于集成 OR 映射器的做法。本部分详细介绍了许多问题，并展示了 DAO 实施和事务分解的不同变化。大多数这些模式都可以直接翻译成所有其他受支持的 ORM 工具。然后本章后面部分将涵盖其他 ORM 技术并展示一些简短示例。

从 Spring Framework 6.0 开始，Spring 要求使用 Spring 的 HibernateJpaVendorAdapter 以及本机 Hibernate SessionFactory 设置，需要 Hibernate ORM 5.5+。我们推荐使用 Hibernate ORM 5.6 作为该 Hibernate 代中的最后一个功能分支。 Hibernate ORM 6.x 仅受支持作为 JPA 提供程序 (HibernateJpaVendorAdapter)。不再支持带有 orm.hibernate5 包的普通 SessionFactory 设置。我们建议将 Hibernate ORM 6.1/6.2 与 JPA 风格的设置一起用于新的开发项目。

SessionFactory Setup in a Spring Container

为了避免将应用程序对象与硬编码的资源查找相关联，您可以在 Spring 容器中将资源（如 JDBC DataSource 或 Hibernate SessionFactory）定义为 bean。需要访问资源的应用程序对象将通过 bean 引用接收对这些预定义实例的引用，如 next section 中的 DAO 定义中所示。

XML 应用程序上下文定义中的以下摘录显示了如何在 JDBC DataSource 的基础上设置 Hibernate SessionFactory：

<beans>

	<bean id="myDataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
		<property name="driverClassName" value="org.hsqldb.jdbcDriver"/>
		<property name="url" value="jdbc:hsqldb:hsql://localhost:9001"/>
		<property name="username" value="sa"/>
		<property name="password" value=""/>
	</bean>

	<bean id="mySessionFactory" class="org.springframework.orm.hibernate5.LocalSessionFactoryBean">
		<property name="dataSource" ref="myDataSource"/>
		<property name="mappingResources">
			<list>
				<value>product.hbm.xml</value>
			</list>
		</property>
		<property name="hibernateProperties">
			<value>
				hibernate.dialect=org.hibernate.dialect.HSQLDialect
			</value>
		</property>
	</bean>

</beans>

从本地 Jakarta Commons DBCP BasicDataSource 切换到 JNDI 定位的 DataSource（通常由应用程序服务器管理）仅仅是一个配置问题，如下例所示：

<beans>
	<jee:jndi-lookup id="myDataSource" jndi-name="java:comp/env/jdbc/myds"/>
</beans>

您还可以通过 Spring 的 JndiObjectFactoryBean / <jee:jndi-lookup> 来检索和公开 JNDI 定位的 SessionFactory。但是，在 EJB 上下文之外，这通常并不常见。

Spring 还提供了一个 LocalSessionFactoryBuilder 变体，它与 @Bean 风格配置和编程设置（不涉及 FactoryBean）无缝集成。 LocalSessionFactoryBean 和 LocalSessionFactoryBuilder 都支持后台自举，其中 Hibernate 初始化与应用程序自举线程并行运行在给定的自举执行器（例如 SimpleAsyncTaskExecutor）上。在 LocalSessionFactoryBean 上，可以通过 bootstrapExecutor 属性使用此功能。在编程 LocalSessionFactoryBuilder 上，有一个重载的 buildSessionFactory 方法，它采用自举执行器参数。 从 Spring Framework 5.1 开始，这样的本机 Hibernate 设置也可以公开一个 JPA EntityManagerFactory 以进行标准 JPA 交互，此外，该 JPA 交互与本机 Hibernate 访问并行进行。请参见 Native Hibernate Setup for JPA 了解更多详情。

Implementing DAOs Based on the Plain Hibernate API

Hibernate 具有一个称为上下文会话的功能，其中 Hibernate 本身管理每个事务的一个当前 Session。这大致相当于 Spring 的每事务同步一个 Hibernate Session。相应的 DAO 实现类似于以下示例，它基于简单的 Hibernate API：

  • Java

  • Kotlin

public class ProductDaoImpl implements ProductDao {

	private SessionFactory sessionFactory;

	public void setSessionFactory(SessionFactory sessionFactory) {
		this.sessionFactory = sessionFactory;
	}

	public Collection loadProductsByCategory(String category) {
		return this.sessionFactory.getCurrentSession()
				.createQuery("from test.Product product where product.category=?")
				.setParameter(0, category)
				.list();
	}
}
class ProductDaoImpl(private val sessionFactory: SessionFactory) : ProductDao {

	fun loadProductsByCategory(category: String): Collection<*> {
		return sessionFactory.currentSession
				.createQuery("from test.Product product where product.category=?")
				.setParameter(0, category)
				.list()
	}
}

此样式类似于 Hibernate 参考文档和示例，除了在实例变量中保存 SessionFactory 之外。我们强烈推荐这种基于实例的设置，而不是 Hibernate 的 CaveatEmptor 示例应用程序中的老式 static HibernateUtil 类。（一般来说，除非绝对必要，否则不要在 static 变量中保留任何资源。）

前面的 DAO 示例遵循依赖注入模式。它很好地融入 Spring IoC 容器，就好像针对 Spring 的 HibernateTemplate 编写代码一样。您还可以在普通 Java 中设置这样的 DAO（例如，在单元测试中）。要执行此操作，请对其进行实例化，然后用所需的工厂引用调用 setSessionFactory(..)。作为 Spring bean 定义，DAO 类似于以下内容：

<beans>

	<bean id="myProductDao" class="product.ProductDaoImpl">
		<property name="sessionFactory" ref="mySessionFactory"/>
	</bean>

</beans>

这种 DAO 样式的主要优点是它仅依赖于 Hibernate API。不需要导入任何 Spring 类。从非侵入性的角度来看，这很有吸引力，并且 Hibernate 开发人员可能会觉得更自然。

但是，DAO 会引发普通的 HibernateException（这是未经检查的，因此不必声明或捕获），这意味着调用者只能将异常视为通常致命严重——除非他们希望依赖 Hibernate 自己异常层次结构。如果不将调用者绑定到实现策略，就不可能捕获特定原因（例如乐观锁定失败）。这种权衡可能是可接受的，对于基于 Hibernate 的应用程序、不需要任何特殊异常处理或两者兼备的应用程序。

幸运的是，Spring 的 LocalSessionFactoryBean 支持适用于任何 Spring 事务策略的 Hibernate 的 SessionFactory.getCurrentSession() 方法，即使使用 HibernateTransactionManager 也会返回当前由 Spring 管理的事务 Session。该方法的标准行为仍然是返回与进行中的 JTA 事务（如果有）关联的当前 Session。无论您使用 Spring 的 JtaTransactionManager、EJB 容器管理事务 (CMT) 还是 JTA，此行为都会应用。

总之，您可以基于简单的 Hibernate API 实现 DAO，同时仍然能够参与 Spring 管理的事务。

Declarative Transaction Demarcation

我们建议您使用 Spring 的声明式事务支持，它允许您用 AOP 事务拦截器替换 Java 代码中的显式事务划分 API 调用。您可以使用 Java 注解或 XML 在 Spring 容器中配置此事务拦截器。此声明式事务功能使您可以让业务服务免受重复的事务划分代码的困扰，而专注于添加业务逻辑，而这正是您应用程序的真正价值。

在您继续之前，如果您尚未阅读 Declarative Transaction Management，我们强烈建议您阅读。

您可以使用 @Transactional 注解对服务层进行注释，并指示 Spring 容器查找这些注解并为这些带注解的方法提供事务语义。以下示例演示如何执行此操作：

  • Java

  • Kotlin

public class ProductServiceImpl implements ProductService {

	private ProductDao productDao;

	public void setProductDao(ProductDao productDao) {
		this.productDao = productDao;
	}

	@Transactional
	public void increasePriceOfAllProductsInCategory(final String category) {
		List productsToChange = this.productDao.loadProductsByCategory(category);
		// ...
	}

	@Transactional(readOnly = true)
	public List<Product> findAllProducts() {
		return this.productDao.findAllProducts();
	}
}
class ProductServiceImpl(private val productDao: ProductDao) : ProductService {

	@Transactional
	fun increasePriceOfAllProductsInCategory(category: String) {
		val productsToChange = productDao.loadProductsByCategory(category)
		// ...
	}

	@Transactional(readOnly = true)
	fun findAllProducts() = productDao.findAllProducts()
}

在容器中，您需要设置 PlatformTransactionManager 实现（作为 bean）和 <tx:annotation-driven/> 条目，从而在运行时选择 @Transactional 处理。以下示例演示如何执行此操作：

<?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:aop="http://www.springframework.org/schema/aop"
	xmlns:tx="http://www.springframework.org/schema/tx"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd
		http://www.springframework.org/schema/tx
		https://www.springframework.org/schema/tx/spring-tx.xsd
		http://www.springframework.org/schema/aop
		https://www.springframework.org/schema/aop/spring-aop.xsd">

	<!-- SessionFactory, DataSource, etc. omitted -->

	<bean id="transactionManager"
			class="org.springframework.orm.hibernate5.HibernateTransactionManager">
		<property name="sessionFactory" ref="sessionFactory"/>
	</bean>

	<tx:annotation-driven/>

	<bean id="myProductService" class="product.SimpleProductService">
		<property name="productDao" ref="myProductDao"/>
	</bean>

</beans>

Programmatic Transaction Demarcation

您可以在应用程序的较高层划分事务，在跨越任意数量操作的较低层数据访问服务之上。对于周围业务服务的实现也没有限制。它只需要一个 Spring PlatformTransactionManager。同样，后者可以来自任何地方，但最好通过 setTransactionManager(..) 方法作为 bean 引用。此外，productDAO 应该由 setProductDao(..) 方法设置。以下两段代码片断显示了 Spring 应用程序上下文中事务管理器和业务服务定义，以及业务方法实现的示例：

<beans>

	<bean id="myTxManager" class="org.springframework.orm.hibernate5.HibernateTransactionManager">
		<property name="sessionFactory" ref="mySessionFactory"/>
	</bean>

	<bean id="myProductService" class="product.ProductServiceImpl">
		<property name="transactionManager" ref="myTxManager"/>
		<property name="productDao" ref="myProductDao"/>
	</bean>

</beans>

  • Java

  • Kotlin

public class ProductServiceImpl implements ProductService {

	private TransactionTemplate transactionTemplate;
	private ProductDao productDao;

	public void setTransactionManager(PlatformTransactionManager transactionManager) {
		this.transactionTemplate = new TransactionTemplate(transactionManager);
	}

	public void setProductDao(ProductDao productDao) {
		this.productDao = productDao;
	}

	public void increasePriceOfAllProductsInCategory(final String category) {
		this.transactionTemplate.execute(new TransactionCallbackWithoutResult() {
			public void doInTransactionWithoutResult(TransactionStatus status) {
				List productsToChange = this.productDao.loadProductsByCategory(category);
				// do the price increase...
			}
		});
	}
}
class ProductServiceImpl(transactionManager: PlatformTransactionManager,
						private val productDao: ProductDao) : ProductService {

	private val transactionTemplate = TransactionTemplate(transactionManager)

	fun increasePriceOfAllProductsInCategory(category: String) {
		transactionTemplate.execute {
			val productsToChange = productDao.loadProductsByCategory(category)
			// do the price increase...
		}
	}
}

Spring 的 TransactionInterceptor 可以让代码回调抛出任何受检应用程序异常，而 TransactionTemplate 仅允许回调中出现未受检异常。TransactionTemplate 在发生未受检应用程序异常时或应用将事务标记为仅回滚（通过设置 TransactionStatus）时触发回滚。默认情况下，TransactionInterceptor 的行为方式相同，但允许对每个方法配置回滚策略。

Transaction Management Strategies

TransactionTemplate 和 TransactionInterceptor 都将实际的事务处理委派给 PlatformTransactionManager 实例（它可以是 HibernateTransactionManager（用于单个 Hibernate SessionFactory）），方法是在底层使用 ThreadLocal Session，或一个 JtaTransactionManager（委派到 Hibernate 应用程序的容器的 JTA 子系统）。你甚至可以使用定制的 PlatformTransactionManager 实现。从 Hibernate 原生事务管理切换到 JTA（比如在你的应用程序的特定部署中遇到分布式事务需求时），只需要进行配置。你可以用 Spring 的 JTA 事务实现来替换 Hibernate 事务管理器。事务分界和数据访问代码不需要改动，因为它们使用的是通用的事务管理 API。

对于跨多个 Hibernate 会话工厂的分布式事务，可以将 JtaTransactionManager 作为事务策略与多个 LocalSessionFactoryBean 定义结合使用。然后，每个 DAO 都将其特定的 SessionFactory 引用传递到其对应的 Bean 属性中。如果所有底层 JDBC 数据源都是事务性容器数据源，一个业务服务就可以为任意数量的 DAO 和任意数量的会话工厂划分事务，而无需特别注意，只要它将 JtaTransactionManager 用于该策略即可。

HibernateTransactionManager 和 JtaTransactionManager 都允许使用 Hibernate 来适当处理 JVM 级缓存，而不需要容器特定的事务管理器查找或 JCA 连接器（如果你不使用 EJB 来初始化事务）。

HibernateTransactionManager 可以将 Hibernate JDBC Connection 导出到针对特定 DataSource 的普通 JDBC 访问代码中。如果你只访问一个数据库，那么这种能力允许对混合的 Hibernate 和 JDBC 数据访问进行高级事务分界，而无需 JTA。如果你通过 LocalSessionFactoryBean 类的 dataSource 属性使用 DataSource 来设置传入的 SessionFactory，那么 HibernateTransactionManager 会自动将 Hibernate 事务公开为 JDBC 事务。或者，你可以通过 HibernateTransactionManager 类的 dataSource 属性明确指定要将事务公开到的 DataSource。

对于实际资源连接的 JTA 样式延迟检索，Spring 为目标连接池提供了相应的 DataSource 代理类：请参阅 LazyConnectionDataSourceProxy。这对于 Hibernate 只读事务特别有用，该事务通常可以从本地缓存中进行处理，而不是命中数据库。

Comparing Container-managed and Locally Defined Resources

你可以在容器管理的 JNDI SessionFactory 和本地定义的 SessionFactory 之间切换，而无需改动一行应用程序代码。将资源定义放在容器中还是放在应用程序中主要取决于你所使用的事务策略。与 Spring 定义的本地 SessionFactory 相比，手动注册的 JNDI SessionFactory 没有任何好处。通过 Hibernate 的 JCA 连接器部署 SessionFactory 会带来额外的价值，即参与 Jakarta EE 服务器的管理基础设施，但除此之外并没有增加实际价值。

Spring 的事务支持并不局限于容器。当使用除 JTA 之外的任何策略配置时，事务支持也能在独立或测试环境中工作。在典型的单数据库事务的场景中，Spring 的单资源本地事务支持是 JTA 的轻量级高效替代品。当你使用本地 EJB 无状态会话 Bean 来驱动事务时，你必须依赖于 EJB 容器和 JTA，即使你只访问一个数据库并且只使用无状态会话 Bean 来通过容器管理的事务提供声明式事务。以编程方式直接使用 JTA 也需要一个 Jakarta EE 环境。

Spring 驱动的事务使用本地定义的 Hibernate SessionFactory 可以像使用本地 JDBC DataSource 一样工作，只要它们访问的是一个数据库。因此，只有在你具有分布式事务需求时，才需要使用 Spring 的 JTA 事务策略。JCA 连接器需要容器特定的部署步骤，并且（显然）首先需要 JCA 支持。与部署使用本地资源定义和 Spring 驱动的简单 Web 应用程序相比，这种配置需要更多的工作。

综合考虑，如果你不使用 EJB，请坚持使用本地 SessionFactory 设置和 Spring 的 HibernateTransactionManager 或 JtaTransactionManager。你可以获得所有好处，包括适当的事务性 JVM 级缓存和分布式事务，而不用经历容器部署的不便。通过 JCA 连接器将 Hibernate SessionFactory 注册到 JNDI 只有在与 EJB 结合使用时才有价值。

Spurious Application Server Warnings with Hibernate

在一些实现非常严格的 XADataSource 的 JTA 环境中（目前有一些 WebLogic 服务器和 WebSphere 版本），当 Hibernate 在不考虑该环境的 JTA 事务管理器的情况下配置时，应用程序服务器日志中可能出现虚假警告或异常。这些警告或异常表明正在访问的连接不再有效或 JDBC 访问不再有效，可能是因为事务不再处于活动状态。例如，以下是一个来自 WebLogic 的实际异常：

java.sql.SQLException: The transaction is no longer active - status: 'Committed'. No further JDBC access is allowed within this transaction.

另一个常见的问题是在 JTA 事务之后发生连接泄漏，导致 Hibernate 会话（和潜在的底层 JDBC 连接）没有正确关闭。

你可以让 Hibernate 识别 JTA 事务管理器（与 Spring 同步）来解决此类问题。你可以通过两种方式来做到这一点：

  • 将您的 Spring JtaTransactionManager bean 传递给您的 Hibernate 设置。最容易的方法是，使用 bean 引用作为 LocalSessionFactoryBean bean 的 jtaTransactionManager 属性（参见 Hibernate Transaction Setup）。然后，Spring 会向 Hibernate 提供相应的 JTA 策略。

  • 您还可以在 “hibernateProperties” 中的 LocalSessionFactoryBean 上明确配置 Hibernate 与 JTA 相关的属性，特别是 “hibernate.transaction.coordinator_class”、“hibernate.connection.handling_mode”和潜在的 “hibernate.transaction.jta.platform”（有关这些属性的详细信息，请参见 Hibernate 手册）。

本节的其余部分描述了在 Hibernate 识别 JTA PlatformTransactionManager 的情况下和不识别的情况下发生的事件序列。

当 Hibernate 还没有配置为识别 JTA 事务管理器时，JTA 事务提交时会发生以下事件：

  • The JTA transaction commits.

  • Spring 的 JtaTransactionManager 与 JTA 事务同步，因此由 JTA 事务管理器通过 afterCompletion 回调对它进行回调。

  • 在其他活动中，此同步可以通过 Spring 向 Hibernate 触发回调，通过 Hibernate 的 afterTransactionCompletion 回调（用于清除 Hibernate 缓存），然后在 Hibernate 会话上进行显式 close() 调用，这将导致 Hibernate 尝试 close() JDBC 连接。

  • 在某些环境中，此 Connection.close() 调用会触发警告或错误，因为应用程序服务器不再认为 Connection 是可用的，因为事务已经提交。

当 Hibernate 已配置为识别 JTA 事务管理器时，JTA 事务提交时会发生以下事件：

  • JTA 事务已准备好提交。

  • Spring 的 JtaTransactionManager 与 JTA 事务同步，因此由 JTA 事务管理器通过 beforeCompletion 回调对事务进行回调。

  • Spring 知道 Hibernate 本身与 JTA 事务同步，并且行为不同于前一个场景。特别是，它与 Hibernate 的事务资源管理保持一致。

  • The JTA transaction commits.

  • Hibernate 与 JTA 事务同步，因此由 JTA 事务管理器通过 afterCompletion 回调对事务进行回调，并且可以正确清除其缓存。