SpringBoot中无法将EventPublisher组件自动注入到Service的问题

问题概述 #

在SpringBoot 4.2应用中实现事件处理功能时，将自定义EventPublisher组件注入PositionService时失败，抛出NoSuchBeanDefinitionException，提示找不到com.mycompany.myproject.event.EventPublisher类型的合格Bean。

报错信息 #

2023-01-30 18:54:15 DEBUG Processing injected element of bean 'positionService': AutowiredFieldElement for com.mycompany.myproject.event.EventPublisher com.mycompany.myproject.service.PositionService.eventPublisher
2023-01-30 18:54:15 WARN Exception encountered during context initialization - cancelling refresh attempt
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'positionService': Injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException: Could not autowire field: com.mycompany.myproject.event.EventPublisher com.mycompany.myproject.service.PositionService.eventPublisher; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type [com.mycompany.myproject.event.EventPublisher] found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
    at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.postProcessPropertyValues(AutowiredAnnotationBeanPostProcessor.java:334)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.populateBean(AbstractAutowireCapableBeanFactory.java:1214)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:543)
    at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:482)
    at org.springframework.beans.factory.support.AbstractBeanFactory$1.getObject(AbstractBeanFactory.java:305)
    at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:230)
    at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:301)
    at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:196)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.preInstantiateSingletons(DefaultListableBeanFactory.java:772)
    at org.springframework.context.support.AbstractApplicationContext.finishBeanFactoryInitialization(AbstractApplicationContext.java:834)
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:537)
    at org.springframework.web.context.ContextLoader.configureAndRefreshWebApplicationContext(ContextLoader.java:403)
    at org.springframework.web.context.ContextLoader.initWebApplicationContext(ContextLoader.java:306)
    at org.springframework.web.context.ContextLoaderListener.contextInitialized(ContextLoaderListener.java:106)
    at org.apache.catalina.core.StandardContext.listenerStart(StandardContext.java:4762)
    at org.apache.catalina.core.StandardContext.startInternal(StandardContext.java:5222)
    at org.apache.catalina.util.LifecycleBase.start(LifecycleBase.java:183)
    at org.apache.catalina.core.ContainerBase.addChildInternal(ContainerBase.java:726)
    at org.apache.catalina.core.ContainerBase.addChild(ContainerBase.java:698)
    at org.apache.catalina.core.StandardHost.addChild(StandardHost.java:696)
    at org.apache.catalina.startup.HostConfig.deployDescriptor(HostConfig.java:689)
    at org.apache.catalina.startup.HostConfig$DeployDescriptor.run(HostConfig.java:1888)
    at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
    at java.util.concurrent.FutureTask.run$$$capture(FutureTask.java:266)
    at java.util.concurrent.FutureTask.run(FutureTask.java)
    at org.apache.tomcat.util.threads.InlineExecutorService.execute(InlineExecutorService.java:75)
    at    Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type [com.mycompany.myproject.event.EventPublisher] found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoSuchBeanDefinitionException(DefaultListableBeanFactory.java:1326)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1072)
    at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:967)
    at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor$AutowiredFieldElement.inject(AutowiredAnnotationBeanPostProcessor.java:543)
    ... 58 more

相关代码片段 #

EventPublisher类 #

@Component
public class EventPublisher {
    @Autowired 
    private ApplicationEventPublisher applicationEventPublisher;
 

    public void publishEvent(String message, Integer eventId) {
        applicationEventPublisher.publishEvent(
                new UserEvent(this, message, eventId)
        );
    }
}

PositionService类 #

@Service
public class PositionService extends BaseService implements IPositionService {
    private final Logger LOGGER = LoggerFactory.getLogger(this.getClass());

    @Autowired
    EventPublisher eventPublisher;
}

排查与解决方案 #

• 检查包扫描范围：SpringBoot默认扫描主启动类所在包及其子包。确认EventPublisher所在的com.mycompany.myproject.event包是否在主启动类的扫描范围内。若主启动类不在com.mycompany.myproject下，需在主启动类添加@ComponentScan(basePackages = "com.mycompany.myproject")指定扫描路径。
• 验证@Component注解有效性：确认EventPublisher类上的@Component是Spring提供的org.springframework.stereotype.Component，而非其他框架的同名注解。
• 排查Bean排除规则：检查项目配置类中是否存在@ComponentScan(excludeFilters = ...)，或EventPublisher类上是否有@Conditional相关注解，导致Bean未被实例化。
• 统一Spring依赖版本：若项目存在多版本Spring依赖冲突，会导致注解处理异常。检查pom.xml或build.gradle，确保SpringBoot依赖版本统一，无混用不同版本的Spring核心包。
• 简化实现（可选）：无需自定义EventPublisher，Spring容器原生提供ApplicationEventPublisher，可直接注入到PositionService中使用：

  @Service
  public class PositionService extends BaseService implements IPositionService {
      private final Logger LOGGER = LoggerFactory.getLogger(this.getClass());
  
      @Autowired
      ApplicationEventPublisher applicationEventPublisher;
  
      // 示例：发布事件
      public void publishUserEvent(String message, Integer eventId) {
          applicationEventPublisher.publishEvent(new UserEvent(this, message, eventId));
      }
  }
  

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