使用@import导入实现了ImportBeanDefinitionRegistrar接口的类，不能被注册为bean

今天在调试公司spring项目的时候发现了这样一个问题，由于我们的项目使用的是springboot就以springboot为例，代码如下：

 

@Import({DataSourceRegister.class,A.class})
@SpringBootApplication
@ComponentScan("com.viewhigh.bi")
//@EnableCaching
public class BiApplication {
    public static void main(String[] args) {
        LogUtil.setEnabled(true);//开启日志输出

        SpringApplication sa = new SpringApplication(BiApplication.class);
        sa.setBannerMode(Banner.Mode.LOG);
        sa.run(args);
    }
}

 

在springboot启动的时候，loder模块会根据“清单文件”加载该BIApplication类，并反射调用psvm入口函数main，但是一个很有意思的问题出现了，项目正常运行之后，在springcontext中可以找到Bean类A，但是无法找到DataSourceRegister这个类；

我们知道在spring4.2以后@Import注解也可以导入一个常规类，并将其注册为bean，那么为什么DataSourceRegister没有被注册为Bean呢？

 

DataSourceRegister类是用来进行初始化数据源和并提供了执行动态切换数据源的工具类

public class DataSourceRegister<T> implements EnvironmentAware, ImportBeanDefinitionRegistrar {
    private javax.sql.DataSource defaultTargetDataSource;
    static final String MAINDATASOURCE = "mainDataSource";
public final void setEnvironment(Environment environment) {

DruidEntity druidEntity = FileUtil.readYmlByClassPath("db_info", DruidEntity.class);
defaultTargetDataSource = DataSourceUtil.createMainDataSource(druidEntity);

}
public final void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {

// 0.将主数据源添加到数据源集合中

        DataSourceSet.putTargetDataSourcesMap(MAINDATASOURCE, defaultTargetDataSource);

//1.创建DataSourceBean

GenericBeanDefinition beanDefinition = new GenericBeanDefinition();

beanDefinition.setBeanClass(DataSource.class);

beanDefinition.setSynthetic(true);

MutablePropertyValues mpv = beanDefinition.getPropertyValues();

//spring名称约定为defaultTargetDataSource和targetDataSources

mpv.addPropertyValue("defaultTargetDataSource", defaultTargetDataSource);

mpv.addPropertyValue("targetDataSources", DataSourceSet.getTargetDataSourcesMap());

beanDefinitionRegistry.registerBeanDefinition("dataSource", beanDefinition);

}

}

 看到代码后相信大家已经明白了，这个动态数据注册类实现了ImportBeanDefinitionRegistrar 接口，没错就是这个原因，由于实现了该接口让该类成为了拥有注册bean的能力。从原理上也能说得通作为一个Bean的注册类是没有必要和A类一样都被注册为Bean的！

 虽然这样解释也不为过但我仍然想一探究竟，本来想大概找找spring涉及关键类如：ConfigurationClass，ConfigurationClassParser等，可能由于不熟悉看到类中的代码就呵呵了，似乎无从下手！

 所以准备调试下spring启动部分的代码 ，这样会更清晰些！（以spring boot V1.5.6为例）

 ======

 spring boot启动时使用了SpringApplication类的run方法来牵引整个spring的初始化过程！！！

 没错了就是从run开始吧！

 代码如下：

 

public ConfigurableApplicationContext run(String... args) {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        ConfigurableApplicationContext context = null;
        FailureAnalyzers analyzers = null;
        this.configureHeadlessProperty();
        SpringApplicationRunListeners listeners = this.getRunListeners(args);
        listeners.starting();
try {

ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);

ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments);

Banner printedBanner = this.printBanner(environment);

context = this.createApplicationContext();

new FailureAnalyzers(context);

this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);

this.refreshContext(context);

this.afterRefresh(context, applicationArguments);

listeners.finished(context, (Throwable)null);

stopWatch.stop();

