約定優(yōu)于配置

SpringBoot的預(yù)定優(yōu)于配置主要體現(xiàn)在以下幾個(gè)方面：

maven的目錄結(jié)構(gòu)：

• 配置文件默認(rèn)存放在resources目錄下
• 項(xiàng)目編譯后的文件存放在target目錄下
• 項(xiàng)目默認(rèn)打包成jar格式

配置文件默認(rèn)為application.yml或application.yaml或application.properties

默認(rèn)通過(guò) spring.profiles.active 屬性來(lái)決定運(yùn)行環(huán)境時(shí)的配置文件。

自動(dòng)裝配

相對(duì)于傳統(tǒng)的Spring項(xiàng)目的繁瑣配置，SpringBoot項(xiàng)目只需要使用一個(gè)@SpringBootApplication注解就可以成功運(yùn)行，哪有什么歲月靜好，只不過(guò)是有人在替我們負(fù)重前行。讓我們來(lái)看一看在@SpringBootApplication注解的背后SpringBoot為我們做了哪些事情。

可以看到@SpringBootApplication是一個(gè)組合注解，上面四個(gè)不用看，因?yàn)槭嵌x一個(gè)注解必須的，關(guān)鍵在于下面的@SpringBootConfiguration``@EnableAutoConfiguration``@ComponentScan三個(gè)注解。也就是說(shuō)我們不用@SpringBootApplication，使用下這三個(gè)注解也可以成功運(yùn)行一個(gè)SpringBoot應(yīng)用。

@SpringBootConfiguration注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

點(diǎn)進(jìn)源碼可以發(fā)現(xiàn)，它實(shí)際上就是一個(gè)@Configuration注解，@Configuration大家應(yīng)該都很熟悉了，加上這個(gè)注解后當(dāng)前類就會(huì)被Spring所管理 。

@ComponentScan注解

這個(gè)注解用于定義Spring的掃描路徑，等價(jià)于<context:component-scan>，如果沒(méi)有配置掃描路徑，那么SpringBoot會(huì)默認(rèn)掃描當(dāng)前類的包及其子包中所有標(biāo)注了需要被管理的類。

@EnableAutoConfiguration

這個(gè)注解才是SpringBoot自動(dòng)裝配的關(guān)鍵，這也是一個(gè)組合注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
	Class<?>[] exclude() default {};
	String[] excludeName() default {};
}

@AutoConfigurationPackage其實(shí)也是一個(gè)@Import注解

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

@Import注解

在@Configuration標(biāo)注的Class上可以使用@Import引入其它的配置類，其實(shí)它還可以引入org.springframework.context.annotation.ImportSelector實(shí)現(xiàn)類。ImportSelector接口只定義了一個(gè)selectImports()，用于指定需要注冊(cè)為bean的Class名稱。當(dāng)在@Configuration標(biāo)注的Class上使用@Import引入了一個(gè)ImportSelector實(shí)現(xiàn)類后，會(huì)把實(shí)現(xiàn)類中返回的Class名稱都定義為bean。

@EnableAutoConfiguration中@Import主要就是為了導(dǎo)入一個(gè)AutoConfigurationImportSelector，下面我們分析一下這個(gè)類：

AutoConfigurationImportSelector類

AutoConfigurationImportSelect類實(shí)現(xiàn)了ImportSelector接口，所以我們清楚只需關(guān)注selectImports()方法的返回結(jié)果即可：

	@Override
	public String[] selectImports(AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return NO_IMPORTS;
		}
		AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
				.loadMetadata(this.beanClassLoader);
		AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
				annotationMetadata);
		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
	}

該方法返回的是要注冊(cè)到IOC容器中的對(duì)象的類型的全路徑名稱的字符串?dāng)?shù)組，所以我們要分析一下這個(gè)數(shù)組是從哪里來(lái)的？

進(jìn)入到getAutoConfigurationEntry方法中：

	protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
			AnnotationMetadata annotationMetadata) {
		if (!isEnabled(annotationMetadata)) {
			return EMPTY_ENTRY;
		}
        // 獲取注解的屬性信息
		AnnotationAttributes attributes = getAttributes(annotationMetadata);
        // 獲取候選配置
		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
		configurations = removeDuplicates(configurations);
		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
		checkExcludedClasses(configurations, exclusions);
		configurations.removeAll(exclusions);
		configurations = filter(configurations, autoConfigurationMetadata);
		fireAutoConfigurationImportEvents(configurations, exclusions);
		return new AutoConfigurationEntry(configurations, exclusions);
	}

通過(guò)DEBUG可以看到，在getCandidateConfigurations方法中獲取到了很多java類全路徑

