Springboot核心原理(一) —神奇开始地方@SpringBootApplication详解

  • Post author:
  • Post category:其他



1. SpringBoot是什么?


在此之间,一直都有用过SpringBoot.你可不做任何配置就可以生成一个基于spring的应用。觉得很神奇。因为在没有springBoot的时候,想要去搭建一个基于spring的过程中会需要配置大量的 xml,或者需要做很多繁琐的配置。

由此可以,我们可以给SpringBoot下一个定义就是:springboot 框架是为了能够帮助使用 spring 框架的开发者快速高效的构建一个基于 spirng 框架以及 spring 生态体系的应用解决方案。它是一个服务于框架的框架。


2. SpringBoot 无配置化的核心— 约定由于配置


既然我们在搭建SpringBoot时候,可以不做任何的配置就将项目启动起来.要是在这个项目中真的是什么都没有的话,那就是任谁来都不能让项目启动起来.唯一能解释这个就是,在SpringBoot中有这大量的默认配置,来帮助我们简化开发.实际上在SpringBoot确实有着很多默认提供好的配置,当我们需要对这些配置做自定义修改的时候,只需要按照约定好的方式,简单修改下配置项即可.

在SpringBoot中约定优于配置的体现在一下几方面:

1. maven 的目录结构

a) 默认有 resources 文件夹存放配置文件

b) 默认打包方式为 jar

2. spring-boot-starter-web 中默认包含 spring mvc 相关依赖以及内置的 tomcat 容器,使得构一个 web 应用更加简单.

3. 默认提供 application.properties/yml 文件

4. 默认通过 spring.profiles.active 属性来决定运行环境时读取的配置文件

5. EnableAutoConfiguration 默认对于依赖的 starter 进行自动装载 (

最重要

)


3.

神奇开始的地方@SpringBootApplication注解



在SpringBoot项目中,启动类代码

@SpringBootApplication
public class SpringBootStatDemoApplication {
	public static void main(String[] args) {
		SpringApplication.run(SpringBootStatDemoApplication.class, args);
	}
}

在启动类中都会有@SpringBootApplication注解.这里就是一起神奇事情开始的地方.我们直接看看@SpringBootApplication这里面都做了什么?

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

在这上面会有其他的很多注解.表示@SpringBootApplication是一个复合注解.

SpringBootApplication 本质上是由 3 个注解组成,分别是

1. @Configuration

2. @EnableAutoConfiguration

3. @ComponentScan

不光在这里我们能看到,在官方文档中也有着同样的描述

The @SpringBootApplication annotation is equivalent to using @Configuration, @EnableAutoConfiguration, and @ComponentScan with their default attributes.

在这三个注解当中除了 EnableAutoConfiguration可能稍微陌生一点,其他两个注解使用得都很多

3.1.

Configuration注解

@Configuration
public @interface SpringBootConfiguration {
}

在@EnableAutoConfiguration源码中还有一个@Configuration注解.表明其实这个和@Configuration是等价的.

Configuration 这个注解大家应该有用过,它是 JavaConfig形式的基于 Spring IOC 容器的配置类使用的一种注解。因为SpringBoot的本质上也是Spring应用.所以通过这个注解来加载IOC容器的配置项很正常.在启动类中标注了@Configuration,意味着它其实也是一个 IoC容器的配置类。

任何一个标注了@Configuration 的 Java 类定义都是一个JavaConfig 配置类。而在这个配置类中,任何标注了@Bean 的方法,它的返回值都会作为 Bean 定义注册到Spring 的 IOC 容器,方法名默认成为这个 bean 的 id.

@Configuration
public class ConfigurationDemo {
    @Bean
    public DemoClass demoClass(){
        return new DemoClass();
    }
}

想是这个Demo中DemoClass的实例就会放到ioc容器中,beanid 为demoClass.

3.2

@ComponentScan


ComponentScan 这个注解是大家接触得最多的了,相当于 xml 配置文件中的 <context:component-scan > 。主要作用就是扫描指定路径下的标识了需要装配的类,自动装配到 spring 的 Ioc 容器中。

标识需 要装配的类的 形式主要是: @Component 、@Repository、@Service、@Controller 这类的注解标识的类。ComponentScan 默认会扫描当前 package 下的的所有加了相关注解标识的类到 IoC 容器中;

3.3

@EnableAutoConfiguration


这个注解是这三个注解中最为重要的一个,对于SpringBoot来说他的意义重大.

在这里简单说一下,Enable 并不是新鲜玩意.在Spring3.1中,提供了一系列的@Enable 开头的注解,Enable 注解应该是在 JavaConfig 框架上更进一步的完善,使得用户在使用 spring 相关的框架时,避免配置大量的代码从而降低使用的难度

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

找到 EnableAutoConfiguration,我们可以看到每一个涉及到 Enable 开头的注解,都会带有一个@Import 的注解。

