自定义LocalContainerEntityManagerFactoryBean多租户模式下Converter初始化失败

核心问题分析 #

手动配置LocalContainerEntityManagerFactoryBean时，存在两个关键问题：

1. AppConfig未被Spring容器扫描/加载，导致EncryptionDecryptionAlgorithmService Bean不存在
2. JPA自动扫描@Converter时，会尝试用无参构造实例化CustomConverter，而此时Spring尚未完成依赖Bean的注入

解决方案步骤 #

1. 将CustomConverter转为Spring管理的Bean

给CustomConverter添加@Component注解，让Spring接管它的实例化和依赖注入：

@Converter
@Component
public class CustomConverter implements AttributeConverter<String, String> {
    private final EncryptionDecryptionAlgorithmService algorithmService;

    public CustomConverter(EncryptionDecryptionAlgorithmService algorithmService) {
        this.algorithmService = algorithmService;
        log.info("CustomConverter CREATED");
    }

    @Override
    public String convertToDatabaseColumn(String attribute) {
        return algorithmService.encrypt(attribute);
    }

    @Override
    public String convertToEntityAttribute(String dbData) {
        return algorithmService.decrypt(dbData);
    }
}

2. 确保AppConfig被Spring加载

在多租户JPA配置类中，通过@Import显式导入AppConfig，或者扩展@ComponentScan的扫描范围覆盖AppConfig所在包：

@Configuration
@Import(AppConfig.class) // 显式导入配置类，确保Bean被创建
// 或者用@ComponentScan("com.your.config.package")扫描配置类所在包
public class MultiTenantJpaConfig {
    // 后续配置代码
}

3. 手动注册Converter到EntityManagerFactory

避免JPA自行实例化Converter，而是将Spring管理的CustomConverter Bean手动注册到JPA属性中：

@Configuration
@Import(AppConfig.class)
public class MultiTenantJpaConfig {

    @Autowired
    private CustomConverter customConverter;

    @Bean
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(DataSource dataSource) {
        LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
        em.setDataSource(dataSource);
        em.setPackagesToScan("com.your.entity.package"); // 替换为你的实体类包路径

        HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
        em.setJpaVendorAdapter(vendorAdapter);

        Properties jpaProperties = new Properties();
        // 多租户核心配置
        jpaProperties.put("hibernate.multiTenancy", "SCHEMA");
        jpaProperties.put("hibernate.tenant_identifier_resolver", tenantIdentifierResolver());
        jpaProperties.put("hibernate.multi_tenant_connection_provider", multiTenantConnectionProvider());
        // 其他Hibernate配置...

        // 手动注册Spring管理的Converter
        jpaProperties.put("hibernate.ejb.converters", Collections.singletonList(customConverter));

        em.setJpaProperties(jpaProperties);
        return em;
    }

    // 实现多租户所需的TenantIdentifierResolver、MultiTenantConnectionProvider Bean
    @Bean
    public TenantIdentifierResolver tenantIdentifierResolver() {
        return new YourCustomTenantResolver();
    }

    @Bean
    public MultiTenantConnectionProvider multiTenantConnectionProvider() {
        return new YourCustomConnectionProvider();
    }
}

4. 确保初始化顺序（可选）

如果仍存在顺序问题，可以通过@DependsOn或方法参数注入强制依赖Bean提前初始化：

// 方式1：用@DependsOn指定依赖Bean的名称
@Bean
@DependsOn("getAppEncryptionDecryption")
public LocalContainerEntityManagerFactoryBean entityManagerFactory(DataSource dataSource) {
    // 配置代码...
}

// 方式2：直接在方法参数中注入依赖Bean，Spring会自动保证顺序
@Bean
public LocalContainerEntityManagerFactoryBean entityManagerFactory(DataSource dataSource,
                                                                   EncryptionDecryptionAlgorithmService encryptionService) {
    // 配置代码...
}

原理说明 #

• 让CustomConverter成为Spring Bean后，容器会负责注入EncryptionDecryptionAlgorithmService，避免无参构造的问题
• 手动注册Converter到JPA，会覆盖JPA的自动扫描实例化逻辑，使用Spring管理的Bean
• 通过@Import或@ComponentScan确保AppConfig被加载，核心依赖Bean能正常创建

内容的提问来源于stack exchange，提问作者cooperok