03 Spring Boot 自动配置及原理分析

最新推荐文章于 2024-11-13 10:43:06 发布
最新推荐文章于 2024-11-13 10:43:06 发布
阅读量281 收藏
点赞数 1
分类专栏： SpringBoot 文章标签： spring boot spring java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46731938/article/details/106976670
版权

Spring Boot 自动配置及原理分析

专栏列表

  1. Spring Boot 入门及环境构建
  2. Spring Boot 配置
  3. Spring Boot 自动配置及原理分析
  4. Spring Boot 日志
  5. SpringBoot Web 开发、Thymeleaf 模版 Spring MVC
  6. SpringBoot RESTful风格的增删改查 CRUD

文章目录

自动配置原理

配置文件到底能写什么？怎么写？自动配置原理；

配置文件能配置的属性参照

SpringBoot启动的时候加载主配置类，开启了自动配置功能

@SpringBootApplication
@EnableAutoConfiguration

@EnableAutoConfiguration 作用

  • 利用EnableAutoConfigurationImportSelector给容器中导入一些组件

  • 可以插件 selectImport() 方法的内容

  • getAutoConfigurationEntry方法中

    // 获取候选的配置
List<String> configurations = getCandidateConfigurations(annotationMetadata,attributes);

  • getCandidateConfigurations方法中，SpringFactoriesLoader.loadFactoryNames()，扫描所有jar包类路径下 META-INF/spring.factories，把扫描到的这些文件的内容包装成properties对象，从properties中获取到EnableAutoConfiguration.class（类名）对应的值，然后把它们添加在容器中

    将类路径下 META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到了容器中
    在这里插入图片描述

  • 每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中；用他们来做自动配置；

  • 每一个自动配置类进行自动配置功能；

以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理

package org.springframework.boot.autoconfigure.web.servlet;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type;
import org.springframework.boot.autoconfigure.web.ServerProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.web.server.WebServerFactoryCustomizer;
import org.springframework.boot.web.servlet.filter.OrderedCharacterEncodingFilter;
import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory;
import org.springframework.boot.web.servlet.server.Encoding;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.web.filter.CharacterEncodingFilter;

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

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

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

//判断当前项目有没有这个类
@ConditionalOnClass({CharacterEncodingFilter.class})

/**
 * 判断配置文件中是否存在某个配置  spring.http.encoding.enabled；如果不存在，判断也是成立的
 * 即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
 */
