SpringBoot自动配置的实现原理

更新时间：2019年01月07日 09:05:16 作者：LNMPR源码研究

这篇文章主要介绍了详解SpringBoot自动配置原理，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

一、运行原理

Spring Boot的运行是由注解@EnableAutoConfiguration提供的。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({EnableAutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
  String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
 
  Class<?>[] exclude() default {};
 
  String[] excludeName() default {};
}

这里的关键功能是@Import注解。EnableAutoConfigurationImportSelector使用SpringFactoriesLoader.loadFactoryNames方法来扫描具有MEAT-INF/spring.factories文件的jar包（1.5版本以前使用EnableAutoConfigurationImportSelector类，1.5以后这个类废弃了使用的是AutoConfigurationImportSelector类），下面是spring-boot-autoconfigure-1.5.4.RELEASE.jar下的MEAT-INF中的spring.factories文件的部分内容。

# Initializers
org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer,\
org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer
 
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.autoconfigure.BackgroundPreinitializer
 
# Auto Configuration Import Listeners
org.springframework.boot.autoconfigure.AutoConfigurationImportListener=\
org.springframework.boot.autoconfigure.condition.ConditionEvaluationReportAutoConfigurationImportListener
 
# Auto Configuration Import Filters
org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=\
org.springframework.boot.autoconfigure.condition.OnClassCondition
 
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\

里面的类都是自动配置类，SpringBoot会根据这些自动配置类去自动配置环境。

下面我们就自动动手写一个starter。

二、自定义Starter

首先先介绍几个条件注解。

@ConditionalOnBean：当容器里有指定的Bean为true
@ConditionalOnClass：当类路径下有指定的类为true
@ConditionalOnMissingBean：当容器里没有指定的Bean为true
@ConditionalOnProperty：指定的数据是否有指定的值
...

了解了条件注解后，我们开始自定义Starter。

1、在自定义Starter之前先要在Maven中填写依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
 
  <groupId>cn.miaolovezhen</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>
 
  <name>spring-boot-starter-test</name>
  <description>Demo project for Spring Boot</description>
 
  <parent>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-parent</artifactId>
   <version>1.5.6.RELEASE</version>
   <relativePath/> <!-- lookup parent from repository -->
  </parent>
 
  <properties>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
   <java.version>1.8</java.version>
  </properties>
 
  <dependencies>
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-autoconfigure</artifactId>
     <version>1.5.4.RELEASE</version>
   </dependency>
  </dependencies>
 
</project>

2、完成TestProperties类，这个类定义了默认的属性值，如该类中，只有一个属性值msg，默认为world。@ConfigurationProperties注解会定义一个匹配，如果想修改属性值，可以在application.properties中使用“匹配.属性=修改的值”进行修改。如test.msg = tan

@ConfigurationProperties(prefix = "test")
public class TestProperties {
  private static final String MSG = "springboot";
  private String msg = MSG;
 
  public String getMsg() {
    return msg;
  }
 
  public void setMsg(String msg) {
    this.msg = msg;
  }
}

3、完成服务类。服务类是指主要的功能类，如果没有SpringBoot，这些服务类在Spring中都是需要自己去配置生成的。如SpringMVC中的DispatcherServlet、Mybatis的DataSource等。

public class TestService {
  private String msg;
 
  public String sayHello(){
    return "Hello " + msg;
  }
 
  public String getMsg() {
    return msg;
  }
 
  public void setMsg(String msg) {
    this.msg = msg;
  }
}

4、完成自动配置类。自动配置类主要作用是SpringBoot的配置核心，它会写在MEAT-INF/spring.factories中，告知SpringBoot在启动时去读取该类并根据该类的规则进行配置。

@EnableConfigurationProperties注解根据TestProperties类开启属性注入，允许在application.properties修改里面的属性值。
@ConditionOnClass会检测是否存在TestService类
@ConditionOnProperty类会查看是否开启该自动配置。默认开启（true）。
@ConditionOnMissingBean会检测容器中是否有TestService类的对象，如果没有则生成一个。

@Configuration
@EnableConfigurationProperties(TestProperties.class)
@ConditionalOnClass(TestService.class)
@ConditionalOnProperty(prefix = "test" , value = "enabled" , matchIfMissing = true)
public class TestServiceAutoConfiguration {
  @Autowired
  TestProperties testProperties;
 
  @Bean
  @ConditionalOnMissingBean(TestService.class)
  public TestService testService(){
    TestService testService = new TestService();
    testService.setMsg(testProperties.getMsg());
    return testService;
  }
}

5、最后一步，不要忘记在在MEAT-INF文件夹中创建spring.factories文件。内容很简单，告诉SpringBoot去读取TestServiceAutoConfiguration类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.miaolovezhen.TestServiceAutoConfiguration

好啦，搞定！下面可以使用maven install命令把starter存到本地，其他SpringBoot项目需要使用这个starter，直接导入就可以啦。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

Java项目中添加外部jar包的两种方式(收藏版)
这篇文章主要介绍了java项目中添加外部jar包的两种方式,第二种方式是将外部jar包引入到本地maven仓库中，本文给大家讲解的非常详细，需要的朋友可以参考下
2023-03-03
Mybatis应用mysql存储过程查询数据实例
下面小编就为大家分享一篇Mybatis应用mysql存储过程查询数据实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2017-12-12
Spring中的父子容器原理解析
这篇文章主要为大家介绍了Spring中的父子容器原理解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-07-07
详解MyBatis resultType与resultMap中的几种返回类型
本文主要介绍了MyBatis resultType与resultMap中的几种返回类型，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-09-09
基于java Springboot实现教务管理系统详解
这篇文章主要介绍了Java 实现简易教务管理系统的代码,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-08-08
Java如何实现保证线程安全
这篇文章主要介绍了Java如何实现保证线程安全问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2025-04-04
Java项目全面升级转化经验(涉及JDK、Spring boot版本及依赖管理架构)
在软件开发领域,项目升级是一个必然的过程,随着技术的不断进步和业务需求的变化,对于旧项目的升级和优化已成为许多企业必须面对的问题,这篇文章主要介绍了Java项目全面升级转化的相关资料,包括JDK、Spring boot版本及依赖管理架构,需要的朋友可以参考下
2025-09-09
Java系统运行缓慢等问题的排查思路
这篇文章主要介绍了Java系统运行缓慢等问题的排查思路，读者可以根据具体情况具体分析，从而解决问题
2021-04-04
一文搞清楚Java中Comparable和Comparator的区别
Java中的Comparable和Comparator都是用于集合排序的接口，但它们有明显的区别，文中通过一些实例代码详细介绍了Java中Comparable和Comparator的区别，感兴趣的同学跟着小编一起学习吧
2023-05-05
SpringBoot项目配置数据库密码加密相关代码
这篇文章主要介绍了SpringBoot项目配置数据库密码加密的相关资料,本文介绍了在Springboot项目中配置数据库连接时存在的安全问题,即用户名和密码以明文形式存储,容易泄露,提出了一种简单的加密方案,需要的朋友可以参考下
2024-11-11

SpringBoot自动配置的实现原理

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具