if(this.logStartupInfo) {

(new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);

}
return context;

} catch (Throwable var9) {

this.handleRunFailure(context, listeners, (FailureAnalyzers)analyzers, var9);

throw new IllegalStateException(var9);

}

}

手一懒，就把整个方法直接copy了。这就是springboot在启动时的完整足迹。。。闲话少说我们直击关键点；

context = this.createApplicationContext();
this.refreshContext(context);

这两段是最关键的地方，阅读过一些spring书籍的兄弟都知道refreshContext就是在做spring运行后的初始化工作。那么在createApplicationContext当中，由于我们是web项目，则spring默认给我们创建了一个AnnotationConfigEmbeddedWebApplicationContext

当然它也是继承GenericWebApplicationContext类和GenericApplicationContext类的，那么他默认会持有一个DefaultListableBeanFactory对象，这个对象可以用来创建Bean，吼吼，这个块说的似乎没有意义哈！！！

接着往下走，进入refreshContext中会调用一系列的refresh方法，最终进入AbstractApplicationContext中：

@Override
    public void refresh() throws BeansException, IllegalStateException {
        synchronized (this.startupShutdownMonitor) {
            // Prepare this context for refreshing.
            prepareRefresh();
// Tell the subclass to refresh the internal bean factory.

ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.

            prepareBeanFactory(beanFactory);
try {

// Allows post-processing of the bean factory in context subclasses.

                postProcessBeanFactory(beanFactory);
// Invoke factory processors registered as beans in the context.

                invokeBeanFactoryPostProcessors(beanFactory);
// Register bean processors that intercept bean creation.

                registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.

                initMessageSource();
// Initialize event multicaster for this context.

                initApplicationEventMulticaster();
// Initialize other special beans in specific context subclasses.

                onRefresh();
// Check for listener beans and register them.

                registerListeners();
// Instantiate all remaining (non-lazy-init) singletons.

                finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.

                finishRefresh();

}
catch (BeansException ex) {

if (logger.isWarnEnabled()) {

logger.warn("Exception encountered during context initialization - " +

"cancelling refresh attempt: " + ex);

}
// Destroy already created singletons to avoid dangling resources.

                destroyBeans();
// Reset 'active' flag.

                cancelRefresh(ex);
// Propagate exception to caller.

throw ex;

}
finally {

// Reset common introspection caches in Spring's core, since we

// might not ever need metadata for singleton beans anymore...

                resetCommonCaches();

}

}

}

 invokeBeanFactoryPostProcessors()方法就是Bean在注册前期做的一系列数据收集工作！

 跟着堆栈继续深入，会进入到这个方法中，这个方法就是初始化bean前的所有轨迹：

在invokeBeanFactoryPostProcessors方法中继续跟进一系列方法就会看到在一开始的时候spring会初始化几个系统固有的Bean：

继续调试后的关键点出现在这个方法中：

public void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
        List<BeanDefinitionHolder> configCandidates = new ArrayList<BeanDefinitionHolder>();
        String[] candidateNames = registry.getBeanDefinitionNames();
for (String beanName : candidateNames) {

BeanDefinition beanDef = registry.getBeanDefinition(beanName);

if (ConfigurationClassUtils.isFullConfigurationClass(beanDef) ||

ConfigurationClassUtils.isLiteConfigurationClass(beanDef)) {

if (logger.isDebugEnabled()) {

logger.debug("Bean definition has already been processed as a configuration class: " + beanDef);

}

}

else if (ConfigurationClassUtils.checkConfigurationClassCandidate(beanDef, this.metadataReaderFactory)) {

configCandidates.add(new BeanDefinitionHolder(beanDef, beanName));

}

}
// Return immediately if no @Configuration classes were found

if (configCandidates.isEmpty()) {

return;

}
// Sort by previously determined @Order value, if applicable

