【源码解析】自动配置的这些细节都不知道,别说你会 springboot

spring-boot 相对于 spring,很重要的一个特点就是自动配置,使约定大于配置思想成功落地。xxx-spring-boot-starter 一系列引导器能够开箱即用,或者只需要很少的配置(对于初学人员)就是因为已做了默认的自动配置。

自动配置在一开始就初始化了一些配置,同时提供修改配置的入口。

整体结构
spring-boot-autoconfigure 包是 spring-boot-starter 中一个非常重要的包,其中提供了自动配置功能,还对常用依赖,设置了默认配置。

依赖
其依赖的包有三种:

基础包:spring-boot
可选功能依赖包:提供默认配置的常用依赖包,实际使用时由使用者提供
测试包
可选功能依赖包有 spring-data-redis、validator、thymeleaf、websocket 等等。下面会选几个作为示例具体讲解。

原理br/>@EnableAutoConfiguration
@AutoConfigurationPackagebr/>@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
/**

AutoConfigurationImportSelector
自动配置选择器,选择哪些类自动配置。

selectImports
核心方法:String[] selectImports(AnnotationMetadata annotationMetadata) ,此方法返回需要自动配置的全类名数组。
需要自动配置的类满足以下条件:

META-INF/spring.factories 中 key 为 org.springframework.boot.autoconfigure.EnableAutoConfiguration 的类
@EnableAutoConfiguration 注解中 exclude 、 excludeName 属性代表的类, 配置中 spring.autoconfigure.exclude 中设置的类(若类路径中存在,但是步骤 1 不存在,则抛异常)
满足包含三种注解的条件:OnBeanCondition(如:ConditionalOnBean、ConditionalOnMissingBean) 、OnClassCondition (如:ConditionalOnClass、ConditionalOnMissingClass)、OnWebApplicationCondition(如:ConditionalOnWebApplication、ConditionalOnNotWebApplication)
最后,会激活 AutoConfigurationImportEvent 事件。

getImportGroup 与 DeferredImportSelector.Group
对来自不同 ImportSelector 的结果进行分组

自动配置的顺序br/>AutoConfigurationSorter
@AutoConfigureOrder
@AutoConfigureBefore
br/>@AutoConfigureAfter
AutoConfigurationSorter 是具体控制排序的逻辑
@AutoConfigureOrder 是 @Order 的 Auto-configuration 特定变体,因此需要制定自定配置的顺序时,可以用 @AutoConfigureOrder 。控制应用配置类的绝对顺序。
@AutoConfigureBefore 和 @AutoConfigureAfter 控制应用配置类的相对顺序。

具体培训顺序如下:

根据类名按照字母表递增排序
根据 @AutoConfigureOrder value 值(默认:0)递增排序
根据 @AutoConfigureBefore 和 @AutoConfigureAfter 调整排序
那么 @Order 还能控制自动配置类的顺序吗?

@SpringBootApplication
2.1.8.RELEASE 版本中,此注解的组合注解如下:

// 省略不需关心的注解br/>@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
已有原来的 @Configuration 改为 @SpringBootConfiguration,其意义如下:

相当于是 @Configuration 类
使用该注解的类提供 Spring Boot 应用。
一个应用只能包含一个 @SpringBootConfiguration 类,通常使用 @SpringBootApplication 就可以了
AbstractDependsOnBeanFactoryPostProcessor
此类实现 BeanFactoryPostProcessor,会在 spring-boot 启动过程中在合适的时机执行
继承此类,通过构造器动态决定指定类型的 bean 应该依赖于哪些 bean。

BackgroundPreinitializer
此类实现 ApplicationListener<SpringApplicationEvent>
此类功能为:在耗时任务的后台线程中触发早期初始化,如:
ValidationInitializer、MessageConverterInitializer、JacksonInitializer、CharsetInitializer、ConversionServiceInitializer、MBeanFactoryInitializer等

@ImportAutoConfiguration
导入自动配置类。从源码来看,都是测试时用于自动配置。使用此类的注解,也在 META-INF/spring.factories 中配置,示例如下:

@ImportAutoConfiguration
public @interface AutoConfigureDataJpa {}
org.springframework.boot.test.autoconfigure.orm.jpa.AutoConfigureDataJpa=org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration
因此使用注解 AutoConfigureDataJpa 就相当于导入了 JpaRepositoriesAutoConfiguration
```、
DataSourceAutoConfiguration 等类。

使用如下:

@BootstrapWith(DataJpaTestContextBootstrapper.class)br/>@ExtendWith(SpringExtension.class)
@OverrideAutoConfiguration(enabled = false)
br/>@TypeExcludeFilters(DataJpaTypeExcludeFilter.class)
@Transactional
br/>@AutoConfigureCache
@AutoConfigureDataJpa
br/>@AutoConfigureTestDatabase
@AutoConfigureTestEntityManager
br/>@ImportAutoConfiguration
public @interface DataJpaTest {
// ...
br/>}
@RunWith(SpringRunner.class)
@DataJpaTest
@TestPropertySource(properties = "spring.jpa.hibernate.use-new-id-generator-mappings=false")
public class DataJpaTestIntegrationTests {

@Autowired
private TestEntityManager entities;

@Autowired
private JdbcTemplate jdbcTemplate;

@Autowired
private ExampleRepository repository;

@Autowired
private DataSource dataSource;

@Autowired
private ApplicationContext applicationContext;

@Test
public void testEntityManager() {
    ExampleEntity entity = this.entities.persist(new ExampleEntity("spring", "123"));
    this.entities.flush();
    Object id = this.entities.getId(entity);
    ExampleEntity found = this.entities.find(ExampleEntity.class, id);
    assertThat(found.getName()).isEqualTo("spring");
}

// ...
对常用工具的支持
以上原理是提供自动配置的基石,但实际在使用的时候,很多内容不需要任何(或极少量)配置就能直接使用,一方面是各 xxx-spring-boot-starter 中包含了 spring-boot-autoconfigure 并写了自动配置逻辑,一方面,是 spring-boot 官方在 spring-boot-autoconfigure 包中已经直接支持了。
spring-boot 对常用工具的支持
spring-boot 对常用数据源的支持

示例:gson 自动配置
支持有如下类:

GsonProperties
GsonBuilderCustomizer
GsonAutoConfiguration
GsonProperties 类获取 Gson 的配置属性

@ConfigurationProperties(prefix = "spring.gson")
public class GsonProperties {
private Boolean generateNonExecutableJson;
private Boolean excludeFieldsWithoutExposeAnnotation;
private Boolean serializeNulls;
private String dateFormat;
// ...
br/>}
@FunctionalInterface
public interface GsonBuilderCustomizer {
/**

  • 自定义 GsonBuilder
    */
    void customize(GsonBuilder gsonBuilder);
    }
    GsonAutoConfiguration 中使用 GsonProperties 和 GsonBuilderCustomizer(内部类中实现)

