已有自定义JPA Repository时，如何自动配置Spring Boot JPA仓库？

问题根源 #

当消费服务自身包含JPA实体与仓库时，@SpringBootApplication默认的扫描范围（主类所在包及其子包）会与starter中的扫描逻辑冲突：

• 若消费服务显式声明@EntityScan或@EnableJpaRepositories，会完全替换starter的扫描规则，导致双方的实体/仓库无法被同时识别
• 若消费服务未显式声明，starter的@EntityScan会覆盖默认扫描，导致消费服务自身的实体/仓库无法被扫描

解决方案 #

通过Spring Boot的扩展机制，向现有扫描范围追加starter的实体与仓库包，而非替换。核心是实现自定义扫描注册器，让starter的扫描逻辑与消费服务的扫描逻辑兼容。

步骤1：实现实体扫描注册器 #

创建注册器向Spring的全局实体扫描包集合中添加starter的实体包：

package com.example.library.autoconfigure;

import org.springframework.boot.autoconfigure.domain.EntityScanPackages;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;

public class LibraryEntityScanRegistrar implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        // 将starter的实体包添加到全局扫描集合
        EntityScanPackages.register(registry, LibraryEntityMarker.ENTITY_MARKER);
    }
}

步骤2：实现JPA仓库扫描注册器 #

继承Spring Data的注册器基类，注册starter的仓库包，与消费服务的扫描范围合并：

package com.example.library.autoconfigure;

import org.springframework.data.jpa.repository.config.JpaRepositoryConfigExtension;
import org.springframework.data.repository.config.RepositoryBeanDefinitionRegistrarSupport;
import org.springframework.data.repository.config.RepositoryConfigurationExtension;

public class LibraryJpaRepositoryRegistrar extends RepositoryBeanDefinitionRegistrarSupport {
    @Override
    protected RepositoryConfigurationExtension getExtension() {
        return new JpaRepositoryConfigExtension();
    }

    @Override
    protected String getRepositoryFactoryBeanClassName() {
        return "org.springframework.data.jpa.repository.support.JpaRepositoryFactoryBean";
    }

    @Override
    protected void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
        // 注册starter的仓库包
        registerRepositoriesIn(LibraryRepositoryMarker.REPO_MARKER, registry);
    }
}

步骤3：修改自动配置类 #

移除原有的@EntityScan和@ImportAutoConfiguration，导入上述两个注册器：

@Slf4j
@AutoConfiguration
@Import({ LibraryService.class, LibraryEntityScanRegistrar.class, LibraryJpaRepositoryRegistrar.class })
public class LibraryAutoConfiguration {
    public LibraryAutoConfiguration() {
        log.info("Loaded autoconfiguration");
    }
}

步骤4：确保自动配置被Spring Boot发现 #

在starter的src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中添加自动配置类的全类名：

com.example.library.autoconfigure.LibraryAutoConfiguration

验证效果 #

消费服务只需添加starter依赖，保持原有@SpringBootApplication即可自动扫描双方的实体与仓库：

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
        // 可直接注入LibraryRepository和MyRepository
    }
}

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