当前位置：首页 > article >正文

Spring Framework IOC依赖查找 - 按类型查找解析

article 2024/9/20 12:20:18

在Spring框架中，控制反转（IoC）是一种设计模式，它通过将对象的创建和管理交给容器来实现。依赖查找是IoC的一部分，它允许你从容器中查找所需的依赖项。按类型进行依赖查找是其中的一种方式，今天来讲Spring Framework中通过类型查找。

tips：

在Spring Framework中，同一个类型的类可能存在多个Bean，如：

同一类型的多个实现
通过配置文件定义多个Bean
同一类型的多个实例

示例代码：

同一类型的多个实现：

public interface MyInterface {
    //...
}

@Service
@Qualifier("implementation1")
public class MyInterfaceImpl1 implements MyInterface {
    //...
}

@Service
@Qualifier("implementation2")
public class MyInterfaceImpl2 implements MyInterface {
    //...
}

在使用的地方：

@Autowired
@Qualifier("implementation1")
private MyInterface myInterface;

当一个接口有多个实现类时，你可能会定义多个Bean，每个Bean都是该接口的一个具体实现。在这种情况下，你可以使用 @Qualifier注解或者primary属性来指定要注入的具体实现。

@Qualifier用来在多个候选Bean中明确指定要注入的Bean。
@Primary是当存在多个同类型的Bean时，配置中指定一个主Bean，在使用时去加载主Bean。

更多关于@Qualifier注解的详细内容请看：

# 从源码中看@Qualifier注解

通过配置文件定义多个Bean

@Configuration
public class AppConfig {

    @Bean(name = "dataSource1")
    public DataSource dataSource1() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/database1");
        dataSource.setUsername("username1");
        dataSource.setPassword("password1");
        return dataSource;
    }

    @Bean(name = "dataSource2")
    public DataSource dataSource2() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName("com.mysql.cj.jdbc.Driver");
        dataSource.setUrl("jdbc:mysql://localhost:3306/database2");
        dataSource.setUsername("username2");
        dataSource.setPassword("password2");
        return dataSource;
    }
}

AppConfig配置类定义了两个名为"bean1"和"bean2"的MyBean类型的Bean，这两个类分别有不同的实现逻辑，在不同的逻辑中去调用。

同一类型的多个实例

@Service
@Scope("prototype")
public class MyPrototypeBean {
    //...
}

有时候，即使是同一个类，你可能希望在Spring容器中创建多个实例。这种情况下，你可以使用@Scope注解，将作用域设置为prototype，这样每次依赖查找时都会创建一个新的实例。

按类型查找单一Bean

SuperUser继承自User，有了继承关系后，User类便有了两个Bean，因此在注入时Spring Framework无法确认使用哪个Bean，因此在SuperUser的配置中使用primary配置SuperUser为主Bean，以在注入时给Spring Framework明确使用User类的哪个Bean。

<bean id="superUser" class="org.geekbang.thinking.in.spring.ioc.overview.domain.SuperUser" parent="user" primary="true">
    <property name="address" value="QingDao"/>
</bean>

private static void lookupByType(BeanFactory beanFactory) {
    SuperUser superUser = beanFactory.getBean(SuperUser.class);
    System.out.println("实时查找：" + superUser);
}

单一Bean测试

按类型查找某一类型的所有Bean

private static void lookupCollectionByType(BeanFactory beanFactory) {
    if (beanFactory instanceof ListableBeanFactory) {
        ListableBeanFactory listableBeanFactory = (ListableBeanFactory) beanFactory;
        Map<String, User> users = listableBeanFactory.getBeansOfType(User.class);
        System.out.println("查找到的所有的 User 集合对象：" + users);
    }
}

所有Bean测试

知识补充：ListableBeanFactory

ListableBeanFactory是Spring框架中的一个接口，继承自BeanFactory接口，用于描述可以列举（listable）所有Beans的Bean工厂。它提供了一组方法，允许检索容器中的所有Bean定义、按照类型检索Beans等。通过使用ListableBeanFactory，你可以在运行时动态地获取和操作Spring容器中的Bean信息，这对于某些高级场景，如插件系统、自动化测试等非常有用。