SpringBoot学习之包扫描

Dear 丶 2022-12-13 04:58 132阅读 0赞

带着这样一个问题出发，为什么需要将文件放在启动类所在包及子包才能被springboot自动扫描并注册bean？

## 一、推测 ##

springboot会扫描启动类所在包及子包的所有文件，并将其注册bean到容器中，应该是启动时自动扫描，具体实现需要看源码。

## 二、分析源码 ##

### 1、分析主启动类 ###

package com.zrk.springboot;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class SpringbootApplication {
        public static void main(String[] args) {
            SpringApplication.run(SpringbootApplication.class, args);
        }
    }

分析可得，当前主启动类所在包为**package com.zrk.springboot**；  
有一个注解 **@SpringBootApplication**

### 2、分析@SpringBootApplication注解 ###

@Target(ElementType.TYPE) //注解的适用范围，其中TYPE用于描述类、接口（包括包注解类型）或enum声明
    @Retention(RetentionPolicy.RUNTIME) //注解的生命周期
    @Documented //表明这个注解应该被javadoc记录
    @Inherited //子类可以继承该注解
    @SpringBootConfiguration //表明当前类是注解类
    @EnableAutoConfiguration //开启自动配置
    @ComponentScan(excludeFilters = { //扫描路径设置
    		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
    		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
    public @interface SpringBootApplication {
    ...

@SpringBootApplication是一个组合注解，重要的是@SpringBootConfiguration、@EnableAutoConfiguration、@EnableAutoConfiguration这三个注解，现在具体分析 **@EnableAutoConfiguration**注解

### 3、分析@EnableAutoConfiguration注解 ###

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

也是个组合注解，看各个注解名字知道 **@AutoConfigurationPackage**注解符合此次话题

### 4、分析@AutoConfigurationPackage注解 ###

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

主要通过@Import注解引入了AutoConfigurationPackages.Registrar.class

### 5、分析AutoConfigurationPackages.Registrar类 ###

static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
    		@Override
    		public void registerBeanDefinitions(AnnotationMetadata metadata,
    				BeanDefinitionRegistry registry) {
    			register(registry, new PackageImport(metadata).getPackageName());
    		}
    ...

可看出调了register(registry, new PackageImport(metadata).getPackageName());方法

### 6、分析register方法 ###

public static void register(BeanDefinitionRegistry registry, String... packageNames) {
    		if (registry.containsBeanDefinition(BEAN)) {
    			BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN);
    			ConstructorArgumentValues constructorArguments = beanDefinition
    					.getConstructorArgumentValues();
    			constructorArguments.addIndexedArgumentValue(0,
    					addBasePackages(constructorArguments, packageNames));
    		}
    		else {
    			GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
    			beanDefinition.setBeanClass(BasePackages.class);
    			beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0,
    					packageNames);
    			beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
    			registry.registerBeanDefinition(BEAN, beanDefinition);
    		}
    	}

分析参数传了BeanDefinitionRegistry 变量，和一堆包名组成字符串；最后一行调用registry.registerBeanDefinition(BEAN, beanDefinition)就是将包名下所有文件扫描并将其下文件分析并注册bean,这样就是大体流程，接下来调试源码验证一下。

### 三、调试源码 ###

在关键处打断点，并用debug模式启动主方法类SpringbootApplication

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIxMDY3MzA3_size_16_color_FFFFFF_t_70]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIxMDY3MzA3_size_16_color_FFFFFF_t_70 1]

此时 \*\*new PackageImport(metadata).getPackageName()\*\*执行返回的值正好是主启动类所在的包名com.zrk.springboot,进入register方法

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIxMDY3MzA3_size_16_color_FFFFFF_t_70 2][]

证明了上述的分析

## 四、总结 ##

springboot会按照上述流程扫描加有@SpringBootApplication注解的主启动类所在包以及子包，并将有相应注解的类注册bean到容器中，这样只要遵循这个原则，就可以自动注册对应的bean到容器中，不用像之前一样手动配置扫描或者手动配置xml等繁琐步骤，还是特别方便的设计，比较喜欢。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIxMDY3MzA3_size_16_color_FFFFFF_t_70]: /images/20221123/b439bd05718742fb8decf2df74840271.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIxMDY3MzA3_size_16_color_FFFFFF_t_70 1]: /images/20221123/80d05fc0641a41ba90fd10ecd1f1e85d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzIxMDY3MzA3_size_16_color_FFFFFF_t_70 2]: /images/20221123/2b3919a4dc3544b4ad1c34588966d424.png