（第四讲）Spring Boot 自动化配置原理解析

本讲着重介绍Spring Boot的核心技术原理—自动化配置（AutoConfiguration）。通过对Spring Boot自动化配置相关源码的梳理，一步步揭开Spring Boot自动化配置的神秘面纱。

1. 主要内容

通过本讲的内容，你可以找到下面几个问题的具体答案：

1. 什么是自动化配置？
2. 为什么需要自动化配置？
3. 自动化配置是如何实现的？
4. 如何调试自动化配置？

2. 为什么需要自动化配置

在常规的Spring应用程序中，充斥着大量的配置文件，我们需要手动去配置这些文件，如配置组件扫描、配置servlet、配置视图解析器，配置http编码等。这里以配置http编码为例，我们需要在web.xml文件中配置类似的一个filter:

image

下面的这段代码向我们展示了配置一个Servlet的经典写法：

image

如果我们的项目中使用Hibernate/JPA时 ，我们还需要配置诸如数据源、Bean工厂和事务管理器等。

image

上述的配置可以称得上是Spring应用程序的经典案例，但现在看起来，你是否觉得心累？常规的配置让开发人员将更多的经历耗费在了配置文件上。而这些配置都是一些固定模式的配置方式，甚至很多都是模板代码，那既然是这样一种情况，有没有一种可能性，让Spring自动完成这些模板配置工作呢？答案是肯定的，这就是Spring Boot AutoConfiguration产生的初衷。将开发人员从繁重的配置工作中解放出来，而这些繁琐的配置细节交由Spring Boot去完成，如果我们需要提供自己的配置参数，只需要覆盖自动配置的参数即可。现在是否觉得有点意思了？

3. Spring Boot自动化配置的核心原理

Spring Boot有关自动化配置的源码可以在spring-boot-autoconfigure-2.x.x.x.jar/spring-boot-autoconfigure-1.x.x.x.jar包中找到。在org.springframework.boot.autoconfigure包下，提供了如下的一些自动化配置源码：

image

如何你想了解更多关于Spring Boot自动配置的知识，可以在这里查看具体的源码。

在spring-boot-autoconfigure.jar包中还有一份重要的文件，它是Spring Boot实施自动配置的关键所在。该文件是/META-INFO/spring.factories。此文件列出了所有可以被Spring Boot实施自动配置的模块清单，下面列举其中的一部分以供参考：

image

4. 调试自动配置

有三种方式可以调试并查看有关自动配置的相关信息，如当前项目中有哪些组件被自动配置，有哪些组件未被自动配置以及产生的原因等。

1. 通过java -jar [jarfile] --debug的方式运行项目，可以观察自动化配置的相关信息。

2. 打开项目的调试日志记录。在application.properties文件中为org.springframework包添加日志记录级别为DEBUG :

   logging.level.org.springframework:DEBUG
   

3. 为项目添加spring-boot-starter-actuator和spring-data-rest-hal-browser两个依赖：

   

   image

使用方式一和方式二时，当我们重新启动应用程序时，你可以在控制台找到一份自动配置的报告，这份报告包含了被自动配置的组件信息和未被自动配置的组件信息以及相关的说明。

image

如果采用第三种方式，重新启动项目后，在浏览器地址栏输入http://localhost:8080/actuator/#http://localhost:8080/autoconfig ,你将收到如下的信息：

image

image

5 Spring Boot自动配置的核心原理

在Spring Boot应用程序中，所有的运作都起源于@SpringBootApplication注解，@SpringBootApplication打开了运行程序的大门。该注解是一个组合注解，其核心功能是由@EnableAutoConfiguration注解提供的。现在先让我们看一下@SpringBootApplication和@EnableAutoConfiguration注解的源码。

image

在SpringBootApplication注解类中，最核心的地方是上图1处的@EnableAutoConfiguration注解，它为@SpringBootApplication注解类贡献了大部分的功能。我们再看看@Enableautoconfiguration注解的源码：

image

这里最关键的地方是由@Import注解导入的自动配置功能，EnableConfigurationImportSelector通过SpringFactoriesLoader.loadFactoryNames()方法来扫描spring-boot-autoconfigure.jar文件下/META-INF/spring.factories文件中配置的jar包信息，这就是一开始提到的那一份spring.factories文件的重要性。我们可以看一下EnableConfigurationImportSelector类中对应的代码：

image

6. 一个自动配置的示例分析

org.springframework.boot.autoconfigure包下已经提供了很多的自动配置类，接下来我们以DataSourceAutoConfiguration为例子，看看其中配置的细节。通常，所有自动配置类都会查看类路径中可用的其他类。如果类路径中有特定的类，则通过自动配置启用该功能的配置。判断类路径上是否存在特定的东西，这是通过org.springframework.boot.autoconfigure.condition包下的条件注解来完成的，这里列举几个常用的条件注解解：

1. @ConditionalOnBean：当容器中有指定的Bean的条件下
2. @ConditionalOnClass：当类路径下有指定的类的条件下
3. @ConditionalOnMissingBean: 当容器中没有指定Bean的情况下
4. @ConditionalOnMissingClass: 当类路径下没有指定的类的条件下

image

@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })：仅当类路径中有这些类时，才会启用此配置。

@ConditionalOnMissingBean ：仅当没有其他bean配置相同名称时才配置此Bean。

7.结束语

通过以上内容，简单的梳理了Spring Boot 自动配置的大致原理，同时回答了一开始提出的4个问题。Spring Boot的出现，是为了提高我们的开发效率，我们需要去了解其核心的基本原理，但任何时候都不应该被一个框架或者技术所绑架，更为重要的是学习其基本的原理，而不是框架本身。基于这个出发点，在下一讲中，将实现一个自定义的Spring Boot Starter,并提供自动化配置的能力。那本次内容到这里就结束了，谢谢~~

作者：谭朝红
链接：（第四讲）Spring Boot 自动化配置原理解析
来源：谭朝红的技术分享博客