@Import註解用來幫助我們把一些需要定義爲Bean的類導入到IOC容器裏面。下面我們就對@Import註解的使用做一個簡單的總結。
一 @Import引入普通類
@Import引入普通的類可以幫助我們把普通的類定義爲Bean。@Import可以添加在@SpringBootApplication(啓動類)、@Configuration(配置類)、@Component(組件類)對應的類上。
注意:@RestController、@Service、@Repository都屬於@Component
@SpringBootApplication
@Import(ImportBean.class) // 通過@Import註解把ImportBean添加到IOC容器裏面去
public class MyBatisApplication {
public static void main(String[] args) {
SpringApplication.run(MyBatisApplication.class, args);
}
}
二 @Import引入配置類(@Configuration修飾的類)
@Import除了可以把普通的類定義爲Bean,@Import還可以引入一個@Configuration修飾的類(引入配置類),從而把讓配置類生效(配置類下的所有Bean添加到IOC容器裏面去)。在自定義starter的時候經常會用到。
如果配置類在標準的SpringBoot包結構下(SpringBootApplication啓動類包的根目錄下)。是不需要@Import導入配置類的,SpringBoot自動幫做了。上面的情況一般用於@Configuration配置類不在標準的SpringBoot包結構下面。所以一般在自定義starter的時候用到。
@Configuration(proxyBeanMethods = false)
@Import({ // import了兩個哈
XXXDataConfiguration.XXXPartOneConfiguration.class,
XXXDataConfiguration.XXXPartTwoConfiguration.class
})
public class XXXDataAutoConfiguration {
}
public class XXXDataConfiguration {
@Configuration(proxyBeanMethods = false)
static class XXXPartOneConfiguration {
@Bean
@ConditionalOnMissingBean
public BeanForIoc beanForIoc() {
return new BeanForIoc();
}
}
@Configuration(proxyBeanMethods = false)
static class XXXPartTwoConfiguration {
/**
* 省略了@Bean的使用
*/
}
}
三 @Import引入ImportSelector的實現類
@Import還可以引入ImportSelector的實現類,把ImportSelector接口selectImports()方法返回的Class名稱都定義爲bean。注意selectImports()方法的參數AnnotationMetadata,通過這個參數我們可以獲取到@Import標註的Class的各種信息。這一點特別有用,用於做一些參數的傳遞。在SpringBoot的自動化配置和@EnableXXX(功能性註解)都有它的存在。
public interface ImportSelector {
/**
* 用於指定需要註冊爲bean的Class名稱
* 當在@Configuration標註的Class上使用@Import引入了一個ImportSelector實現類後,會把實現類中返回的Class名稱都定義爲bean。
*
* 通過其參數AnnotationMetadata importingClassMetadata可以獲取到@Import標註的Class的各種信息,
* 包括其Class名稱,實現的接口名稱、父類名稱、添加的其它註解等信息,通過這些額外的信息可以輔助我們選擇需要定義爲Spring bean的Class名稱
*/
String[] selectImports(AnnotationMetadata importingClassMetadata);
}
關於@Import引入ImportSelector的實現類的使用,我們舉幾個簡單的使用場景(實際開發肯定比這複雜的多的)。
2.1 靜態import場景(注入已知的類)
靜態場景(注入已知的類),很簡單通過實現ImportSelector類把我們需要定義爲bean的類直接返回就好, 比如下面的例子。我們來一個EnableXXX的註解,通過XXXConfigurationSelector注入一個已知的類XXX。
/**
* XXXConfigurationSelector一定要配合@Import使用
*/
public class XXXConfigurationSelector implements ImportSelector {
@Override
@NonNull
public String[] selectImports(@NonNull AnnotationMetadata importingClassMetadata) {
// 把XXX對應的類,定義爲Bean
return new String[]{XXX.class.getName()};
}
}
/**
* 注意 @Import(XXXConfigurationSelector.class)
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(XXXConfigurationSelector.class)
public @interface EnableXXX {
}
@SpringBootApplication
@EnableXXX // 使之生效
public class MyBatisApplication {
public static void main(String[] args) {
SpringApplication.run(MyBatisApplication.class, args);
}
}
2.2 動態import場景(注入指定條件的類)
我們做一個這樣的功能,我們需要把指定包路徑下所有實現了HelloService接口的類做爲bean添加到IOC容器裏面去。@ComponentScan註解用來幫我們指定路徑。具體實現如下:
public interface HelloService {
void function();
}
public class DynamicSelectImport implements ImportSelector {
/**
* DynamicSelectImport需要配合@Import()註解使用
* <p>
* 通過其參數AnnotationMetadata importingClassMetadata可以獲取到@Import標註的Class的各種信息,
* 包括其Class名稱,實現的接口名稱、父類名稱、添加的其它註解等信息,通過這些額外的信息可以輔助我們選擇需要定義爲Spring bean的Class名稱
*/
@Override
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
// 第一步:獲取到通過ComponentScan指定的包路徑
String[] basePackages = null;
// @Import註解對應的類上的ComponentScan註解
if (importingClassMetadata.hasAnnotation(ComponentScan.class.getName())) {
Map<String, Object> annotationAttributes = importingClassMetadata.getAnnotationAttributes(ComponentScan.class.getName());
basePackages = (String[]) annotationAttributes.get("basePackages");
}
if (basePackages == null || basePackages.length == 0) {
//ComponentScan的basePackages默認爲空數組
String basePackage = null;
try {
// @Import註解對應的類的包名
basePackage = Class.forName(importingClassMetadata.getClassName()).getPackage().getName();
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
basePackages = new String[]{basePackage};
}
// 第er步,知道指定包路徑下所有實現了HelloService接口的類(ClassPathScanningCandidateComponentProvider的使用)
ClassPathScanningCandidateComponentProvider scanner = new ClassPathScanningCandidateComponentProvider(false);
TypeFilter helloServiceFilter = new AssignableTypeFilter(HelloService.class);
scanner.addIncludeFilter(helloServiceFilter);
Set<String> classes = new HashSet<>();
for (String basePackage : basePackages) {
scanner.findCandidateComponents(basePackage).forEach(beanDefinition -> classes.add(beanDefinition.getBeanClassName()));
}
// 第三步,返回添加到IOC容器裏面去
return classes.toArray(new String[0]);
}
}
@Configuration
@ComponentScan("com.tuacy.collect.mybatis") // 指定路徑
@Import(DynamicSelectImport.class)
public class DynamicSelectConfig {
}
四 @Import引入ImportBeanDefinitionRegistrar的實現類
@Import引入ImportBeanDefinitionRegistrar的實現類。一般用來動態註冊bean。最重要的一點是還可以對這些BeanDefinition進行額外的修改或增強。咱們經常使用的mybatis @MapperScan就是用這種方式實現的。
/**
* ImportBeanDefinitionRegistrar,我們一般會實現ImportBeanDefinitionRegistrar類,然後配合一個自定義的註解一起使用。而且在註解類上@Import我們的這個實現類。
* 通過自定義註解的配置,拿到註解的一些元數據。然後在ImportBeanDefinitionRegistrar的實現類裏面做相應的邏輯處理,比如把自定義註解標記的類添加到Spring IOC容器裏面去。
*/
public interface ImportBeanDefinitionRegistrar {
/**
* 根據註解的給定註釋元數據,根據需要註冊bean定義
* @param importingClassMetadata 可以拿到@Import的這個class的Annotation Metadata
* @param registry BeanDefinitionRegistry 就可以拿到目前所有註冊的BeanDefinition,然後可以對這些BeanDefinition進行額外的修改或增強。
*/
void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry);
}
關於@Import引入ImportBeanDefinitionRegistrar的使用強烈建議大家去看看mybatis關於@MapperScan的處理源碼。特別有意思。我們也舉一個非常簡單的實例,來讓大家直觀的看到ImportBeanDefinitionRegistrar的使用,比如我們想把指定包路徑下所有添加了BeanIoc註解的類註冊爲bean。具體實現如下:
/**
* 我們會把添加了該註解的類作爲bean
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface BeanIoc {
}
/**
* 定義包路徑。(指定包下所有添加了BeanIoc註解的類作爲bean)
* 注意這裏 @Import(BeanIocScannerRegister.class) 的使用
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(BeanIocScannerRegister.class)
public @interface BeanIocScan {
String[] basePackages() default "";
}
/**
* 搜索指定包下所有添加了BeanIoc註解的類,並且把這些類添加到ioc容器裏面去
*/
public class BeanIocScannerRegister implements ImportBeanDefinitionRegistrar, ResourceLoaderAware {
private final static String PACKAGE_NAME_KEY = "basePackages";
private ResourceLoader resourceLoader;
@Override
public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {
//1. 從BeanIocScan註解獲取到我們要搜索的包路徑
AnnotationAttributes annoAttrs = AnnotationAttributes.fromMap(annotationMetadata.getAnnotationAttributes(BeanIocScan.class.getName()));
if (annoAttrs == null || annoAttrs.isEmpty()) {
return;
}
String[] basePackages = (String[]) annoAttrs.get(PACKAGE_NAME_KEY);
// 2. 找到指定包路徑下所有添加了BeanIoc註解的類,並且把這些類添加到IOC容器裏面去
ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(beanDefinitionRegistry, false);
scanner.setResourceLoader(resourceLoader);
scanner.addIncludeFilter(new AnnotationTypeFilter(BeanIoc.class));
scanner.scan(basePackages);
}
@Override
public void setResourceLoader(ResourceLoader resourceLoader) {
this.resourceLoader = resourceLoader;
}
}
/**
* 使用,使BeanIocScan生效
*/
@Configuration
@BeanIocScan(basePackages = "com.tuacy.collect.mybatis")
public class BeanIocScanConfig {
}