@AutoConfigurationPackage自动包规则原理

@AutoConfigurationPackage
AutoConfigurationPackage翻译过来就是自动配置包
路径:

@SpringBootApplication  -> @EnableAutoConfiguration -> @AutoConfigurationPackage
1
AutoConfigurationPackage.java

package org.springframework.boot.autoconfigure;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.context.annotation.Import;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {

    String[] basePackages() default {};

    Class<?>[] basePackageClasses() default {};

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
我们发现@AutoConfigurationPackage其实它是一个@Import。@import是什么?@import就是给容器中导入一个组件，这个组件叫什么呢?叫AutoConfigurationPackages.Registrar的组件，但是这个Registrar作用是什么?

其实@import有更高级的用法，大家可以来参照:

@import高级用法

这里直接说意义是什么:我现在给容器中导的是一个Registrar

Registrar.java

    /**
     * {@link ImportBeanDefinitionRegistrar} to store the base package from the importing
     * configuration.
     */
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
        @Override
        public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
        }

        @Override
        public Set<Object> determineImports(AnnotationMetadata metadata) {
            return Collections.singleton(new PackageImports(metadata));
        }

    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
我们发现它有俩个方法，其实也就是说我们利用Registrar给容器里面批量注册我们的这个组件(register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));),因为@import一个一个导太麻烦了 , 我们可以写一段代码批量注册:我们看到调用register方法

在这批量注册((registry, new PackageImports)；我们批量注册什么呢？我们断点打到register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));

我们Debug一下。

所以我们看到我们的第一个核心@AutoConfigurationPackage它是利用AutoConfigurationPackages.Registrar给容器中导入组件但是这不是导入一个组件，是利用Registrar给容器中导入一系列的组件。那一系列组件？看源码

我们来看registerBeanDefinitions这个方法传了俩个参数:

一个是AnnotationMetadata(相当于我们注解的源信息)我们的注解是谁？注解指的就是@AutoConfigurationPackage这个注解；注解的源信息就代表了我们这个注解标在了哪、它的每一个属性值都是什么。我们打开源信息:

我们这个注解是标在哪的?这个注解就是标在主程序里面的，因为我们这个是合成注解@EnableAutoConfiguration包含它所以@AutoConfigurationPackage也是标注在它(主程序)里面的

所以我们看到注解的源信息里面我们标在哪个类上？introspectedClass={Class@1337}"class com.chentianyu.boot.MianApplication"(主程序)上

然后它在这里干了些什么事？它new了一个PackageImports, 相当于我们的整个包要导入的东西，它把这个元注解(metadata)拿到，有一个getPackageNames,相当于把我们注解源信息(metadata)拿来获取到我们这个包名(getPackageNames),我们怎么看包名(让它来计算一下)?

选择new PackageImports(metadata).getPackageNames()  ->  右键选择"Evaluate Expression"
1
就是com.chentianyu,boot。为什么得到的是包名?因为我们这个AutoConfigurationPackage注解标注在主类上，主类所在的包就是这个com.chentianyu,boot包，先得到了主类的包名然后把这个包名最终封装(toArray(new String[0]))到我们的一个数组里面,然后给我们注册(register())进去,相当于我们这个Registrar就是把某一个包下的所有组件批量注册进容器

@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {}
//利用Registrar给容器中导入一系列组件
//将指定的一个包下的所有组件导入进来。哪个包下?主类所在的包下
1
2
3
4
这就解释了一个事情：为什么我们默认的包路径是主类所在的这个包