ImportSelector实战解析

## Spring动态配置选择：ImportSelector实战解析

在Spring框架中，@Import注解是一个强大的工具，它允许我们导入其他@Configuration类中的bean定义。更进一步，@Import注解可以与ImportSelector接口结合使用，以编程方式根据某些选择标准动态选择@Configuration类。本文将通过一个实例来详细解析ImportSelector的使用方法和应用场景。

## 实现ImportSelector

首先，我们来看一个基于系统属性值选择@Configuration类的示例。

```
public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        String prop = System.getProperty("myProp");
        if ("someValue".equals(prop)) {
            return new String[]{MyConfig1.class.getName()};
        } else {
            return new String[]{MyConfig2.class.getName()};
        }
    }
}

@Configuration
public class MyConfig1 {
    @Bean
    AppBean appBean() {
        return new AppBean("from config 1");
    }
}

@Configuration
public class MyConfig2 {
    @Bean
    AppBean appBean() {
        return new AppBean("from config 2");
    }
}

public class AppBean {
    private String message;
    public AppBean(String message) {
        this.message = message;
    }
    public String getMessage() {
        return message;
    }
}

```

在上述代码中，MyImportSelector根据系统属性myProp的值来决定加载MyConfig1还是MyConfig2。MyConfig1和MyConfig2分别定义了一个AppBean，它们的消息不同。

## 主配置类

接下来是主配置类，它使用@Import注解来引入MyImportSelector。

```
@Configuration
@Import(MyImportSelector.class)
public class MainConfig {
    @Bean
    ClientBean clientBean() {
        return new ClientBean();
    }
}

public class ClientBean {
    @Autowired
    private AppBean appBean;
    public void doSomething() {
        System.out.println(appBean.getMessage());
    }
}
```

## 主方法

最后，我们来看主方法，它设置了系统属性并启动了Spring应用上下文。

```
public class ImportSelectorExample {
    public static void main(String[] args) {
        System.setProperty("myProp", "someValue");
        ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
        ClientBean bean = context.getBean(ClientBean.class);
        bean.doSomething();
    }
}
```

输出结果将是from config 1，因为系统属性myProp被设置为someValue。

## 使用注解的ImportSelector

接下来，我们来看如何使用自定义注解与ImportSelector结合使用。

```
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(MyImportSelector.class)
public @interface EnableSomeModule {
    String value() default "";
}
```

在主配置类中，我们使用新的注解而不是直接使用@Import。

```
@Configuration
@EnableSomeModule("someValue")
public static class MainConfig {
    @Bean
    ClientBean clientBean() {
        return new ClientBean();
    }
}
```

其他类保持不变。主方法如下：

```
public class ImportSelectorWithAnnotationExample {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(MainConfig.class);
        ClientBean bean = context.getBean(ClientBean.class);
        bean.doSomething();
    }
}
```

输出结果同样是from config 1。

## ImportSelector的应用场景

ImportSelector可以用于动态配置选择，而不是静态的基于@Profile的选择。Spring框架本身在许多地方使用ImportSelector来减轻客户端的配置负担，例如@EnableAsync、@EnableScheduling等。

## 本项目使用

![](/media/202502/2025-02-07_100724_4593940.5397502979162344.png)

![](/media/202502/2025-02-07_100744_2723000.3362968801676307.png)