如何在自定义Spring Boot Starter的自动配置中添加Entity至Spring上下文

我来帮你搞定这个问题！你当前的问题出在对AutoConfigurationPackages.register()的用法理解上——这个方法是用来告诉Spring Boot自动配置类所在的包路径，而不是让JPA扫描实体类的包，所以即使调用了它，你的starter实体依然不会被JPA识别到。

下面给你几个靠谱的解决方案，按推荐程度排序：

方案一：直接在自动配置类上添加@EntityScan（最推荐） #

这是最符合Spring Boot自动配置风格的做法，只需要在你的starter自动配置类上加上@EntityScan，指定starter中实体类所在的包即可。主应用的实体类扫描会和starter的扫描自动叠加，不会互相覆盖。

示例代码：

@Configuration
// 替换成你starter实体类所在的实际包路径
@EntityScan(basePackages = "com.your.starter.entity")
public class StarterAutoConfiguration {
    // 其他自动配置逻辑，比如Repository的配置等
}

这样一来，当依赖该starter的Spring Boot应用启动时：

• 如果主应用没有显式添加@EntityScan，JPA会默认扫描主类所在包，同时starter的@EntityScan会额外扫描指定的starter实体包
• 如果主应用自己加了@EntityScan，它会扫描自己指定的包，starter的@EntityScan也会生效，两者的扫描范围是叠加的

方案二：通过ImportBeanDefinitionRegistrar动态注册实体扫描 #

如果你需要更灵活的控制（比如允许用户开关starter的实体扫描），可以通过自定义ImportBeanDefinitionRegistrar来注册EntityScan的Bean定义，手动指定要扫描的starter实体包：

public class StarterEntityRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 构建EntityScan的Bean定义，指定starter实体包
        BeanDefinitionBuilder entityScanBuilder = BeanDefinitionBuilder.genericBeanDefinition(EntityScan.class);
        entityScanBuilder.addPropertyValue("basePackages", new String[]{"com.your.starter.entity"});
        // 注册这个Bean定义到Spring上下文
        registry.registerBeanDefinition("starterEntityScanConfig", entityScanBuilder.getBeanDefinition());
    }
}

然后在你的自动配置类上导入这个Registrar：

@Configuration
@Import(StarterEntityRegistrar.class)
public class StarterAutoConfiguration {
    // 其他配置
}

方案三：自定义EntityManagerFactory合并扫描包 #

如果需要对JPA的实体扫描做更精细的控制（比如合并主应用和starter的扫描包），可以通过自定义EntityManagerFactory来实现：

@Configuration
public class StarterJpaConfiguration {

    // 注入Spring Boot自动配置包的上下文，包含主应用的包路径
    @Autowired
    private List<AutoConfigurationPackages> autoConfigurationPackages;

    @Bean
    public LocalContainerEntityManagerFactoryBean entityManagerFactory(EntityManagerFactoryBuilder builder) {
        // 获取主应用的自动配置包列表
        List<String> scanPackages = new ArrayList<>(autoConfigurationPackages.get(0).getPackageNames());
        // 添加starter的实体包到扫描列表
        scanPackages.add("com.your.starter.entity");
        
        // 构建EntityManagerFactory，指定合并后的扫描包
        return builder
                .packages(scanPackages.toArray(new String[0]))
                // 这里可以添加其他JPA配置，比如数据源、持久化单元名等
                .build();
    }
}

额外注意事项 #

• 确保starter中的实体类都正确添加了@Entity、@Id等JPA注解，没有语法错误
• 检查starter的pom.xml是否正确引入了spring-boot-starter-data-jpa依赖，且依赖范围为compile（确保能传递给主应用）
• 如果主应用显式使用了@EntityScan，不要忘记它可以指定多个包，比如@EntityScan(basePackages = {"com.your.app.entity", "com.your.starter.entity"})，不过通常starter的@EntityScan会自动生效，不需要主应用额外配置

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