快捷導(dǎo)航

Spring注解之@Import的簡(jiǎn)單介紹

更新時(shí)間：2022年12月23日 08:07:49 作者：blue星空

@Import是Spring基于Java注解配置的主要組成部分,下面這篇文章主要給大家介紹了關(guān)于Spring注解之@Import的簡(jiǎn)單介紹,文中通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考下

普通類

被導(dǎo)入的類會(huì)被容器注冊(cè)成一個(gè)Bean，可以被依賴注入使用。【4.2 版本之前只可以導(dǎo)入配置類；4.2版本之后也可以導(dǎo)入普通類，導(dǎo)入的類會(huì)被當(dāng)作配置類】

@Import注冊(cè)一個(gè)類時(shí)，這個(gè)配置類不應(yīng)該被@Component或者@Configuration注解標(biāo)記。Spring中會(huì)將所有的bean class封裝成一個(gè)ConfigurationClass，并且此后會(huì)判斷被封裝的bean class是否是由其他類導(dǎo)入的.

@Configuration
<strong>@Import(OtherBean.</strong><strong>class)
</strong>public class SpringConfig { }

public class OtherBean { }

ImportSelector實(shí)現(xiàn)類

實(shí)現(xiàn)類不會(huì)被注冊(cè)成Bean，接口方法的返回值會(huì)被注冊(cè)成Bean?！綛eanName是全類名】

@Configuration
<strong>@Import(MyImportSelector.</strong><strong>class)
</strong>public class SpringConfig { }

public class MyImportSelector implements<strong> ImportSelector</strong> {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{OtherBean.class.getName()};
    }
}

DeferredImportSelector實(shí)現(xiàn)類

DeferredImportSelector是ImportSelector的子接口, 所以它們的實(shí)現(xiàn)方式一樣，只是Spring的處理方式不同。DeferredImportSelector和SpringBoot中自動(dòng)導(dǎo)入配置文件的延遲導(dǎo)入有關(guān)。

@Configuration
<strong>@Import(MyDeferredImportSelector.</strong><strong>class)
</strong>public class SpringConfig { }

public class MyDeferredImportSelector implements<strong> DeferredImportSelector</strong> {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{OtherBean.class.getName()};
    }
}

ImportBeanDefinitionRegistrar實(shí)現(xiàn)類

實(shí)現(xiàn)類不會(huì)被注冊(cè)為bean，但是會(huì)回調(diào)其接口方法，由開發(fā)者通過Spring api手動(dòng)向Spring容器注冊(cè)bean?！绢愃朴贐eanFactoryPostRegister】

@Configuration
<strong>@Import(MyImportBeanDefinitionRegistrar.</strong><strong>class)
</strong>public class SpringConfig { }

public class MyImportBeanDefinitionRegistrar implements<strong> ImportBeanDefinitionRegistrar</strong> {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
        BeanDefinition beanDefinition = new RootBeanDefinition();
        String beanName = StringUtils.uncapitalize(OtherBean.class.getSimpleName());
        beanDefinition.setBeanClassName(OtherBean.class.getName());
        registry.registerBeanDefinition(beanName,beanDefinition);
    }
}

附：@Import相關(guān)源碼解析

加載解析@Import注解位于BeanFactoryPostProcessor處理的時(shí)候：

AbstractApplicationContext的refresh方法

-> invokeBeanFactoryPostProcessors(beanFactory);

-> PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());

-> registryProcessor.postProcessBeanDefinitionRegistry(registry);

這里的registryProcessor,我們指ConfigurationClassPostProcessor

ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry(registry)

-> processConfigBeanDefinitions(registry):

public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
    //省略一些配置檢查與設(shè)置的邏輯

    //根據(jù)@Order注解，排序所有的@Configuration類
    configCandidates.sort((bd1, bd2) -> {
			int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition());
			int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition());
			return Integer.compare(i1, i2);
		});

	// 創(chuàng)建ConfigurationClassParser解析@Configuration類
	ConfigurationClassParser parser = new ConfigurationClassParser(
			this.metadataReaderFactory, this.problemReporter, this.environment,
			this.resourceLoader, this.componentScanBeanNameGenerator, registry);

    //剩余沒有解析的@Configuration類
	Set<BeanDefinitionHolder> candidates = new LinkedHashSet<>(configCandidates);
	//已經(jīng)解析的@Configuration類
	Set<ConfigurationClass> alreadyParsed = new HashSet<>(configCandidates.size());
	do {
	    //解析
		parser.parse(candidates);
		parser.validate();

		Set<ConfigurationClass> configClasses = new LinkedHashSet<>(parser.getConfigurationClasses());
		configClasses.removeAll(alreadyParsed);

		// 生成類定義讀取器讀取類定義
		if (this.reader == null) {
			this.reader = new ConfigurationClassBeanDefinitionReader(
					registry, this.sourceExtractor, this.resourceLoader, this.environment,
					this.importBeanNameGenerator, parser.getImportRegistry());
		}
		this.reader.loadBeanDefinitions(configClasses);
		alreadyParsed.addAll(configClasses);

		candidates.clear();
		if (registry.getBeanDefinitionCount() > candidateNames.length) {
			//省略檢查是否有其他需要加載的配置的邏輯
		}
	}
	while (!candidates.isEmpty());

	//省略后續(xù)清理邏輯
}

其中parser.parse(candidates)的邏輯主要由org.springframework.context.annotation.ConfigurationClassParser實(shí)現(xiàn)，功能是加載@Import注解還有即系@Import注解。reader.loadBeanDefinitions(configClasses);的邏輯主要由org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader的loadBeanDefinitionsForConfigurationClass方法實(shí)現(xiàn)，功能是將上面解析的配置轉(zhuǎn)換為BeanDefinition就是Bean定義。