如何让Spring Boot加载运行时依赖中定义的注解式资源

这个问题的核心原因是Spring Boot默认组件扫描仅覆盖启动类所在包及其子包，不会主动扫描依赖JAR下其他包路径的注解组件，可根据场景选择以下三种方案实现：

方案1：显式扩展组件扫描范围（快速接入） #

直接在服务项目的启动类上修改@SpringBootApplication注解的扫描路径，把共享库的根包加入扫描范围即可。
举个例子，如果你的共享库根包为com.yourcompany.common，服务启动类所在包为com.yourcompany.service，配置代码如下：

@SpringBootApplication(scanBasePackages = {"com.yourcompany.service", "com.yourcompany.common"})
public class OrderServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }
}

配置后，共享库包下所有标注了@Component、@Service、@ControllerAdvice、@Configuration的组件、事件监听器、Spring Security配置类都会被自动扫描加载，你写的ApiExceptionHandler不需要额外修改就能正常生效。
该方案优缺点：接入简单，适合内部快速迭代的场景；缺点是每个接入共享库的服务都要手动修改启动类配置，如果后续共享库根包调整，所有服务都需要同步修改。

方案2：@Import精准导入指定组件（可控性高） #

如果你不想全量扫描共享库的所有包，避免加载到不需要的类，可以直接用@Import注解指定要加载的组件。
如果要单独导入通用异常处理器，直接在启动类或者任意配置类上加注解即可：

@SpringBootApplication
@Import(ApiExceptionHandler.class)
public class OrderServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }
}

如果共享库要导出的组件比较多，可以在共享库内部写一个空的聚合配置类，把所有需要对外暴露的组件统一导入，服务端只需要导入这一个配置类就能加载所有通用能力：

// 位于共享库内的聚合配置类
@Configuration
@Import({
    ApiExceptionHandler.class,
    CommonSecurityConfig.class,
    CommonComponent.class,
    CommonEventHandler.class
})
public class CommonLibAutoConfig {
    // 无需写任何代码，仅作为组件聚合入口
}

该方案优缺点：组件加载完全可控，不会出现意外加载冗余类的问题；缺点同样是需要每个接入服务手动添加@Import配置。

方案3：Spring Boot原生自动配置（官方推荐，零接入成本） #

这是公共通用JAR的最优实现方案，服务端只需要把共享JAR加为Maven/Gradle依赖，不需要写任何额外配置，Spring Boot就会自动识别并加载共享库中的组件。
配置步骤都在共享库侧完成，不需要修改服务端代码：

1. 先在共享库中准备好上面提到的聚合配置类CommonLibAutoConfig，把所有需要自动加载的组件都导入进去。
2. 根据你使用的Spring Boot版本，选择对应的方式注册自动配置类：
   • 若使用Spring Boot 2.7及以上版本：在共享库的src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中，添加聚合配置类的全限定名：

     com.yourcompany.common.CommonLibAutoConfig
     

   • 若使用Spring Boot 2.7以下版本：在共享库的src/main/resources/META-INF/spring.factories文件中添加如下配置：

     org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
     com.yourcompany.common.CommonLibAutoConfig
     

实用提示：你可以在自动配置类或者组件上添加条件注解，实现按需加载，避免非Web场景下加载Web相关组件报错。比如给你的ApiExceptionHandler添加@ConditionalOnWebApplication(type = Type.SERVLET)注解，就只会在Servlet Web项目中加载这个异常处理器；添加@ConditionalOnMissingBean注解可以让服务端自定义的同类型组件优先，不会和业务自定义配置冲突。

针对ApiExceptionHandler的额外说明 #

只要该类被上述任意一种方式纳入Spring容器管理，Spring MVC就会自动识别它作为全局异常处理器，不需要额外配置。如果需要避免和服务端自定义的异常处理器冲突，可以在@ControllerAdvice注解上指定生效的包范围，比如@ControllerAdvice(basePackages = "com.yourcompany")，限定它只处理指定包下控制器抛出的异常。

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