1 SpringBoot运作原理

上一章中我们提到主程序类的注解@SpringBootApplication注解,它其实是个组合注解,源码如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
),
@Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
@AliasFor(
annotation = EnableAutoConfiguration.class
)
Class<?>[] exclude() default {};

@AliasFor(
annotation = EnableAutoConfiguration.class
)
String[] excludeName() default {};

@AliasFor(
annotation = ComponentScan.class,
attribute = "basePackages"
)
String[] scanBasePackages() default {};

@AliasFor(
annotation = ComponentScan.class,
attribute = "basePackageClasses"
)
Class<?>[] scanBasePackageClasses() default {};
}

​ 最主要的还是三个配置@SpringBootConfiguration、@EnableAutoConfigration、@ComponentScan三个注解,下面我们来一一分析。

1.1 @SpringBootConfiguration

查看@SpringBootConfiguration源码,其实它也就是@Configuration注解:

1
2
3
4
5
6
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

​ 对于@Configuration,我们并不陌生,它就是JavaConfig形式的SpringIOC容器的配置类,也是SpringBoot推荐使用配置形式,所以主程序类标注了@SpringBootConfiguration注解,其本身也就是一个配置类。更多有关JavaConfig形式的配置以及有关它和xml形式的配置的区别与联系,请参考后续有关Spring注解版相关文章。

1.2 @ComponentScan

@ComponentScan注解在Spring的注解中也起到到相当重要的作用,它可以自定义Spring扫描的包,也就是它默认会扫描标注了@Controller、@Service、@Component以及@Repository注解的类,并实例化这些组件到SpringIOC容器中,它有个配置属性:basePackages,也就是指定扫描的包,如果不知道,它会默认扫描配置了该注解的类的包所在的路径(包括子包)。我们看@SpringBootConfiguration注解的源码中有段代码:

1
2
3
4
5
@AliasFor(
annotation = ComponentScan.class,
attribute = "basePackages"
)
String[] scanBasePackages() default {};

scanBasePackages属性,指定到了@ComponentScan注解的basePackages属性,所有在SpringBoot中,我们同样可以通过scanBasePackages属性指定包扫描的路径(如部指定,会默认扫描主程序类所在的包路径以及子包下的类):

1
@SpringBootApplication(scanBasePackages = "com.seagetech.springbootdemo")

1.3 @EnableAutoConfigration

关于SpringBoot的运作原理,它的核心功能还是由@EnableAutoConfigration注解提供,所有把它放到最后来讲,我们来看下它的源码:

1
2
3
4
5
6
7
8
9
10
11
12
13
@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 {};
}

1.3.1 @AutoConfigurationPackage

这个注解的主要功能自动配置包,它会获取主程序类所在的包路径,并将包路径(包括子包)下的所有组件注册到SpringIOC容器中。

1.3.2 @Import({AutoConfigurationImportSelector.class})

@EnableAutoConfiguration 的关键功能也是这个@Import导入的配置功能,使用SpringFactoriesLoader.loadFactoryNames方法来扫描具有META-INF/spring.factories文件的jar包,我们看看在spring-boot-autoconfigure-2.10.RELEASE.jar包的META-INF下正好有个spring.factories文件:

图片

打开spring.factories文件,找到org.springframework.boot.autoconfigure.EnableAutoConfiguration指定的自动配置类:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\

......
......

org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.ClientHttpConnectorAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\

每一个xxxAutoConfiguration类都是容器中的一个组件,都加入到容器中,用它们来做自动配置。

2 自动配置分析

在上一节基础上,我们知道每一个自动配置类进行自动配置功能,下面我们以HttpEncodingAutoConfiguration为例来分析:

2.1 配置参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@ConfigurationProperties(
prefix = "spring.http"//①
)
public class HttpProperties {
private boolean logRequestDetails;
private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();//②

......

public static class Encoding {
public static final Charset DEFAULT_CHARSET;
private Charset charset;
private Boolean force;
private Boolean forceRequest;
private Boolean forceResponse;
private Map<Locale, Charset> mapping;

public Encoding() {
this.charset = DEFAULT_CHARSET;//②
}
......
static {
DEFAULT_CHARSET = StandardCharsets.UTF_8;//②
}
......
}

代码解析:
①、在application.properties文件中配置的时候指定前缀是spring.http;
②、指定默认的编码方式是UTF-8,如果需要修改,可使用spring.http.encoding.charset=编码。

2.2 自动配置类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@Configuration//①
@EnableConfigurationProperties({HttpProperties.class})//②
@ConditionalOnWebApplication(
type = Type.SERVLET
)//③
@ConditionalOnClass({CharacterEncodingFilter.class})//④
@ConditionalOnProperty(
prefix = "spring.http.encoding",
value = {"enabled"},
matchIfMissing = true
)//⑤
public class HttpEncodingAutoConfiguration {
private final Encoding properties;

public HttpEncodingAutoConfiguration(HttpProperties properties) {
this.properties = properties.getEncoding();
}

@Bean
@ConditionalOnMissingBean
public CharacterEncodingFilter characterEncodingFilter() {
......
}
.......
}

源码解析:
①、表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件
②、启动指定类的ConfigurationProperties功能,将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingProperties加入到ioc容器中;
③、Spring底层@Conditional注解(有关@Conditional注解的详解请参考后续Spring注解相关文章),根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效,该注解是判断当前应用是否是web应用,如果是,HttpEncodingAutoConfiguration 配置类生效;
④、判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器,如果有则HttpEncodingAutoConfiguration 配置生效;
⑤、判断application.properties配置文件中是否存在spring.http.encoding.enabled,如果不存在,判断也是成立的,因为matchIfMissing=true,即缺省时默认为true。
根据当前不同的条件判断,决定HttpEncodingAutoConfiguration 这个配置类是否生效?一但这个配置类生效;这个配置类就会给容器中添加各种组件,这些组件的属性是从对应的HttpEncodingProperties类中获取的,这些类里面的每一个属性又是和配置文件绑定的。

2.3 @Conditional扩展注解

除了以上解析到的注解,SpringBoot还为我们提供了更多的有关@Conditional的派生注解。它们的作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效:

@Conditional扩展注解 作用(判断是否满足指定的条件)
@ConditionalOnBean 当容器里有指定的Bean的条件下
@ConditionalOnClass 当类路径下有指定的类的条件下
@ConditionalOnJava 基于JVM版本作为判断条件
@ConditionalOnMissingBean 当容器里没有指定的Bean的情况下
@ConditionalOnMissingClass 当类路径下没有指定的类的条件下
@ConditionalOnWebApplication 当前项目是Web项目的条件下
@ConditionalOnNotWebApplication 当前项目不是Web项目的条件下
@ConditionalOnProperty 指定的属性是否有指定的值
@ConditionalOnResource 类路径下是否有指定的值

#

× 请我吃糖~
打赏二维码