Hibernate

我们首先介绍在 Spring 环境中使用Hibernate 5，以此演示 Spring 集成 OR 映射器的方法。本节详细介绍了许多问题，并展示了 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.1/6.2。

在 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://127.0.0.1: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 EntityManagerFactory 以进行标准 JPA 交互，以及本地 Hibernate 访问。有关详细信息，请参阅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 事务策略，即使使用HibernateTransactionManager，也会返回当前 Spring 管理的事务Session。该方法的标准行为仍然是返回与正在进行的 JTA 事务（如果有）关联的当前Session。此行为适用于您是否使用 Spring 的JtaTransactionManager、EJB 容器管理事务 (CMT) 或 JTA。

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

声明式事务划分

我们建议您使用 Spring 的声明式事务支持，它允许您将 Java 代码中的显式事务划分 API 调用替换为 AOP 事务拦截器。您可以使用 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 仅限于回调中的未检查异常。如果出现未检查的应用程序异常，或者事务被应用程序标记为仅回滚（通过设置 TransactionStatus），TransactionTemplate 则会触发回滚。默认情况下，TransactionInterceptor 的行为相同，但允许为每个方法配置回滚策略。

事务管理策略

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

对于跨多个 Hibernate session factory 的分布式事务，您可以将 JtaTransactionManager 作为事务策略与多个 LocalSessionFactoryBean 定义结合使用。然后，每个 DAO 获取一个特定的 SessionFactory 引用传递到其相应的 bean 属性中。如果所有底层 JDBC 数据源都是事务性容器数据源，则业务服务可以在任意数量的 DAO 和任意数量的 session factory 上划分事务，无需特别注意，只要它使用 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 只读事务特别有用，因为这些事务通常可以从本地缓存中处理，而不是访问数据库。

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

您可以在容器管理的 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 级缓存和分布式事务，而无需容器部署的麻烦。只有在与 EJB 结合使用时，通过 JCA 连接器进行 Hibernate SessionFactory 的 JNDI 注册才具有价值。

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 事务管理器来解决此类问题，Hibernate 会与它（以及 Spring）同步。您可以通过两种方式执行此操作

将您的 Spring JtaTransactionManager bean 传递到您的 Hibernate 设置中。最简单的方法是将 bean 引用到 LocalSessionFactoryBean bean 的 jtaTransactionManager 属性中（请参阅 Hibernate 事务设置）。然后，Spring 将相应的 JTA 策略提供给 Hibernate。
您还可以显式配置 Hibernate 的 JTA 相关属性，特别是 LocalSessionFactoryBean 上的 "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 回调被回调，并且可以正确清除其缓存。