Spring 6.1.10在Spigot插件中无法扫描@Component注解类问题

1. 核对@ComponentScan的包路径准确性 #

• 确认CommandTest的实际包名确实落在xyz.abc或其子包下，比如xyz.abc.commands这种子包是符合扫描范围的，但如果是xyz.abcd这类无关包就会被遗漏。
• 可以换用更可靠的basePackageClasses方式指定扫描范围，避免字符串路径写错：@ComponentScan(basePackageClasses = {CommandTest.class, SpringConfig.class})，或者明确列出所有需要扫描的子包：@ComponentScan(basePackages = {"xyz.abc", "xyz.abc.commands"})

2. 检查CommandTest的类修饰符与注解有效性 #

• 确保CommandTest是public修饰类，Spring默认只扫描public类作为组件，包访问权限（无修饰符）的类会被忽略。
• 确认@Component注解是org.springframework.stereotype.Component，别误用了其他框架的同名注解。

3. 处理Spigot插件类加载器冲突问题 #

• Spigot插件使用独立的类加载器，Spring默认类加载器可能和插件类加载器不一致，导致扫描不到插件内的类。解决方式是初始化上下文时指定插件的类加载器：

@Override
public void onPluginStart() {
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
    context.setClassLoader(this.getClass().getClassLoader()); // 绑定插件主类的类加载器
    context.register(SpringConfig.class);
    context.refresh();
}

4. 确认Spring上下文初始化流程完整性 #

• 检查onPluginStart里的上下文初始化代码，有没有漏掉refresh()调用？只创建上下文或注册配置类，但不执行refresh()的话，Spring不会触发组件扫描和Bean初始化。
• 标准初始化流程示例：

@Override
public void onPluginStart() {
    // 方式1：直接传入配置类
    AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringConfig.class);
    // 方式2：分步初始化
    // AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext();
    // applicationContext.register(SpringConfig.class);
    // applicationContext.refresh();
}

5. 排查是否存在扫描过滤规则 #

• 检查SpringConfig的@ComponentScan是否带有excludeFilters/includeFilters参数，这类规则可能无意中排除了CommandTest类。

6. 开启Spring DEBUG日志定位问题 #

• 在插件日志配置中添加DEBUG级别日志，查看组件扫描的详细过程：

logging.level.org.springframework.context.annotation=DEBUG

• 从日志中可以看到Spring是否扫描了CommandTest所在的包、是否识别到该类为候选组件，或者有没有被排除的具体原因，快速定位问题点。

内容的提问来源于stack exchange，提问作者Michał Łuczak