@Configurationbr/>@ConditionalOnClass(Gson.class)
@EnableConfigurationProperties(GsonProperties.class)
public class GsonAutoConfiguration {
br/>@Bean
@ConditionalOnMissingBean
public GsonBuilder gsonBuilder(List<GsonBuilderCustomizer> customizers) {
GsonBuilder builder = new GsonBuilder();
customizers.forEach((c) -> c.customize(builder));
return builder;
}

@Bean
@ConditionalOnMissingBean
public Gson gson(GsonBuilder gsonBuilder) {
    return gsonBuilder.create();
}

@Bean
public StandardGsonBuilderCustomizer standardGsonBuilderCustomizer(GsonProperties gsonProperties) {
    return new StandardGsonBuilderCustomizer(gsonProperties);
}

static final class StandardGsonBuilderCustomizer implements GsonBuilderCustomizer, Ordered {

    private final GsonProperties properties;

    StandardGsonBuilderCustomizer(GsonProperties properties) {
        this.properties = properties;
    }

    @Override
    public int getOrder() {
        return 0;
    }

    @Override
    public void customize(GsonBuilder builder) {
     // ...
    }

【源码解析】自动配置的这些细节都不知道,别说你会 springboot

原文地址:https://blog.51cto.com/14207399/2443606

时间: 2024-08-11 18:40:20

【源码解析】自动配置的这些细节都不知道,别说你会 springboot的相关文章

GlusterFS源码解析 —— GlusterFS 配置

GlusterFS 源码安装方式:http://blog.csdn.net/wangyuling1234567890/article/details/25519261 1.GlusterFS的典型架构图 2.GlusterFS常用translators(中继) 2.1.1.    storage/posix type storage/posix storage/posix的作用是指定一个本地目录给GlusterFS内的一个卷使用. 配置例子: volume posix-example type

Spring源码解析 – @Configuration配置类及注解Bean的解析

在分析Spring 容器创建过程时,我们知道容器默认会加载一些后置处理器PostPRocessor,以AnnotationConfigApplicationContext为例,在构造函数中初始化reader时,加载默认后置处理器.其中 ConfigurationClassPostProcessor这个后置处理器专门处理带有@Configuration注解的类,ConfigurationClassPostProcessor后置处理实现了BeanDefinitionRegistryPostProce

Ejabberd源码解析前奏--配置

一.基本配置     配置文件将在你第一次启动ejabberd时加载,从该文件中获得的内容将被解析并存储到内部的ejabberd数据库中,以后的配置将从数据库加载,并且任何配置文件里的命令都会被添加到数据库里. 需要注意的是:ejabberd从不编辑配置文件,因此,使用Web管理修改的配置被存储在数据库中, 而不是反射到配置文件.如果你想那些修改在ejabberd重启后还有效,你可以同时也修改配置文件或删除它的所有内容. 配置文件包含一系列Erlang条款.以‘%’标志开始的行被忽略.每个条款是

Lucene源码解析--IndexWriterConfig配置参数说明

原文:http://blog.itpub.net/28624388/viewspace-766134/ 创建IndexWriter实例时,通过IndexWriterConfig来设置其相关配置:1.Analyzer:分析器 2.matchVersion:所用Lucene的版本 3.ramBufferSizeMB:随机内存 默认为16M.用于控制buffer索引文档的内存上限,如果buffer的索引文档个数到达该上限就写入硬盘.当然,一般来说越大索引速度越快 4.maxBufferedDocs:最

Spring3.2 中 Bean 定义之基于 XML 配置方式的源码解析

Spring3.2 中 Bean 定义之基于 XML 配置方式的源码解析 本文简要介绍了基于 Spring 的 web project 的启动流程,详细分析了 Spring 框架将开发人员基于 XML 定义的 Bean 信息转换为 Spring 框架的 Bean Definition 对象的处理过程,向读者展示了 Spring 框架的奥妙之处,可以加深开发人员对 Spring 框架的理解. 0 评论: 秦 天杰, 软件工程师, IBM China 2013 年 9 月 02 日 内容 在 IBM

Python2 基本数据结构源码解析

Python2 基本数据结构源码解析 Contents 0x00. Preface 0x01. PyObject 0x01. PyIntObject 0x02. PyFloatObject 0x04. PyStringObject 0x05. PyListObject 0x06. PyDictObject 0x07. PyLongObject 0x00. Preface 一切皆对象,这是Python很重要的一个思想之一,虽然在语法解析上有些细节还是不够完全对象化,但在底层源码里,这个思想还是贯穿

SpringSecurity 依据用户请求的过程进行源码解析

SpringSecurity实现安全管理主要通过滤器(filter).验证器(AuthenticationManager).用户数据提供器(ProviderManager).授权器(accessDecisionManager).投票器(AccessDecisionVoter)这几个基本模块协作完成的.大概分为两个部分 用户验证 和授权 这个两个部分.这个部分主要在AuthenticationProcessingFilter和AbstractSecurityInterceptor中完成. 使用过S

grunt源码解析:整体运行机制&amp;grunt-cli源码解析

前端的童鞋对grunt应该不陌生,前面也陆陆续续的写了几篇grunt入门的文章.本篇文章会更进一步,对grunt的源码进行分析.文章大体内容内容如下: grunt整体设计概览 grunt-cli源码分析 grunt-cli模块概览 grunt-cli源码分析 写在后面 grunt整体设计概览 grunt主要由三部分组成.其中,grunt-cli是本文的讲解重点 grunt-cli:命令行工具,调用本地安装的grunt来运行任务,全局安装. grunt:本地grunt,一般安装在项目根目录下.主要

Spring源码解析-applicationContext

Demo uml类图 ApplicationContext ApplicationListener 源码解析 主流程 obtainFreshBeanFactory prepareBeanFactory invokeBeanFactoryPostProcessors registerBeanPostProcessors registerListeners finishRefresh 总结 在已经有BeanFactory可以完成Ioc功能情况下,spring又提供了ApplicationContex