SpringBoot AutoConfigure学习总结

最新推荐文章于 2024-11-14 17:30:09 发布

原创最新推荐文章于 2024-11-14 17:30:09 发布 · 1.3k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring #spring mvc #SpringBoot

Java 同时被 2 个专栏收录

56 篇文章

订阅专栏

Spring

21 篇文章

订阅专栏

本文主要探讨了SpringBoot自动配置的原理，包括自动配置类的激活条件、如何加载配置以及各种条件注解的使用，例如@ConditionalOnClass、@ConditionalOnBean等。SpringBoot通过在spring.factories文件中定义@EnableAutoConfiguration入口，结合各组件的自动配置类，实现了一键启动即可拥有完整功能的便捷性。

SpringBoot 优点

自动配置是Spring Boot的最大亮点，完美的展示了CoC约定由于配置。Spring Boot能自动配置Spring各种子项目（Spring MVC, Spring Security, Spring Data, Spring Cloud, Spring Integration, Spring Batch等）以及第三方开源框架所需要定义的各种Bean。

Spring Boot内部定义了各种各样的XxxxAutoConfiguration配置类，预先定义好了各种所需的Bean。只有在特定的情况下这些配置类才会被起。
2. 自动配置类清单
spring-boot-autoconfigure-1.5.1.RELEASE.jar/META-INF/spring.factories

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.web.WebClientAutoConfiguration,\
org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.WebSocketAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration

自动配置类定义

以org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration 为例子：

@Configuration
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurerAdapter.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {
1. @Bean
@ConditionalOnMissingBean(HiddenHttpMethodFilter.class)
public OrderedHiddenHttpMethodFilter hiddenHttpMethodFilter() {
return new OrderedHiddenHttpMethodFilter();
}
1. // …
1. }

如何加载这些自动配置的类

通过执行SpringApplication.run()方法，会把当前的SpringBootDemoApplication作为source传入，而在SpringApplication类中还会读取spring.factories中的设置一并构建应用的Context

自动配置类加载的条件

条件配置基于Spring的@Conditional，SpringBoot提供了丰富的条件配置：
引用
@ConditionalOnClass ： classpath中存在该类时起效
@ConditionalOnMissingClass ： classpath中不存在该类时起效
@ConditionalOnBean ： DI容器中存在该类型Bean时起效
@ConditionalOnMissingBean ： DI容器中不存在该类型Bean时起效
@ConditionalOnSingleCandidate ： DI容器中该类型Bean只有一个或@Primary的只有一个时起效
@ConditionalOnExpression ： SpEL表达式结果为true时
@ConditionalOnProperty ：参数设置或者值一致时起效
@ConditionalOnResource ：指定的文件存在时起效
@ConditionalOnJndi ：指定的JNDI存在时起效
@ConditionalOnJava ：指定的Java版本存在时起效
@ConditionalOnWebApplication ： Web应用环境下起效
@ConditionalOnNotWebApplication ：非Web应用环境下起效

参考：
http://rensanning.iteye.com/blog/2363467