SpringBoot JPA库@EntityScan失效：如何避免应用指定实体扫描包？

你的核心问题是：应用手动定义的LocalContainerEntityManagerFactoryBean不会自动继承库中@EntityScan的配置。因为@EntityScan本质是给Spring Boot的JPA自动配置类提供扫描路径，一旦应用手动创建EntityManagerFactoryBean，自动配置会被禁用，库的@EntityScan自然无法作用到这个手动Bean上。

下面给出三种可行的解决方案，按需选择：

方案一：库提供EntityManagerFactory配置基类，应用继承复用 #

在库中封装好实体扫描包的固定配置，应用只需继承基类并补充数据库连接信息即可：

// 库中的抽象配置类，维护实体包路径
public abstract class BaseLibJpaConfiguration {
    // 库内实体类所在包，由库维护更新
    private static final String[] LIB_ENTITY_PACKAGES = {"com.your.lib.entity"};

    @Bean(name = "specifiedEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(DataSource libDataSource) {
        LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
        em.setDataSource(libDataSource);
        em.setPackagesToScan(LIB_ENTITY_PACKAGES); // 直接指定库的实体包

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

        return em;
    }

    @Bean(name = "specifiedTransactionManager")
    public PlatformTransactionManager transactionManager(EntityManagerFactory emf) {
        JpaTransactionManager transactionManager = new JpaTransactionManager();
        transactionManager.setEntityManagerFactory(emf);
        return transactionManager;
    }

    // 通用Hibernate配置，可由应用覆盖
    protected Properties getHibernateProperties() {
        Properties props = new Properties();
        props.setProperty("hibernate.dialect", "org.hibernate.dialect.MySQL8Dialect");
        props.setProperty("hibernate.hbm2ddl.auto", "none");
        return props;
    }
}

应用侧只需继承并配置数据源：

// 应用中的配置类
@Configuration
@EnableJpaRepositories(
        basePackages = "com.your.lib.repository",
        entityManagerFactoryRef = "specifiedEntityManagerFactory",
        transactionManagerRef = "specifiedTransactionManager"
)
public class AppJpaConfig extends BaseLibJpaConfiguration {
    // 配置库对应的数据源
    @Bean(name = "libDataSource")
    @ConfigurationProperties(prefix = "lib.db")
    public DataSource libDataSource() {
        return DataSourceBuilder.create().build();
    }

    // 如需自定义Hibernate配置，覆盖父类getHibernateProperties方法即可
}

方案二：用BeanPostProcessor动态注入实体扫描包 #

如果不想让应用继承基类，可以在库中定义一个BeanPostProcessor，自动给应用创建的LocalContainerEntityManagerFactoryBean添加实体包路径：

// 库中的BeanPostProcessor组件
@Component
public class LibEntityPackageInjector implements BeanPostProcessor {
    private static final String[] LIB_ENTITY_PACKAGES = {"com.your.lib.entity"};

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        // 匹配应用中指定名称的EntityManagerFactoryBean
        if (bean instanceof LocalContainerEntityManagerFactoryBean && "specifiedEntityManagerFactory".equals(beanName)) {
            LocalContainerEntityManagerFactoryBean emBean = (LocalContainerEntityManagerFactoryBean) bean;
            String[] existingPackages = emBean.getPackagesToScan();
            
            // 合并应用已有扫描包和库的实体包
            Set<String> mergedPackages = new HashSet<>();
            if (existingPackages != null) {
                mergedPackages.addAll(Arrays.asList(existingPackages));
            }
            mergedPackages.addAll(Arrays.asList(LIB_ENTITY_PACKAGES));
            
            emBean.setPackagesToScan(mergedPackages.toArray(new String[0]));
        }
        return bean;
    }
}

应用侧正常定义EntityManagerFactoryBean即可，无需手动设置packagesToScan，库的处理器会自动注入路径。

方案三：基于Spring Boot自动配置实现（推荐） #

如果允许应用通过配置参数指定数据库，而非手动创建Bean，可以在库中编写自动配置类，完全封装JPA配置细节：

// 库中的自动配置类
@Configuration
@EnableJpaRepositories(
        basePackages = "com.your.lib.repository",
        entityManagerFactoryRef = "specifiedEntityManagerFactory",
        transactionManagerRef = "specifiedTransactionManager"
)
@EntityScan(basePackages = "com.your.lib.entity")
@ConditionalOnProperty(prefix = "lib.db", name = "url") // 配置了库的数据库URL时生效
public class LibJpaAutoConfiguration {

    @Bean(name = "libDataSource")
    @ConfigurationProperties(prefix = "lib.db")
    public DataSource libDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "specifiedEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(@Qualifier("libDataSource") DataSource dataSource) {
        LocalContainerEntityManagerFactoryBean em = new LocalContainerEntityManagerFactoryBean();
        em.setDataSource(dataSource);
        em.setPackagesToScan("com.your.lib.entity"); // 确保实体包被扫描

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

        return em;
    }

    @Bean(name = "specifiedTransactionManager")
    public PlatformTransactionManager transactionManager(@Qualifier("specifiedEntityManagerFactory") EntityManagerFactory emf) {
        return new JpaTransactionManager(emf);
    }
}

然后在库的META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中添加自动配置类的全类名：

com.your.lib.config.LibJpaAutoConfiguration

应用侧只需在配置文件中添加数据库参数即可，无需任何JPA配置代码：

lib.db.url=jdbc:mysql://localhost:3306/lib_db
lib.db.username=root
lib.db.password=123456
lib.db.driver-class-name=com.mysql.cj.jdbc.Driver

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