转载

Spring Boot自动配置源码解析

Spring Boot版本:2.1.6.RELEASE

Spring Boot自动配置主要通过 @EnableAutoConfiguration, @Conditional, @EnableConfigurationProperties 或者 @ConfigurationProperties 等几个注解来进行自动配置完成的。

@EnableAutoConfiguration 开启自动配置,主要作用就是调用 Spring-Core 包里的 loadFactoryNames(),将 autoconfig 包里的已经写好的自动配置加载进来。

@Conditional 条件注解,通过判断类路径下有没有相应配置的 jar 包来确定是否加载和自动配置这个类。

@EnableConfigurationProperties 的作用就是,给自动配置提供具体的配置参数,只需要写在 application.properties 中,就可以通过映射写入配置类的 POJO属性中。

接下来我们一步步去跟踪源码,来印证以上观点:

首先打开启动类:

@SpringBootApplication

public class SponsorApplication {

public static void main(String[] args) {

SpringApplication.run(SponsorApplication.class, args);

}

}

进入到注解@SpringBootApplication中

Spring Boot自动配置源码解析

接下去,进入@EnableAutoConfiguration注解中,如下图

Spring Boot自动配置源码解析

我们可以看到@Import注解,继续点击进入AutoConfigurationImportSelector中,找到selectImports方法,如下图

Spring Boot自动配置源码解析

Spring Boot自动配置源码解析

继续点击进入selectImport方法中的getAutoConfigurationEntry方法中,如下图

Spring Boot自动配置源码解析

在此方法中,我们可以看到getCandidateConfigurations方法,继续点进去,让我们一探究竟,谜团马上就要解开了,

Spring Boot自动配置源码解析

进入loadFactoryNames方法

Spring Boot自动配置源码解析

进入loadSpringFactories方法中

Spring Boot自动配置源码解析

好了,让我们看看FACTORIES_RESOURCE_LOCATION到底是什么

Spring Boot自动配置源码解析

到这里,我们发现一顿操作以后最终是加载的META-INF/spring.factorieswen文件,那么这个文件应该去哪里找呢,我们如果使用idea的话,那么请找到project下的External Libraries中的 org.springframework.boot.autoconfigure,然后打开, 可以看到一系列Spring Boot自动配置的列表

如下图:

Spring Boot自动配置源码解析

下面我们来看自动配置redis的细节,RedisAutoConfiguration:

Spring Boot自动配置源码解析

这个类进行了简单的Spring配置,声明了Redis所需典型Bean,和其它很多类一样,重度依赖于Spring Boot注释:

1)@ConditionOnClass激活一个配置,当类路径中存在这个类时才会配置该类

2)@EnableConfigurationProperties自动映射一个POJO到Spring Boot配置文件(默认是application.properties文件)的属性集。

3)@ConditionalOnMissingBean启用一个Bean定义,但必须是这个Bean之前未定义过才有效。

还可以使用@ AutoConfigureBefore注释、@AutoConfigureAfter注释来定义这些配置类的载入顺序。

着重了解@Conditional注释性

此注释使得只有在特定条件满足时才启用一些配置。SrpingBoot的AutoConfig大量使用了@Conditional,它会根据运行环境来动态注入Bean。这里介绍一些@Conditional的使用和原理,并自定义@Conditional来自定义功能。

  • @Conditional是SpringFramework的功能,SpringBoot在它的基础上定义了
  • @ConditionalOnClass,@ConditionalOnProperty等一系列的注解来实现更丰富的内容。

具体几个@Conditon*注解的含义

@ConditionalOnBean

仅仅在当前上下文中存在某个对象时,才会实例化一个Bean

@ConditionalOnClass

某个class位于类路径上,才会实例化一个Bean),该注解的参数对应的类必须存在,否则不解析该注解修饰的配置类

@ConditionalOnExpression

当表达式为true的时候,才会实例化一个Bean

@ConditionalOnMissingBean

仅仅在当前上下文中不存在某个对象时,才会实例化一个Bean,该注解表示,如果存在它修饰的类的bean,则不需要再创建这个bean,可以给该注解传入参数例如@ConditionOnMissingBean(name = "example"),这个表示如果name为“example”的bean存在,这该注解修饰的代码块不执行

@ConditionalOnMissingClass

某个class类路径上不存在的时候,才会实例化一个Bean

@ConditionalOnNotWebApplication

不是Web应用时,才会执行

接下去,我们再看下Properties系列注释:

@EnableConfigurationProperties

@ConfigurationProperties(prefix = "may")

在需要注入配置的类上加上这个注解,prefix的意思是,以该前缀打头的配置,以下是例子

Spring Boot自动配置源码解析

application.yml中的配置

Spring Boot自动配置源码解析

如果不用系统初始的application.yml配置类,而是使用自己的如youjie.yml,可以如下配置

Spring Boot自动配置源码解析

@EnableConfigurationProperties

最后注意在spring Boot入口类加上@EnableConfigurationProperties

Spring Boot自动配置源码解析

其实这里@EnableConfigurationProperties({User.class,User2.class}) 可以省略

Spring Boot自动配置源码解析

SpringBoot 的 自动配置得益于 SpringFramework 强大的支撑,框架早已有很多工具和注解可以自动装配 Bean 。SpringBoot 通过 一个封装,将市面上通用的组件直接写好了配置类。当我们程序去依赖了这些组件的 jar 包后,启动 SpringBoot应用,于是自动加载开始了。

总结:  

SpringBoot 自动配置主要通过  @EnableAutoConfiguration@Conditional@EnableConfigurationProperties 或者  @ConfigurationProperties 等几个注解来进行自动配置完成的。

@EnableAutoConfiguration 开启自动配置,主要作用就是调用  Spring-Core 包里的  loadFactoryNames() ,将  autoconfig 包里的已经写好的自动配置加载进来。
@Conditional 条件注解,通过判断类路径下有没有相应配置的  jar 包来确定是否加载和自动配置这个类。
@EnableConfigurationProperties 的作用就是,给自动配置提供具体的配置参数,只需要写在  application.properties 中,就可以通过映射写入配置类的  POJO 属性中。

补充:有的朋友会问为什么springboot已经为我们自动配置好了redis,为什么我们的项目中还需要再进行配置呢?    

我们进入RedisAutoConfiguration这个类。 通过源码可以看出,SpringBoot自动帮我们在容器中生成了一个 RedisTemplate和一个 StringRedisTemplate。 但是,这个 RedisTemplate的泛型是 <Object,Object>,写代码不方便,需要写好多类型转换的代码;我们需要一个泛型为 <String,Object>形式的 RedisTemplate。并且,这个 RedisTemplate没有设置数据存在Redis时,key及value的序列化方式。 看到这个 @ConditionalOnMissingBean 注解后,就知道如果Spring容器中有了 RedisTemplate对象了,这个自动配置的 RedisTemplate不会实例化 。因此我们可以直接自己写个配置类,配置 RedisTemplate。

Linux公社的RSS地址 : https://www.linuxidc.com/rssFeed.aspx

本文永久更新链接地址: https://www.linuxidc.com/Linux/2019-08/160248.htm

原文  https://www.linuxidc.com/Linux/2019-08/160248.htm
正文到此结束
Loading...