SpringBoot外部库接口实现自动装配失败及无扫描包配置方案咨询

问题描述 #

我为SpringBoot应用编写了一个公共库并打包为jar，库内的MyService通过@Autowired注入AbstractUserService接口：

@Service
public class MyService {
    protected @Autowired AbstractUserService abstractUserService;
}

public interface AbstractUserService {
    Optional<? extends AbstractUser> findByPrincipal(Principal principal);
}

在主应用的build.gradle中通过以下方式引入该库：

...
repositories {
    flatDir {
        dirs "$rootDir/libs"
    }
}
...
dependencies {
    ...
    implementation name: "my-library"
    ...
}

随后我在主应用中实现了该接口：

@Service
public class UserService implements AbstractUserService {
    @Override 
    public Optional<? extends AbstractUser> findByPrincipal(Principal principal) {
        // do something
    }
}

但启动时抛出异常，提示找不到AbstractUserService类型的bean：

Parameter 1 of constructor in MyService required a bean of type 'AbstractUserService' that could not be found.

我已经在主应用添加注解扫描库的包：

@SpringBootApplication(scanBasePackages = {"the.root.package.of.my-library"})

请问该如何解决此问题？同时，有没有无需显式配置scanBasePackages即可自动装配库中服务的更好方案？

解决方案 #

1. 修复当前找不到Bean的问题

你当前的@SpringBootApplication仅配置了扫描库的包，未包含主应用自身的包，导致主应用内的UserService没有被Spring扫描并注册为Bean。修改scanBasePackages，同时包含主应用和库的根包：

@SpringBootApplication(scanBasePackages = {
    "com.your.main.app.root.package", 
    "the.root.package.of.my-library"
})

也可以使用scanBasePackageClasses指定具体类，避免硬编码包名：

@SpringBootApplication(scanBasePackageClasses = {
    YourMainApplicationClass.class, 
    MyService.class
})

2. 无需显式配置扫描的最优方案

利用Spring Boot的@AutoConfiguration机制，实现公共库的自动装配，无需主应用手动配置扫描包：

• 在公共库中创建自动配置类，用@Configuration和@ComponentScan扫描库内组件：

@Configuration
@ComponentScan(basePackages = "the.root.package.of.my-library")
public class MyLibraryAutoConfiguration {
}

• 在库的src/main/resources/META-INF目录下创建spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，内容为自动配置类的全限定名：

the.root.package.of.my-library.MyLibraryAutoConfiguration

主应用引入该库后，Spring Boot会自动识别并加载这个配置类，完成库内组件的扫描。主应用只需保持默认扫描逻辑（@SpringBootApplication默认扫描主类所在包及子包），确保UserService在扫描范围内即可。

内容的提问来源于stack exchange，提问作者Mihai Catalin Valentin