注入 bean 失败常犯错误大揭秘

后端

2023-07-24 17:25:41

避免bean注入失败：常见问题及解决方法

在Spring Boot开发中，bean注入是不可或缺的一部分。然而，注入bean时失败的情况也时有发生，令人苦恼不已。本文将深入探讨bean注入失败的常见原因及其解决办法，帮助你迅速定位和解决问题。

常见注入失败原因

1.未扫描bean

原因：bean所在的包未被@SpringBootApplication注解扫描。

解决方案：确保bean所在的包被@SpringBootApplication注解扫描。

2.多模块架构下bean未被扫描

原因：多模块架构中，不同模块的bean需要在主模块的pom.xml文件中添加依赖。

解决方案：在主模块的pom.xml文件中添加对其他模块的依赖。

3.使用@Qualifier或@Resource时name不存在

原因：使用@Qualifier或@Resource注解注入bean时，指定的bean name不存在。

解决方案：确保指定的bean name与实际bean的name一致。

4.bean依赖未正确注入

原因：bean依赖于其他bean，但依赖没有在构造函数或setter方法中正确注入。

解决方案：确保bean的依赖已正确注入。

5.bean生命周期不正确

原因：bean的生命周期有singleton和prototype两种。如果设置不当，会导致注入失败。

解决方案：确保bean的生命周期设置正确。

6.bean作用域不正确

原因：bean的作用域有singleton、prototype、request、session和global session等。设置不当会导致注入失败。

解决方案：确保bean的作用域设置正确。

深入案例解析

以下是代码示例，演示bean注入失败的不同情况：

// Bean未扫描
@Service
public class UserService {

}

// 多模块架构下bean未扫描
@SpringBootApplication
public class MainApplication {

}

// 使用@Qualifier时name不存在
@Service
public class UserServiceImpl implements UserService {

}

@Configuration
public class AppConfig {

    @Bean
    @Qualifier("UserServiceImpl")
    public UserService userService() {
        return new UserServiceImpl();
    }

}

// bean依赖未正确注入
@Service
public class OrderService {

    private UserService userService;

    public OrderService(UserService userService) {
        this.userService = userService;
    }

}

@Configuration
public class AppConfig {

    @Bean
    public UserService userService() {
        return new UserService();
    }

}

// bean生命周期不正确
@Service
@Scope("prototype")
public class SingletonService {

}

// bean作用域不正确
@Service
@Scope("request")
public class ApplicationScopeService {

}

运行这些代码时，会分别抛出如下异常：

// Bean未扫描
java.lang.IllegalStateException: No bean named 'userService' available

// 多模块架构下bean未扫描
java.lang.ClassNotFoundException: org.springframework.boot.autoconfigure.SpringBootApplication

// 使用@Qualifier时name不存在
java.lang.IllegalArgumentException: No qualifying bean of type 'org.springframework.beans.factory.FactoryBean' available: expected single matching bean but found 2: userService,userServiceImpl

// bean依赖未正确注入
java.lang.NullPointerException: null

// bean生命周期不正确
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'singletonService': Unsatisfied dependency expressed through field 'userService'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'userService' available

// bean作用域不正确
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'applicationScopeService': Unsatisfied dependency expressed through field 'userService'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'userService' available