自从SpringBoot诞生以来,在微服务架构兴起的基础上,以"开箱即用"的特性与简化配置的功能在Java业界快速流行。我整理了一下它自动装配的特性,分享给大家。
一,什么是Starter?
其实官方的描述比较简洁,举了一个例子就是把它的POM依赖引入项目。并且说明了可以自定义第三方的Starter,命名方式为thirdparty-spring-boot-starter。那么Starter究竟是什么呢?我觉得简单一点来讲,就是一些功能模块的集合,而官方把一些经常使用的功能做成44个Starter提供给开发者使用。例如你要进行一个WEB项目开发,你只需要引入spring-boot-starter-web依赖即可开始开发,而不再需要像传统的WEB项目那样去进行繁琐的配置。再举个例子:我们每次开发WEB项目做的配置其实都是大同小异的,而Sarter就类似于把每次要做的这些事情封装成一个方法,你每次使用相关的功能只需要直接去调用它。
二,自动装配是如何实现的?
首先我们知道一个点,springboot的自动装配是基于spring4的手动装配实现的。它的实现是依靠注解的自动扫描与条件激活。它拥有一个核心注解@SpringBootApplication,而通过官方文档的描述我们可以得知,它其实是由以下三个注解构成:
@SpringBootConfiguration
1.进去我们可以发现它其实是一个@Configuration,而这个注解的功能就是将加了该注解的类变成一个配置类。
2.@Configuration再点进去我们就看到了一个熟悉的注解:@Component。这个注解就是把Bean交给Spring容器管理。
这两个注解都是来自SpringFramework。
@EnableAutoConfiguration
从这个注解的名字我们可以猜测一二,假设你是SpringBoot的开发人员,你会如何来设计它的自动装配呢?将所有可能用到的类都准备好,然后在使用某个Starter时候,根据类的加载提供一些条件,将它们互相依赖的Bean都给你创建出来交给Spring容器。进入这个注解发现是由两个注解构成:
1.@AutoConfigurationPackage
这个注解是将一些指定包中类与其子包以及类加入容器。
2.@Import({AutoConfigurationImportSelector.class})
进入@Import,你会发现有一个Class<?>[] value();它就是用来接收这些自动加载的类。那么这些类又是如何加载进来的呢?我们可以看这个类AutoConfigurationImportSelector.class。根据见名知意的命名规则,可以得出它就是实现这个功能的关键。进入这个类找到这个方法:
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return NO_IMPORTS;
} else {
AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
}
前面讲到以前要用到的类准备好,那么如何去准备呢?用配置文件以K-V的方式去配置好。我们接下来需要进入getAutoConfigurationEntry方法:
protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
} else {
AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
configurations = this.removeDuplicates(configurations);
Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
this.checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = this.filter(configurations, autoConfigurationMetadata);
this.fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
}
}
在这个方法里我们发现有一个方法:List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);还是见名知意,进去这个方法:
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.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;
}
从这里我们可以看到它使用了SpringFactoriesLoader来进行加载,而且返回的是一个配置类的List集合。进去SpringFactoriesLoader:
public final class SpringFactoriesLoader {
public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";
private static final Log logger = LogFactory.getLog(SpringFactoriesLoader.class);
private static final Map<ClassLoader, MultiValueMap<String, String>> cache = new ConcurrentReferenceHashMap();
赫然发现它在这里定义了一个常量:FACTORIES_RESOURCE_LOCATION,给出了一个路径。这个路径位于哪里呢?
进去这个配置文件,我们可以看到许多K-V的格式配置:
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
命名都是XXXAutoConfiguration。随便进去一个,可以看到它在这里会根据一些条件返回类的实例,例如EmbeddedWebServerFactoryCustomizerAutoConfiguration下就返回了WebServer的工厂实例。到这里,我们已经了解Starter是如何去进行自动加载了,后面会结合内置容器来说明。
@ComponentScan
这个注解在我们传统配置SSM框架时使用过,用来扫描指定包下的类。只不过在这里是使用注解方式,同时它也是属于SpringFramework的注解,我们可以在SpringFramework的文档找到它。它主要是配合@EnableAutoConfiguration注解来进行自动装载。
注解总结
以上就是SpringBoot核心注解的介绍与实现,接下来通过它的内置容器实现来梳理自动装载的实现。
内置容器自动装载实现
在这里我们以Tomcat容器为例,Tomcat容器我们在学习的时候知道它是以Java语言编写的,既然是Java语言.那么它自然是一个Bean,是Bean自然可以交给Spring容器管理。这里我们进入run方法:SpringApplication.run(DemoApplication.class, args); 通过刚才的论断,我们自然要去找关于容器的代码,这时可以找到下面几个方法:
this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);
this.refreshContext(context);
this.afterRefresh(context, applicationArguments);
在这里可以看到对容器进行了准备,刷新,刷新后的操作。那么在哪个步骤会将Tomcat加入容器呢?只有refreshContext有较大可能。那么就进去这个方法:this.refreshContext(context)-->this.refresh(context)-->((AbstractApplicationContext)applicationContext).refresh()-->this.onRefresh()。到了this.onRefresh()我们会发现没有具体实现,那么我们可以去看它的实现类:
根据名字我们可以知道是ServletWebServerApplicationContext这个类实现了把WebServer放入Spring容器,找到它的onRefresh方法实现:
protected void onRefresh() {
super.onRefresh();
try {
this.createWebServer();
} catch (Throwable var2) {
throw new ApplicationContextException("Unable to start web server", var2);
}
}
在这里我们看到了它对WebServer的创建:this.createWebServer();进去之后我们班会发现它是通过web容器工厂来获取这样一个容器。进去factory.getWebServer方法,发现是一个接口类,查看这个类的实现类:
我们可以看到它分别有三个实现类:Jetty,Tomcat,Undertow;它们分别通过工厂模式实现了这个三个容器的实例。而这个工厂实例的获得,在前面的EmbeddedWebServerFactoryCustomizerAutoConfiguration自动配置类我们可以看到它对这几个工厂类实例的提供。
总结
通过上面的源码我们可以了解它对自动装载的源码实现,SpringBoot的自动装载是建立在SpringFramework的基础上来实现的。虽然不像官方描述的那么绝对,但是也相差无几。使用它来构建基于Spring的项目非常的方便快捷,不再需要像往常那样去进行繁琐的配置,从而把精力专注于业务开发,所以这也是它大行其道,企业招聘的硬性指标的原因。自动装载只是它的特征之一,包括它提供的自定义Starter也是非常的强大,所以SpringBoot会有易学难精的这个说法。