【springboot】入口类注解解析+自动配置原理

最新推荐文章于 2024-07-13 18:15:00 发布

秋洛颍

最新推荐文章于 2024-07-13 18:15:00 发布

阅读量1.9k

点赞数 2

分类专栏： java 文章标签： java spring spring boot

本文链接：https://blog.csdn.net/molihuakai_118/article/details/105932330

版权

java 专栏收录该内容

36 篇文章 0 订阅

订阅专栏

我们在写一个springboot项目时，只需要一个入口类（启动类）就能够将整个需要注入到spring容器中的类注入，并将整个项目启动。
那么这个入口类的执行原理到底是怎么样的呢？

一、入口类注解解析

一般入口类中内容如下，如此简洁，是怎么做到将整个项目启动并向容器中注入相关内容的？其中@SpringBootApplication发挥了很大的功能。

/**
 *  @SpringBootApplication 来标注一个主程序类，说明这是一个Spring Boot应用
 */
@SpringBootApplication
public class SpringBootMainApplication {
    public static void main(String[] args) {
        //spring应用启动起来
        SpringApplication.run(SpringBootMainApplication.class,args);
    }
}

@SpringBootApplication

说明：该注解是SpringBoot应用注解，它标注在那个类上说明这个类就是SpringBoot的主配置类，SpringBoot就应该运行这个类的main方法来启动SpringBoot应用；

@SpringBootApplication注解按照源码点击进去后会发现其内部也标注了很多注解，即该注解是一个复合注解，使用一个相当于使用其内部三个注解的功能：