Collections.sort(configCandidates, new Comparator<BeanDefinitionHolder>() {

@Override

public int compare(BeanDefinitionHolder bd1, BeanDefinitionHolder bd2) {

int i1 = ConfigurationClassUtils.getOrder(bd1.getBeanDefinition());

int i2 = ConfigurationClassUtils.getOrder(bd2.getBeanDefinition());

return (i1 < i2) ? -1 : (i1 > i2) ? 1 : 0;

}

});
// Detect any custom bean name generation strategy supplied through the enclosing application context

SingletonBeanRegistry sbr = null;

if (registry instanceof SingletonBeanRegistry) {

sbr = (SingletonBeanRegistry) registry;

if (!this.localBeanNameGeneratorSet && sbr.containsSingleton(CONFIGURATION_BEAN_NAME_GENERATOR)) {

BeanNameGenerator generator = (BeanNameGenerator) sbr.getSingleton(CONFIGURATION_BEAN_NAME_GENERATOR);

this.componentScanBeanNameGenerator = generator;

this.importBeanNameGenerator = generator;

}

}
// Parse each @Configuration class

ConfigurationClassParser parser = new ConfigurationClassParser(

this.metadataReaderFactory, this.problemReporter, this.environment,

this.resourceLoader, this.componentScanBeanNameGenerator, registry);
Set<BeanDefinitionHolder> candidates = new LinkedHashSet<BeanDefinitionHolder>(configCandidates);

Set<ConfigurationClass> alreadyParsed = new HashSet<ConfigurationClass>(configCandidates.size());

do {

parser.parse(candidates);

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

configClasses.removeAll(alreadyParsed);
// Read the model and create bean definitions based on its content

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) {

String[] newCandidateNames = registry.getBeanDefinitionNames();

Set<String> oldCandidateNames = new HashSet<String>(Arrays.asList(candidateNames));

Set<String> alreadyParsedClasses = new HashSet<String>();

for (ConfigurationClass configurationClass : alreadyParsed) {

alreadyParsedClasses.add(configurationClass.getMetadata().getClassName());

}

for (String candidateName : newCandidateNames) {

if (!oldCandidateNames.contains(candidateName)) {

BeanDefinition bd = registry.getBeanDefinition(candidateName);

if (ConfigurationClassUtils.checkConfigurationClassCandidate(bd, this.metadataReaderFactory) &&

!alreadyParsedClasses.contains(bd.getBeanClassName())) {

candidates.add(new BeanDefinitionHolder(bd, candidateName));

}

}

}

candidateNames = newCandidateNames;

}

}

while (!candidates.isEmpty());
// Register the ImportRegistry as a bean in order to support ImportAware @Configuration classes

if (sbr != null) {

if (!sbr.containsSingleton(IMPORT_REGISTRY_BEAN_NAME)) {

sbr.registerSingleton(IMPORT_REGISTRY_BEAN_NAME, parser.getImportRegistry());

}

}
if (this.metadataReaderFactory instanceof CachingMetadataReaderFactory) {

((CachingMetadataReaderFactory) this.metadataReaderFactory).clearCache();

}

}

而通过不断重复调试确定获得注册Bean的列表应该发生在配置的“剖析阶段”，也就是parser.parse(candidates);这个方法的内部，到了这里基本问题的答案已经要浮出水面了，我也不再粘贴无用的代码，如果你真的对这个问题比骄傲好奇可以自己跟踪并练习调试的源码技巧！

当然在ConfigurationClassParser这个类中parse方法也是不少，只要静下心来逐渐分析，马上就能准确的找到Override的parse方法。。。

现在直接贴出最最关键的代码：