这个@Import 是个什么玩意呢?联想到 xml 形式下有一个 形式的注解,就明白它的作用了。import 就是把多个分来的容器配置合并在一个配置中。在JavaConfig 中所表达的意义是一样的。

EnableAutoConfiguration的主要作用就是帮助SpringBoot应用,把所有符合调剂的@Configuration配置都加载到当前的SpringBoot应用中,并使用IOC容器进行管理.

在这里的@import中我们发现import是这样的@Import(AutoConfigurationImportSelector.class)

这个AutoConfigurationImportSelector又是个什么鬼呢?

在import这个注解中,不仅是只能简单的传一个带有@Configuration注解的类,整个Configuration而已.还可以实现一些比较复杂的场景,比容根据上下文不同,来激活不同类型的bean.

在import中可以配置三种不同类型的class:

1.第一种基于普通 bean 或者带有@Configuration 的 bean 进行注入

2.实现 ImportSelector 接口进行动态注入

3.实现 ImportBeanDefinitionRegistrar 接口进行动态注入

在接着往下探究之前,我们有必要了解一下ImportSelector的工作原理.因为从名字(AutoConfigurationImportSelector)上我们可以看到,SpringBoot中是基于ImportSelector实现的.

public class CacheImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        Map<String, Object> attributes = annotationMetadata.getAnnotationAttributes(EnableDefineService.class.getName());
        //动态注入bean :自己去实现判断逻辑实现动态配置

        return new String[]{CacheService.class.getName()};
    }
}

在一个实现了ImportSelector接口的类中,必须要实现selectImports.该方法的返回值的数组(类的全类名)都会被纳入到spring 容器中。

方法中的annotationMetadata,通过这个可以获取到标签上的元数据.例如@EnableDefineService(exclude = LoggerService.class)

这个注解中,后面的exclude = LoggerService.class,这一串就是标签的元数据.

在这里就可以写一些自己的检验逻辑,并决定最后返回,并注入到ioc容器中bean是哪些.

了解了 ImportSelector 后,对于 EnableAutoConfiguration 的理解就容易一些了.定位到AutoConfigurationImportSelector类中selectImports方法.本质上来说,其实 EnableAutoConfiguration 会帮助springboot 应用把所有符合@Configuration 配置都加载到当前 SpringBoot 创建的 IoC 容器,而这里面借助了Spring 框架提供的一个工具类 SpringFactoriesLoader 的支持。以及用到了 Spring 提供的条件注解@Conditional,选择性的针对需要加载的 bean 进行条件过滤.

**SpringFactoriesLoader**
给大家补充一下,SpringFactoriesLoader 这个工具类的使用。它其实和java 中的 SPI 机制的原理是一样的,不过它比 SPI 更好的点在于不会一次性加载所有的类,而是根据 key 进行加载。
首先, SpringFactoriesLoader 的作用是从classpath/META-INF/spring.factories 文件中,根据 key 来加载对应的类到 spring IoC 容器中。
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
				getBeanClassLoader());
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
        MultiValueMap result = (MultiValueMap)cache.get(classLoader);
        if(result != null) {
            return result;
        } else {
            try {
                Enumeration ex = classLoader != null?classLoader.getResources("META-INF/spring.factories"):ClassLoader.getSystemResources("META-INF/spring.factories");
                LinkedMultiValueMap var14 = new LinkedMultiValueMap();

当我们需要自己实现一个自动装配的时候,也是同样在自己的项目的resources目录下创建 /META-INF/spring.factories文件.在里面写上,需要自动装配的configuration即可.如下

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.gupaoedu.GpConfig

深入理解条件过滤

在分析 AutoConfigurationImportSelector 的源码时,会先扫描 spring-autoconfigurationmetadata.properties文件,最后在扫描 spring.factories 对应的类时,会结合

前面的元数据进行过滤,为什么要过滤呢? 原因是很多的@Configuration 其实是依托于其他的框架来加载的,如果当前的 classpath 环境下没有相关联的依赖,则意味着这些类没必要进行加载,所以,通过这种条件过滤可以有效的减少@configuration 类的数量从而降低SpringBoot 的启动时间。

Conditional 中的其他注解


Conditions

描述
@ConditionalOnBean 在存在某个 bean 的时候
@ConditionalOnMissingBean 不存在某个 bean 的时候
@ConditionalOnClass 当前 classpath 可以找到某个类型的类时
@ConditionalOnMissingClass 当前 classpath 不可以找到某个类型的类
@ConditionalOnResource 当前 classpath 是否存在某个资源文件
@ConditionalOnProperty 当前 jvm 是否包含某个系统属性为某个值
@ConditionalOnWebApplication 当前 spring context 是否是 web 应用程序





版权声明:本文为sinat_26229211原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。