使用相同持久化单元访问不同数据源的教程

本文档旨在指导开发者如何在使用Java、Wildfly和JPA/Hibernate的环境下，通过同一个持久化单元（Persistence Unit）访问不同的数据源。核心思路是利用Hibernate的多租户（Multitenancy）特性，动态地根据当前会话或事务上下文选择合适的数据源，从而实现对多个客户数据的隔离和访问。

在传统的JPA应用中，通常通过@PersistenceContext注解注入EntityManager，或者通过EntityManagerFactory创建EntityManager实例来操作数据库。当需要访问多个数据库，且这些数据库拥有相同的实体结构时，为每个数据库都配置一个持久化单元显然是不可行的，尤其是在客户数量动态增长的情况下。

Hibernate提供的多租户（Multitenancy）特性可以很好地解决这个问题。其核心思想是，通过实现特定的接口，让Hibernate能够根据当前上下文动态地选择连接哪个数据库。

实现多租户的关键组件：

1. MultitenantConnectionProvider: 该接口负责提供数据库连接。你需要实现这个接口，并在其getConnection(String tenantIdentifier)方法中，根据传入的租户标识符（tenantIdentifier）返回相应的数据库连接。这个租户标识符代表了要访问的特定客户或数据源。

2. CurrentTenantIdentifierResolver: 该接口负责解析当前租户标识符。你需要实现这个接口，并在其resolveCurrentTenantIdentifier()方法中，返回当前会话或事务对应的租户标识符。这个标识符通常会存储在会话或事务上下文中。

实现步骤：

1. 创建MultitenantConnectionProvider实现:

   import org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider;
   import java.sql.Connection;
   import java.sql.SQLException;
   import javax.sql.DataSource;
   import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
   import org.hibernate.service.spi.Stoppable;
   import org.hibernate.service.spi.ServiceRegistryAwareService;
   import org.hibernate.service.ServiceRegistry;
   import java.util.Map;
   
   public class MyMultitenantConnectionProvider implements MultiTenantConnectionProvider, ServiceRegistryAwareService, Stoppable {
   
       private Map dataSources; // 存储租户标识符和数据源的映射关系
       private ConnectionProvider defaultConnectionProvider;
   
       @Override
       public Connection getAnyConnection() throws SQLException {
           return defaultConnectionProvider.getConnection();
       }
   
       @Override
       public void releaseAnyConnection(Connection connection) throws SQLException {
           defaultConnectionProvider.closeConnection(connection);
       }
   
       @Override
       public Connection getConnection(String tenantIdentifier) throws SQLException {
           if (tenantIdentifier == null) {
               return getAnyConnection();
           }
           DataSource dataSource = dataSources.get(tenantIdentifier);
           if (dataSource == null) {
               throw new SQLException("No datasource configured for tenant: " + tenantIdentifier);
           }
           return dataSource.getConnection();
       }
   
       @Override
       public void releaseConnection(String tenantIdentifier, Connection connection) throws SQLException {
           if (tenantIdentifier == null) {
               releaseAnyConnection(connection);
               return;
           }
           connection.close();
       }
   
       @Override
       public boolean isUnwrappableAs(Class unwrapType) {
           return false;
       }
   
       @Override
       public  T unwrap(Class unwrapType) {
           return null;
       }
   
       @Override
       public boolean supportsAggressiveRelease() {
           return true;
       }
   
       @Override
       public void injectServices(ServiceRegistry serviceRegistry) {
           defaultConnectionProvider = serviceRegistry.getService(ConnectionProvider.class);
       }
   
       @Override
       public void stop() {
           // Cleanup resources here
       }
   
       public void setDataSources(Map dataSources) {
           this.dataSources = dataSources;
       }
   }

2. 创建CurrentTenantIdentifierResolver实现:

   import org.hibernate.context.spi.CurrentTenantIdentifierResolver;
   
   public class MyCurrentTenantIdentifierResolver implements CurrentTenantIdentifierResolver {
   
       @Override
       public String resolveCurrentTenantIdentifier() {
           // 从会话或事务上下文中获取当前租户标识符
           String tenantId = TenantContext.getTenantId(); // 假设TenantContext是一个线程安全的类，用于存储租户标识符
           if (tenantId != null) {
               return tenantId;
           }
           // 如果没有找到租户标识符，返回默认值或者抛出异常
           return "default_tenant"; // 默认租户
       }
   
       @Override
       public boolean validateExistingCurrentSessions() {
           return true;
       }
   }

3. 配置Hibernate:

   在persistence.xml文件中，配置Hibernate的多租户属性：

4. 设置租户标识符:

   在需要访问特定租户的数据时，设置TenantContext中的租户标识符。例如：

   TenantContext.setTenantId("customer1");
   // 执行数据库操作
   TenantContext.clear(); // 清除租户标识符，避免影响后续操作

注意事项：

• TenantContext需要是线程安全的，可以使用ThreadLocal来存储租户标识符。
• 确保在事务边界内设置和清除租户标识符，避免跨事务的数据访问错误。
• 需要根据实际情况配置dataSources，确保每个租户标识符对应正确的数据源。可以使用JNDI查找数据源，或者通过配置属性动态创建数据源。
• 在Wildfly环境下，可以通过JBoss Modules来管理数据源的依赖。

总结：

通过Hibernate的多租户特性，可以有效地实现使用相同持久化单元访问不同数据源的需求。 关键在于实现MultitenantConnectionProvider和CurrentTenantIdentifierResolver接口，并正确配置Hibernate的属性。 在实际应用中，需要根据具体业务场景，选择合适的租户标识符存储和管理方式，确保数据访问的隔离性和正确性。