Hibernate

我们首先介绍 Spring 环境中 Hibernate 5 的使用， 用它来演示 Spring 整合 ORM 映射器的方法。 本节详细介绍了许多问题，并展示了 DAO 实现和事务划分的不同变体。 这些模式中的大多数可以直接转换为所有其他受支持的 ORM 工具。 本章后面的部分将介绍其他 ORM 技术并展示简要示例。

从 Spring Framework 6.0 开始，Spring 要求 Hibernate ORM 5.5+ 用于 Spring 的 HibernateJpaVendorAdapter 以及原生 Hibernate SessionFactory 设置。 我们推荐 Hibernate ORM 5.6 作为该 Hibernate 生成中的最后一个功能分支。 Hibernate ORM 6.x 主要作为 JPA 提供者（HibernateJpaVendorAdapter）受支持。 为了迁移目的，允许使用 orm.hibernate5 包进行纯 SessionFactory 设置。 我们建议新开发项目使用 JPA 风格设置的 Hibernate ORM 6.x。

Spring 容器中的 SessionFactory 设置

为了避免将应用程序对象与硬编码的资源查找绑定，您可以将资源（例如 JDBC DataSource 或 Hibernate SessionFactory）定义为 Spring 容器中的 bean。需要访问资源的应用程序对象通过 bean 引用接收对这些预定义实例的引用， 如 下一节 中的 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>

您还可以访问 JNDI 定位的 SessionFactory，使用 Spring 的 JndiObjectFactoryBean / <jee:jndi-lookup> 来检索和暴露它。 然而，这通常在 EJB 上下文之外并不常见。

Spring 还提供了一个 LocalSessionFactoryBuilder 变体，可与 @Bean 风格配置和编程设置（不涉及 FactoryBean）无缝集成。 LocalSessionFactoryBean 和 LocalSessionFactoryBuilder 都支持后台引导，Hibernate 初始化在给定的引导执行器（例如 SimpleAsyncTaskExecutor）上与应用程序引导线程并行运行。 在 LocalSessionFactoryBean 上，这通过 bootstrapExecutor 属性可用。在编程的 LocalSessionFactoryBuilder 上，有一个重载的 buildSessionFactory 方法，它接受一个引导执行器参数。 这种原生 Hibernate 设置还可以为标准 JPA 交互以及原生 Hibernate 访问公开 JPA EntityManagerFactory。 有关详细信息，请参阅 JPA 的原生 Hibernate 设置。

基于纯 Hibernate API 实现 DAO

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 支持 Hibernate 的 SessionFactory.getCurrentSession() 方法用于任何 Spring 事务策略， 返回当前的 Spring 管理的事务 Session，即使使用 HibernateTransactionManager 也是如此。该方法的标准行为仍然是 返回与正在进行的 JTA 事务（如果有）关联的当前 Session。 这种行为适用于您是否使用 Spring 的 JtaTransactionManager、EJB 容器管理的事务（CMT）或 JTA。

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

声明式事务划分

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

在继续之前，我们强烈建议您阅读 声明式事务管理 如果您还没有这样做。

您可以使用 @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>

编程式事务划分

您可以在应用程序的更高层级划分事务，在跨越任意数量操作的低级数据访问服务之上。 对周围业务服务的实现也没有限制。它只需要一个 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 的行为相同，但允许为每个方法配置回滚策略。

事务管理策略

TransactionTemplate 和 TransactionInterceptor 都将实际事务处理委托给 PlatformTransactionManager 实例 （对于单个 Hibernate SessionFactory，可以是 HibernateTransactionManager， 它在底层使用 ThreadLocal Session）或 JtaTransactionManager （将事务处理委托给容器的 JTA 子系统）用于 Hibernate 应用程序。 您甚至可以使用自定义的 PlatformTransactionManager 实现。 从原生 Hibernate 事务管理切换到 JTA（例如，当您的应用程序的某些部署面临分布式事务要求时） 仅仅是配置问题。您可以将 Hibernate 事务管理器替换为 Spring 的 JTA 事务实现。 事务划分和数据访问代码都可以不经修改地工作，因为它们使用通用的事务管理 API。

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

HibernateTransactionManager 和 JtaTransactionManager 都允许使用 Hibernate 进行适当的 JVM 级别缓存处理，而无需容器特定的事务管理器查找或 JCA 连接器（如果您不使用 EJB 启动事务）。

HibernateTransactionManager 可以将 Hibernate JDBC Connection 导出到特定 DataSource 的纯 JDBC 访问代码。 这种能力允许在完全没有 JTA 的情况下进行高级事务划分，混合使用 Hibernate 和 JDBC 数据访问， 前提是您只访问一个数据库。如果您通过 LocalSessionFactoryBean 类的 dataSource 属性， 使用 DataSource 设置了传入的 SessionFactory，HibernateTransactionManager 会自动将 Hibernate 事务公开为 JDBC 事务。 或者，您可以通过 HibernateTransactionManager 类的 dataSource 属性显式指定要公开事务的 DataSource。

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

容器管理资源与本地定义资源的比较

您可以在容器管理的 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 结合使用时才增加价值。

Hibernate 造成的虚假应用程序服务器警告

在某些具有非常严格的 XADataSource 实现的 JTA 环境中（目前是一些 WebLogic Server 和 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 事务设置）。 Spring 随后将相应的 JTA 策略提供给 Hibernate。

  • 您也可以在 LocalSessionFactoryBean 上的 "hibernateProperties" 中显式配置 Hibernate 的 JTA 相关属性， 特别是 "hibernate.transaction.coordinator_class"、"hibernate.connection.handling_mode" 以及可能的 "hibernate.transaction.jta.platform"（有关这些属性的详细信息，请参阅 Hibernate 手册）。

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

当 Hibernate 未配置为了解任何 JTA 事务管理器时， JTA 事务提交时会发生以下事件：

  • JTA 事务提交。

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

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

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

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

  • JTA 事务准备提交。

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

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

  • JTA 事务提交。

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