進(jìn)入getCandidateConfigurations方法，可以看到有一個(gè)斷言：如果configurations為空的話，會(huì)提示No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct(在META-INF/spring.factories中找不到自動(dòng)配置類。如果您使用的是自定義打包，請(qǐng)確保該文件正確無(wú)誤)

由此我們可以推測(cè)：自動(dòng)配置的類名數(shù)組在META-INF/spring.factories文件中，并且我們可以通過(guò)在正確的路徑下面添加這個(gè)文件來(lái)自定義包來(lái)適配SpringBoot

	protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
		List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
				getBeanClassLoader());
		Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
				+ "are using a custom packaging, make sure that file is correct.");
		return configurations;
	}

進(jìn)入這個(gè)文件可以看到，這里配置了大量的需要自動(dòng)裝配的類，當(dāng)我們啟動(dòng)Springboot項(xiàng)目的時(shí)候，SpringBoot會(huì)掃描所有jar包下面的META-INF/spring.factories文件，并根據(jù)key進(jìn)行讀取，在經(jīng)過(guò)一系列的操作來(lái)完成自動(dòng)裝配。

需要注意的是：上圖中的 spring.factories 文件是在 spring-boot-autoconfigure 包下面，這個(gè)包記錄了官方提供的 stater 中幾乎所有需要的自動(dòng)裝配類，所以并不是每一個(gè)官方的 starter 下都會(huì)有 spring.factories 文件。

@AutoConfigurationPackage注解

@AutoConfigurationPackage注解的主要作用就是將主程序類所在包及所有子包下的組件到掃描到spring容器中。

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

這個(gè)注解實(shí)際上是導(dǎo)入了AutoConfigurationPackages的一個(gè)內(nèi)部類Registrar，這個(gè)類的作用就是讀取到最外層@SpringBootApplication注解中配置的掃描路徑（沒(méi)有配置默認(rèn)當(dāng)前所在包），將該路徑下所有文件掃描，并分析注冊(cè)bean。

	static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
		@Override
		public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
			register(registry, new PackageImport(metadata).getPackageName());
		}
		@Override
		public Set<Object> determineImports(AnnotationMetadata metadata) {
			return Collections.singleton(new PackageImport(metadata));
		}
	}

手寫一個(gè)starter組件

上面提到在自己的包中添加META-INF/spring.factories文件就可以適配SpringBoot實(shí)現(xiàn)自動(dòng)配置，這其實(shí)是一種SPI的思想。

SPI，Service Provider Interface。即：接口服務(wù)的提供者。就是說(shuō)我們應(yīng)該面向接口（抽象）編程，而不是面向具體的實(shí)現(xiàn)來(lái)編程，這樣一旦我們需要切換到當(dāng)前接口的其他實(shí)現(xiàn)就無(wú)需修改代碼。

starter的命名規(guī)范:

官方的starter命名格式為spring-boot-starter-{xxx}，例如：spring-boot-starter-web等

自定義starter命名格式一般為{xxx}-spring-boot-starter，例如mybatis的mybatis-spring-boot-starter

\1) 新建一個(gè)springboot項(xiàng)目myself-spring-boot-starter

\2) 新建自己的業(yè)務(wù)類

public class MyselfService {
    private String myself;
    // ……省略 getter setter
    public String doBusiness(Object obj){
        return myself+obj.toString();
    }
}

3）業(yè)務(wù)需要的一些屬性值

@ConfigurationProperties("myself")
public class MysefProperties {
    private String myself;
    // ……省略 getter setter
}

4）新建自動(dòng)裝配類，把自己的業(yè)務(wù)交給Spring管理

@Configuration
@EnableConfigurationProperties(MysefProperties.class)
public class MyselfAutoConfiguration {
    @Autowired
    MysefProperties mysefProperties;
    @Bean
    @ConditionalOnMissingBean(MyselfService.class)
    public MyselfService myselfService(){
        MyselfService myselfService = new MyselfService();
        myselfService.setMyself(mysefProperties.getMyself());
        return myselfService;
    }
}

5）在resources/META-INF下新建spring.factories，配置starter中配置類的位置

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.yy.autoconfigure.MyselfAutoConfiguration

6）mvn install將自己的包打到自己倉(cāng)庫(kù)中，在另外的項(xiàng)目直接引用即可

7）測(cè)試

mybatis-plus-boot-starter

我們可以學(xué)習(xí)一下其他第三方的成熟的starter，會(huì)發(fā)現(xiàn)其實(shí)套路是很相似的

到此這篇關(guān)于SpringBoot詳細(xì)分析自動(dòng)裝配原理并實(shí)現(xiàn)starter的文章就介紹到這了,更多相關(guān)SpringBoot自動(dòng)裝配原理內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論