具有多租户休眠的 Spring-Data JPA

Posted 2023-02-27

【中文标题】具有多租户休眠的 Spring-Data JPA

【英文标题】：Spring-Data JPA with Multi-Tenancy Hibernate

【发布时间】：2016-05-03 14:48:55

【问题描述】：

我正在尝试通过自定义 MultiTenantConnectionProvider 让 Spring-Data JPA 与 Hibernate 一起使用。

下面我的配置中的所有内容似乎都可以正常工作。每次我尝试调用 Repository 方法时，都会调用我的 MultiTenantConnectionProviderImpl 类。

主要问题是无法提供租户标识符。 Spring-Data 提供的 Repository 接口负责获取 Hibernate Session。

有没有办法为 Spring-Data 提供租户标识符？或者在某个地方我们可以拦截 Hibernate Session 的创建，以便我们可以适当地调用 sessionFactory.withOptions().tenantIdentifier(itendintifier).openSession();

这是我的 Spring 配置 XML 文件。我尽量让它保持简单。

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

    <context:annotation-config/>
    <context:component-scan base-package="com.company"/>
    <jpa:repositories base-package="com.company.repositories"/>
    <bean id="entityManagerFactory" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
        <property name="packagesToScan" value="com.company.entities"/>
        <property name="dataSource" ref="dataSource"/>
        <property name="jpaVendorAdapter">
            <bean class="org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter">
                <property name="showSql" value="true"/>
            </bean>
        </property>
    </bean>


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

    <bean id="sessionFactory" class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">
        <property name="hibernateProperties">
            <props>
                <prop key="hibernate.dialect">org.hibernate.dialect.SQLServer2012Dialect</prop>
                <prop key="hibernate.format_sql">true</prop>
                <prop key="hibernate.multi_tenant_connection_provider">com.company.hibernate.MultiTenantConnectionProviderImpl</prop>
                <prop key="hibernate.multiTenancy">DATABASE</prop>
            </props>
        </property>
    </bean>


    <tx:annotation-driven transaction-manager="transactionManager"/>

    <!--Vendor specific properties here-->
    <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
        <property name="driverClassName" value="net.sourceforge.jtds.jdbc.Driver"/>
        <property name="url" value="jdbc:jtds:sqlserver://localhost:1433/myDatabase"/>
        <property name="username" value="username"/>
        <property name="password" value="password"/>
    </bean>

</beans>

【问题讨论】：

如果 transactionManager 使用 sessionFactory 而不是 entityManagerFactory，这如何是 JPA 实现？

【参考方案1】：

使用CurrentTenantIdentifierResolver:

<bean id="sessionFactory" class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">
    <property name="hibernateProperties">
        <map>
            <entry key="hibernate.dialect" value="org.hibernate.dialect.SQLServer2012Dialect">
            <entry key="hibernate.format_sql" value="true">
            <entry key="hibernate.multi_tenant_connection_provider" value="com.company.hibernate.MultiTenantConnectionProviderImpl">
            <entry key="hibernate.multiTenancy" value="DATABASE">
            <!-- tenant resolver as spring bean -->
            <entry key="hibernate.tenant_identifier_resolver" value-ref="currentTenantIdentifierResolver"/>
        </map>
    </property>
</bean>

<bean id="currentTenantIdentifierResolver"
    class="com.xxx.CurrentTenantResolver">
</bean>

简单的租户标识符解析器是这样的：

public class CurrentTenantResolver implements CurrentTenantIdentifierResolver 

    public String resolveCurrentTenantIdentifier() 
        // retrieve tenant from logged in user
        User usr = (User) SecurityContextHolder.getContext().getAuthentication().getPrincipal() ;       
        return usr.getTenantName();

    

    public boolean validateExistingCurrentSessions() 
        return true;
    

记住上面的类是一个spring bean，所以你可以像普通的spring bean一样自动装配任何spring bean(service/dao)。

每次 spring 需要 session 时，hibernate 都会从该 bean 中检索租户标识符。