×
广告

Springboot之spring-boot-autoconfigure模块

96
阿里加多
2018.01.17 09:30 字数 785

一、前言

Spring的出现给我们管理bean的依赖注入提供了便捷,但是当我们需要使用通过pom引入的jar里面的一个bean时候,还是需要手动在xml配置文件里面主要注入的bean 。springboot则可以依据classpath里面的依赖内容来自动配置bean到IOC容器,Auto-configuration会尝试推断哪些beans是用户可能会需要的。比如如果HSQLDB包在当前classpath下,并且用户并没有配置其他数据库链接,这时候Auto-configuration功能会自动注入一个基于内存的数据库连接到应用的IOC容器。但是要开启这个自动配置功能需要添加@EnableAutoConfiguration注解。

Auto-configuration使用在class上标注@Configuration注解实现,并且使用@Configuration的时候一般带有一定的约束,比如同时还在class上标注了 @ConditionalOnClass(当前classpath下存在类) 和@ConditionalOnMissingBean(当前IOC容器不存在bean)注解。这保证了classpath下存在一些相关的类并且需要的bean还没有被注入到IOC时候auto-configuration才生效。

二、一个例子-web容器的自动配置

本节通过web容器创建的过程来分析下Auto-configuration是如何实现自动扫描装载的。


image.png
  • EmbeddedServletContainerAutoConfiguration类是web容器的Auto-configuration类。
  • @ConditionalOnWebApplication说明当前是web环境上下文时候才注入本类到IOC。
  • 对应tomcat来说它的核心代码里面需要Servlet.class, Tomcat.class这两个类,所以 @ConditionalOnClass({ Servlet.class, Tomcat.class })说明如果当前classpath的jar里面含有Servlet.class, Tomcat.class这两个类,才进入下一个条件的判断, @ConditionalOnMissingBean(value = EmbeddedServletContainerFactory.class, search = SearchStrategy.CURRENT)说明当前IOC容器里面是否没有EmbeddedServletContainerFactory的实例,如果两个条件都满足则会创建TomcatEmbeddedServletContainerFactory实例到IOC容器。
  • 对应Jetty来说它的核心代码里面需要Servlet.class, Server.class, Loader.class,WebAppContext.class,所以@ConditionalOnClass({ Servlet.class, Server.class, Loader.class,WebAppContext.class })是看当前classpath的jar里面是否含有这些类,这些类存在进入下一个条件看当前IOC容器里面是否没有EmbeddedServletContainerFactory的实例。

当应用引入spring-boot-starter-web时候默认是引入的是tomcat的start,所以会发现classpath下存在Servlet.class, Tomcat.class这两个类,并且IOC里面没有EmbeddedServletContainerFactory的实例,所以会创建TomcatEmbeddedServletContainerFactory到IOC。如果你需要使用Jetty则需要在引用spring-boot-starter-web的时候排除掉tomcat的start,然后在引入jetty的start即可。

注:JettyEmbeddedServletContainerFactory和TomcatEmbeddedServletContainerFactory都实现了EmbeddedServletContainerFactory接口。

三、总结

springboot的spring-boot-autoconfigure模块通过灵活的Auto-configuration注解使SpringBoot中的功能实现模块化和可被替换扩展。spring-boot-autoconfigure思路类似SPI(Service Provider Interface),都是不同的实现类实现了定义的接口,加载时候去查找classpath下的实现类,不同在于前者使用autoconfigure实现后者使用的是ServiceLoader。

日记本
Web note ad 1