protected void processConfigurationClass(ConfigurationClass configClass) throws IOException {
        if (this.conditionEvaluator.shouldSkip(configClass.getMetadata(), ConfigurationPhase.PARSE_CONFIGURATION)) {
            return;
        }
ConfigurationClass existingClass = this.configurationClasses.get(configClass);

if (existingClass != null) {

if (configClass.isImported()) {

if (existingClass.isImported()) {

existingClass.mergeImportedBy(configClass);

}

// Otherwise ignore new imported config class; existing non-imported class overrides it.

return;

}

else {

// Explicit bean definition found, probably replacing an import.

// Let's remove the old one and go with the new one.

this.configurationClasses.remove(configClass);

for (Iterator<ConfigurationClass> it = this.knownSuperclasses.values().iterator(); it.hasNext()😉 {

if (configClass.equals(it.next())) {

it.remove();

}

}

}

}
// Recursively process the configuration class and its superclass hierarchy.

SourceClass sourceClass = asSourceClass(configClass);

do {

 sourceClass = doProcessConfigurationClass(configClass, sourceClass);//处理定义的配置类

}

while (sourceClass != null);
this.configurationClasses.put(configClass, configClass);

}

protected final SourceClass doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass)
            throws IOException {
// Recursively process any member (nested) classes first

        processMemberClasses(configClass, sourceClass);
// Process any @PropertySource annotations

for (AnnotationAttributes propertySource : AnnotationConfigUtils.attributesForRepeatable(

sourceClass.getMetadata(), PropertySources.class,

org.springframework.context.annotation.PropertySource.class)) {

if (this.environment instanceof ConfigurableEnvironment) {

processPropertySource(propertySource);

}

else {

logger.warn("Ignoring @PropertySource annotation on [" + sourceClass.getMetadata().getClassName() +

"]. Reason: Environment must implement ConfigurableEnvironment");

}

}
// Process any @ComponentScan annotations
        Set<AnnotationAttributes> componentScans = AnnotationConfigUtils.attributesForRepeatable(

sourceClass.getMetadata(), ComponentScans.class, ComponentScan.class);

if (!componentScans.isEmpty() &&

!this.conditionEvaluator.shouldSkip(sourceClass.getMetadata(), ConfigurationPhase.REGISTER_BEAN)) {

for (AnnotationAttributes componentScan : componentScans) {

// The config class is annotated with @ComponentScan -> perform the scan immediately

Set<BeanDefinitionHolder> scannedBeanDefinitions =

this.componentScanParser.parse(componentScan, sourceClass.getMetadata().getClassName());

// Check the set of scanned definitions for any further config classes and parse recursively if needed

for (BeanDefinitionHolder holder : scannedBeanDefinitions) {

if (ConfigurationClassUtils.checkConfigurationClassCandidate(

holder.getBeanDefinition(), this.metadataReaderFactory)) {

parse(holder.getBeanDefinition().getBeanClassName(), holder.getBeanName());

}

}

}

}
// Process any @Import annotations

processImports(configClass, sourceClass, getImports(sourceClass), true);//处理注解导入的类型
// Process any @ImportResource annotations

if (sourceClass.getMetadata().isAnnotated(ImportResource.class.getName())) {

AnnotationAttributes importResource =

AnnotationConfigUtils.attributesFor(sourceClass.getMetadata(), ImportResource.class);

String[] resources = importResource.getStringArray("locations");

Class<? extends BeanDefinitionReader> readerClass = importResource.getClass("reader");

for (String resource : resources) {

String resolvedResource = this.environment.resolveRequiredPlaceholders(resource);

configClass.addImportedResource(resolvedResource, readerClass);

}

}
// Process individual @Bean methods

Set<MethodMetadata> beanMethods = retrieveBeanMethodMetadata(sourceClass);

for (MethodMetadata methodMetadata : beanMethods) {

configClass.addBeanMethod(new BeanMethod(methodMetadata, configClass));

}
// Process default methods on interfaces

        processInterfaces(configClass, sourceClass);
// Process superclass, if any

if (sourceClass.getMetadata().hasSuperClass()) {

String superclass = sourceClass.getMetadata().getSuperClassName();

if (!superclass.startsWith("java") && !this.knownSuperclasses.containsKey(superclass)) {

this.knownSuperclasses.put(superclass, configClass);

// Superclass found, return its annotation metadata and recurse

return sourceClass.getSuperClass();

}

}
// No superclass -> processing is complete

return null;

}

 以上两个方法中标红的就是关键点。而且spring的大师们也把注释写的十分明显：”//Process any @Import annotations“，到这里已经彻底豁然开朗！