@ConditionalOnProperty(
  prefix = "spring.http.encoding",
  value = {"enabled"},
  matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {
  // 它已经和SpringBoot的配置文件映射了
  private final 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(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
    filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
    return filter;
  }
  
  @Bean
  public HttpEncodingAutoConfiguration.LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {
    return new HttpEncodingAutoConfiguration.LocaleCharsetMappingsCustomizer(this.properties);
  }
  
  static class LocaleCharsetMappingsCustomizer implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>, Ordered {
    private final Encoding properties;
    
    LocaleCharsetMappingsCustomizer(Encoding properties) {
      this.properties = properties;
    }
    
    public void customize(ConfigurableServletWebServerFactory factory) {
      if (this.properties.getMapping() != null) {
        factory.setLocaleCharsetMappings(this.properties.getMapping());
      }
    }
    
    public int getOrder() {
      return 0;
    }
  }
}
  1. 根据当前不同的条件判断，决定这个配置类是否生效
  2. 一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；配置文件能配置什么就可以参照某个功能对应的这个属性类

@ConfigurationProperties(
  prefix = "spring.http"
)
public class HttpProperties {
  private boolean logRequestDetails;
  private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();

// 从配置文件中获取指定的值和 bean 的属性进行绑定
@ConfigurationProperties(prefix = "spring.http.enncoding")
public class HttpEncodingProperties{
  public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
}

@ConfigurationProperties 执行器配置依赖

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>

总结

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

xxxxAutoConfigurartion：自动配置类；

xxxxProperties:封装配置文件中相关属性；

@Conditional派生注解

作用：必须是 @Conditional 指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

@Conditional扩展注解作用（判断是否满足当前指定条件）
@ConditionalOnJava系统的java版本是否符合要求
@ConditionalOnBean容器中存在指定Bean；
@ConditionalOnMissingBean容器中不存在指定Bean；
@ConditionalOnExpression满足SpEL表达式指定
@ConditionalOnClass系统中有指定的类
@ConditionalOnMissingClass系统中没有指定的类
@ConditionalOnSingleCandidate容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty系统中指定的属性是否有指定的值
@ConditionalOnResource类路径下是否存在指定资源文件
@ConditionalOnWebApplication当前是web环境
@ConditionalOnNotWebApplication当前不是web环境
@ConditionalOnJndiJNDI存在指定项

查看那些自动配置类生效了

自动配置类必须在一定的条件下才能生效；

我们怎么知道哪些自动配置类生效了；

我们可以通过配置文件启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

  • Positive matches ：（自动配置类启用的）
  • Negative matches：（没有启动，没有匹配成功的自动配置类）
Kevin KDA
关注
专栏目录
Spring Boot自动注入的原理分析
08-25
Spring Boot自动注入的原理分析 Spring Boot自动注入的原理分析是指在Spring Boot框架中，自动将Bean实例化并注入到容器中的机制。这种机制可以简化开发过程，减少手动配置的麻烦，并提高开发效率。在这篇文章中，...
Spring Boot 文件上传原理解析
08-27
但在Spring Boot中，这些配置已经自动完成，只需在`application.properties`中进行调整以满足实际需求，如设置上传目录、最大文件大小和请求大小： ```properties # multipart config spring....
Spring Boot 自动配置实现原理（源码分析）
weixin_42118323的博客
07-01 1387
这里我们只简单贴出两个重点方法，process 方法和 selectImports 方法，我们在 process 方法中看到了 AutoConfigurationImportSelector#getAutoConfigurationEntry 方法，这个方法在项目启动时候是调用了的，因此我们可以进一步猜测，项目启动的时候是调用了 AutoConfigurationImportSelector.AutoConfigurationGroup#process 方法。下面我们从源码层面去剖析。
Spring Boot自动配置原理
m0_68041576的博客
08-18 5833
自动装配是指在应用程序启动时，SpringBoot根据classpath类路径下的依赖自动装配应用程序所需的一系列bean和配置类，从而减少开发者的配置工作，提高开发效率。需求： 自定义redis-starter，要求当导入redis坐标时，SpringBoot自动创建Jedis的Bean参考： 可以参考mybatis启动类的应用创建redis-spring-boot-autoconfigure模块。
深入理解 Spring Boot 自动配置原理
m0_61118741的博客
09-24 678
在传统的 Spring 框架中，开发者需要编写大量的配置代码来启动应用，比如定义 Bean、配置数据库连接池、JPA 配置等。而 Spring Boot 则通过自动配置来减少这些繁琐的工作。所谓自动配置，就是根据项目依赖和环境信息，自动为你创建和配置相关的 Spring Bean 和服务。Spring Boot 使用了注解来实现这一功能，它会根据类路径中的依赖，自动配置应用所需的 Bean。如果你想自定义某个自动配置组件，可以通过定义相同类型的 Bean 来覆盖默认配置。@Bean。
Spring Boot自动配置原理解析
莪是男神的博客
07-06 1068
就是这些注解实现的按需加载自动配置，@ConditionalOnClass(Advice.class) 表示指定的类存在才会加载这个自动配置，@ConditionalOnProperty 则表示指定的属性存在才加载这个配置类，我们现在知道了 Spring 是按需加载的自动配置类，那么我们能不能修改 Spring 的默认配置呢，答案是肯定的。当然，并不是所有的自动配置类都会配置进 Spring 容器，因为很多时候有些功能是用不到的，如果用不到的东西也配置进容器，就会造成不必要的资源消耗。...
Spring Boot自动配置原理浅析
齐天小圣^O^ 的博客
08-15 1万+
一、什么是Spring Boot的自动配置？ Spring Boot的最大的特点就是简化了各种xml配置内容，还记得曾经使用SSM框架时我们在spring-mybatis.xml配置了多少内容吗？数据源、连接池、会话工厂、事务管理···，而现在Spring Boot告诉你这些都不需要了，一切交给它的自动配置吧！ 所以现在能大概明白什么是Spring Boot的自动配置了吗？简单来说就是用注解来对一些常规的配置做默认配置，简化xml配置内容，使你的项目能够快速运行。 是否对Spring Boot自动配置
spring boot实战自动配置原理分析_spring boot自动配置原理、实战
2401_87557053的博客
11-10 846
转载 ：http://blog.csdn.net/liaokailin/article/details/49559951。
Spring Boot 3 【二】Spring Boot自动配置机制深度解析
技术管理修行
07-12 1452
Spring Boot作为Java领域最为流行的快速开发框架之一，其核心特性之一就是其强大的自动配置机制。随着Spring Boot 3.3.1的发布，这一机制得到了进一步的优化和完善，为开发者提供了更加便捷、高效的应用程序搭建和部署体验。本文将深入讲解Spring Boot 3.3.1的自动配置机制，包括其工作原理、特点、优势，并通过实际代码示例和源码解析，展示如何在应用中灵活运用这一机制。此外，我们还将探讨可能遇到的挑战及相应的解决方案。
Spring Boot - 自动配置实现原理
小工匠
05-16 2万+
文章目录Pre@SpringBootApplication 注解@ComponentScan 注解@SpringBootConfiguration 注解@EnableAutoConfiguration 注解@AutoConfigurationPackage@Import@Import(AutoConfigurationImportSelector.class) Pre Spring Boot 中的配置体系是一套强大而复杂的体系，其中最基础、最核心的要数自动配置（AutoConfiguration）机制了
Spring Boot自动装配原理
qq_63688997的博客
07-24 2039
Spring Boot的自动转配原理深究以及总结。
Spring Boot的自动装配原理
热门推荐
YING—country的博客
07-20 3万+
自动装配是springboot的核心，一般提到自动装配就会和springboot联系在一起。实际上SpringFramework早就实现了这个功能。SpringBoot只是在其基础上，通过SPI的方式，做了进一步优化。SpringBoot定义了一套接口规范，这套规范规定SpringBoot在启动时会扫描外部引用jar包中的文件，将文件中配置的类型信息加载到Spring容器（此处涉及到JVM类加载机制与Spring的容器知识），并执行类中定义的各种操作。...
spring boot启动加载数据原理分析
08-30
在Spring Boot应用中，我们经常需要在项目启动时执行一些初始化任务，比如加载数据库数据、配置设置或者其他系统准备任务。Spring Boot为此提供了一个简洁的机制，即通过实现`CommandLineRunner`或`Application...
深入探讨Spring Boot自动配置原理及源码常见注解拾遗
本文主要讨论了Spring Boot自动配置的原理，主要分为三个部分：SpringBoot源码常见注解解析、SpringBoot启动过程以及SpringBoot自动配置原理。第一部分主要讨论了SpringBoot中经常使用到的注解，为后续理解源码提供...
在启动 Spring Boot 项目时，报找不到 slf4j 的错误
m0_75138009的博客
11-12 472
将 pom.xml 中的如下配置替换成这样，排除这个插件。而且 tomcat 的启动信息不知道为什么输出出来了。
Spring Boot集成SQL Server快速入门Demo
HBLOG
11-11 943
SQL Server是由Microsoft开发和推广的以客户/服务器（c/s）模式访问、使用Transact-SQL语言的关系数据库管理系统（DBMS），它最初是由Microsoft、Sybase和Ashton-Tate三家公司共同开发的，并于1988年推出了第一个OS/2版本。Microsoft SQL Server近年来不断更新版本，1996年，Microsoft 推出了SQL Server 6.5版本；1998年，SQL Server 7.0版本和用户见面；
现代电商解决方案：Spring Boot框架实践
最新发布
2402_85762143的博客
11-13 923
本网上商城系统也是紧跟科学技术的发展，运用当今一流的软件技术实现软件系统的开发，让医生管理信息完全通过管理系统实现科学化，规范化，程序化管理。网上商城系统的设计方案比如功能框架的设计，比如数据库的设计的好坏也就决定了该系统在开发层面是否高效，以及在系统维护层面是否容易维护和升级，因为在系统实现阶段是需要考虑用户的所有需求，要是在设计阶段没有经过全方位考虑，那么系统实现的部分也就无从下手，所以系统设计部分也是至关重要的一个环节，只有根据用户需求进行细致全面的考虑，才有希望开发出功能健全稳定的程序软件。
Spring Boot编程训练系统：开发流程与技巧
2401_85743969的博客
11-12 1116
概念模式的设计方法是在需求分析的基础上，用概念数据模型（例如E-R模型）表示数据及数据之间的相互联系，设计出反映用户信息需求和处理需求的数据库系统概念模式。概念设计的目标是准确描述应用领域的信息模式，支持用户的各种应用，这样既容易转换为数据库系统逻辑模式，又容易为用户理解。在概念模式的设计中，E-R模型法是最常见的设计方法。概念设计的目标是设计出反映某个组织部门信息需求的数据库系统概念模式，数据库系统的概念模式独立于数据库系统的逻辑结构、独立于数据库管理系统（DBMS）、独立于计算机系统。
Spring Boot整合Lombok详解
ning的博客
11-11 1237
Lombok是一个强大的Java库，它通过注解的方式简化了Java代码的编写，减少了模板代码的生成。在Spring Boot项目中整合Lombok非常简单，只需要添加依赖和安装插件即可。Lombok的注解如@Data@Getter和@Setter等，极大地提高了开发效率和代码的可读性。虽然Lombok有很多优点，但在团队中使用时，需要确保所有成员都了解和接受Lombok，以保持代码风格的一致性。版权声明：本博客内容为原创，转载请保留原文链接及作者信息。参考文章Spring Boot整合Lombok。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Kevin KDA

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值