@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 {

其中前四个注解就是我们非常熟悉的元注解（标识该类是作为一个注解使用，并写明相关属性），在这里不过多描述，可参考这篇文章：元注解

后三个注解，@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan是@SpringBootApplication注解继承来的，下面单独讲解其功能；

@SpringBootConfiguration

这个注解类上有@Configuration注解标识，@Configuration是Spring 3.0时添加的一个注解（该配置类也是容器中的一个组件），用来代替原来spring中的applicationContext.xml 配置文件，原来在applicationContext.xml配置文件里面能做到的事情都可以通过这个注解所在类来进行注册。

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

@SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名。

@EnableAutoConfiguration

该注解是一个核心注解，用于开启自动配置功能，其内部提供了强大的自动依赖功能，是SpringBoot这么方便的大功臣。

@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、@AutoConfigurationPackage

这个注解的意思是自动配置包，即把入口类所在包下的所有文件进行扫描匹配，装进spring容器：
在这里插入图片描述
该注解主要的功能是由@Import({Registrar.class})来实现的，Import注解也是Spring的底层注解，它用来给spring容器中导入一个组件，导入的组件由Registrar.class内部指定。断点进入Registrar类中，我们会发现以下内容：
在这里插入图片描述
Registrar.class这个类中有一个非常重要的静态内部类，用来将主配置类（@SpringBootApplication标注的类）的所在包及下面所有子包里面的所有组件扫描到Spring容器中；

2、@Import({AutoConfigurationImportSelector.class})

他存在的作用就是给容器中导入一些组件，具体哪些组件由AutoConfigurationImportSelector.class选择（spring对J2EE中整合好的组件）。AutoConfigurationImportSelector的意思就是开启自动配置类的导包的选择器（导入哪些组件的选择器）。

断点分析源码内容：
在这里插入图片描述

那么到底需要导入哪些配置类，代码运行是怎么知道的呢（也就是上面图片中的configurations参数内容），这就用到了该类中的另一个方法getCandidateConfigurations。

该方法中调用了SpringFactoriesLoader类中的loadFactoryNames方法：
SpringFactoriesLoader.loadFactoryNames（EnableAutoConfiguration.class，classLoader）

它的作用总结就是：
1、扫描所有jar包类路径下 META‐INF/spring.factories。
2、把扫描到的这些文件的内容包装成properties对象。
3、从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器中。

作用内容如下：
在这里插入图片描述
J2EE的整体整合解决方案和自动配置都在spring-boot-autoconfigure-1.5.9.RELEASE.jar；

Spring Boot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值，将
这些值作为自动配置类导入到容器中，自动配置类就生效，帮我们进行自动配置工作；以前我们需要自己配置的东西，自动配置类都帮我们做了。

@ComponentScan

这个注解使我们所熟知的，用于自动扫描包路径下标识相关注解的类，并将其注入到容器。它在这里起到一个过滤的功能，按照自定义格式过滤掉制定文件，不被注入到spring容器中。

@ComponentScan(excludeFilters = {
      @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
      @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

二、自动配置原理

前面我们了解到@Import({AutoConfigurationImportSelector.class})这个注解，能够将一些指定的组件注入到spring容器中，那他究竟是怎样注入成功的呢？

下面我们以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理。
在这里插入图片描述
首先找到这个类：

@Configuration
@EnableConfigurationProperties(HttpProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {

@Configuration

表明这是一个配置类

@EnableConfigurationProperties(HttpProperties.class)

和以前编写的配置文件一样，可以给容器中添加组件@EnableConfigurationProperties
启动指定类的ConfigurationProperties功能，这里开启的是HttpProperties类的ConfigurationProperties功能。将配置文件中对应的值和HttpEncodingProperties绑定起来。
在这里插入图片描述
所有的配置文件（这里只的是yml文件）中能配置的属性都是在xxxxProperties类（这里是HttpProperties.class）中封装着，配置文件能配置什么就可以参照某个功能对应的这个属性类。

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)

spring底层有一个@Conditional注解，它会根据不同条件判断，如果满足指定的条件，整个配置类就会生效。

在这里判断的是当前应用是否是web应用，如果是，当前配置类生效。
在这里插入图片描述

@ConditionalOnClass(CharacterEncodingFilter.class)

判断当前项目有没有CharacterEncodingFilter这个类，这个类是springmvc中进行乱码解决的过滤器。

@ConditionalOnProperty(prefix = “spring.http.encoding”, value = “enabled”, matchIfMissing = true)

判断配置文件中是否存在某个配置 spring.http.encoding.enabled；如果不存在，判断也是成立的；
即使我们配置文件中不配置spring.http.encoding.enabled=true，其实也是默认生效的；

具体代码如下：

@Configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件

@EnableConfigurationProperties(HttpProperties.class)//启动指定类的ConfigurationProperties功能；
将配置文件中（本类中）对应的值和HttpProperties绑定起来；并把HttpProperties加入到ioc容器中。

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)//Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果
满足指定的条件，整个配置类里面的配置就会生效；    判断当前应用是否是web应用，如果是，当前配置类生效

@ConditionalOnClass(CharacterEncodingFilter.class)//判断当前项目有没有这个类CharacterEncodingFilter；
SpringMVC中进行乱码解决的过滤器。

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
//判断配置文件中是否存在某个配置  spring.http.encoding.enabled；如果不存在，判断也是成立的。
//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
    
public class HttpEncodingAutoConfiguration {
    
    //他已经和SpringBoot的配置文件映射了 
    private final HttpProperties.Encoding properties;
    
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }

    @Bean //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @ConditionalOnMissingBean //判断容器有没有这个组件
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
        return filter;
    }

该类中根据当前不同的条件判断，决定这个配置类（HttpEncodingAutoConfiguration）是否生效。一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
在这里插入图片描述

总结

1）、SpringBoot启动会加载大量的自动配置类
2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；
3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）
4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这
些属性的值；

秋洛颍

关注

2
点赞
踩
8

收藏

觉得还不错? 一键收藏
1
评论
【springboot】入口类注解解析+自动配置原理

我们在写一个springboot项目时，只需要一个入口类（启动类）就能够将整个需要注入到spring容器中的类注入，并将整个项目启动。那么这个入口类的执行原理到底是怎么样的呢？一、入口类注解解析一般入口类中内容如下，如此简洁，是怎么做到将整个项目启动并向容器中注入相关内容的？其中@SpringBootApplication发挥了很大的功能。/** * @SpringBootAppli...
复制链接

扫一扫

专栏目录