spring会先去处理scan，将你程序内部的所有要注册的Bean全部获得（自然包括那些configuration），这里统称为ConfigurationClass，scan全部整理完毕后才会去处理@Import注解时导入的类！

我们回到最初的问题 DataSourceRegister和A两个类为什么A成为了Bean但DataSourceRegister却未成为Bean呢？

答案就在processImports方法中，很明显candidate.isAssignable(ImportBeanDefinitionRegistrar.class)时操作为：configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());而普通的类通过processConfigurationClass(candidate.asConfigClass(configClass));方法，最终会被放在ConfigurationClassParser类的成员变量configurationClasses中，最终被初始化为Bean。。。

private void processImports(ConfigurationClass configClass, SourceClass currentSourceClass,
            Collection<SourceClass> importCandidates, boolean checkForCircularImports) throws IOException {
if (importCandidates.isEmpty()) {

return;

}
if (checkForCircularImports && isChainedImportOnStack(configClass)) {

this.problemReporter.error(new CircularImportProblem(configClass, this.importStack));

}

else {

this.importStack.push(configClass);

try {

for (SourceClass candidate : importCandidates) {

if (candidate.isAssignable(ImportSelector.class)) {

// Candidate class is an ImportSelector -> delegate to it to determine imports

Class<?> candidateClass = candidate.loadClass();

ImportSelector selector = BeanUtils.instantiateClass(candidateClass, ImportSelector.class);

ParserStrategyUtils.invokeAwareMethods(

selector, this.environment, this.resourceLoader, this.registry);

if (this.deferredImportSelectors != null && selector instanceof DeferredImportSelector) {

this.deferredImportSelectors.add(

new DeferredImportSelectorHolder(configClass, (DeferredImportSelector) selector));

}

else {

String[] importClassNames = selector.selectImports(currentSourceClass.getMetadata());

Collection<SourceClass> importSourceClasses = asSourceClasses(importClassNames);

processImports(configClass, currentSourceClass, importSourceClasses, false);

}

}

else if (candidate.isAssignable(ImportBeanDefinitionRegistrar.class)) {

// Candidate class is an ImportBeanDefinitionRegistrar ->

// delegate to it to register additional bean definitions

Class<?> candidateClass = candidate.loadClass();

ImportBeanDefinitionRegistrar registrar =

BeanUtils.instantiateClass(candidateClass, ImportBeanDefinitionRegistrar.class);

ParserStrategyUtils.invokeAwareMethods(

registrar, this.environment, this.resourceLoader, this.registry);

configClass.addImportBeanDefinitionRegistrar(registrar, currentSourceClass.getMetadata());

}

else {

// Candidate class not an ImportSelector or ImportBeanDefinitionRegistrar ->

// process it as an @Configuration class

this.importStack.registerImport(

currentSourceClass.getMetadata(), candidate.getMetadata().getClassName());

processConfigurationClass(candidate.asConfigClass(configClass));

}

}

}

catch (BeanDefinitionStoreException ex) {

throw ex;

}

catch (Throwable ex) {

throw new BeanDefinitionStoreException(

"Failed to process import candidates for configuration class [" +

configClass.getMetadata().getClassName() + "]", ex);

}

finally {

this.importStack.pop();

}

}

}

简单了剖析了下spring-context代码，心情还是很不错滴！你明白这个问题了吗？

原文地址：https://www.cnblogs.com/zzq-include/p/8004506.html