前言
前几天,指北君有一个朋友小王在面试过程中被吊打了。当时的情况是这样的。
面试官:Spring Boot
中最重要的注解是什么?你能讲讲为什么最重要吗?
小王:@SpringBootApplication
,这个注解最重要吧。@SpringBootApplication
注解能够实现 Spring 组件自动化配置,组件扫描。
面试官:那 @SpringBootApplication
注解是怎么实现 Spring Boot
的自动配置功能呢?
小王心想大事不妙,还真没有看过这块源码。支支吾吾回答不上,只好回家等通知了。
指北君得知此事,跟小王好好理了理这块知识点,然后就有了今天的文章。
概述
我们先来了解一下 @SpringBootApplication
是什么,以及如何在一个简单的 Spring Boot
应用程序中使用它。我们先看看 Spring Team
在源码中对它的定义是什么?
Indicates a configuration class that declares one or more @Bean methods and also triggers auto-configuration and component scanning. This is a convenience annotation that is equivalent to declaring @Configuration, @EnableAutoConfiguration and @ComponentScan.
表示一个配置类,它声明了一个或多个@Bean方法,也触发了自动配置和组件扫描。这是一个方便的注解,相当于声明了@Configuration、@EnableAutoConfiguration和@ComponentScan。
从上面的定义我们可以看出,@SpringBootApplication
注解其实是一个组合注解。使用 @SpringBootApplication
相当于同时使用了 @Configuration
、@EnableAutoConfiguration
和 @ComponentScan
。@SpringBootApplication
是在 Spring Boot 1.2.0
之后才开始有的,如何你的项目使用的 Spring Boot 1.2.0
之前的版本,那需要抱歉了,你不能使用这个注解,你只能完整的使用那 3 个注解来代替它。
那我们接下来看看,通过一个简单的示例来看看怎么使用的。
@SpringBootApplication
示例
下面是一个简单的例子,说明如何使用 @SpringBootApplication 注解来编写 Spring Boot 应用程序。
Spring Boot
项目的启动类非常的简洁,没有一行多余的代码。@SpringBootApplication
放在项目启动类上主要起到了自动化配置的作用。下面我们看看 @SpringBootApplication
具体的代码。
从 @SpringBootApplication
源码可以看出 @SpringBootApplication
= @SpringBootConfiguration
+ @ComponentScan
+ @EnableAutoConfiguration
。
前面已经提过了,@SpringBootApplication
是3个注解的组合,下面分别介绍一下每个注解都有什么作用吧。
@SpringBootConfiguration
这个注解将一个类标记为基于 Java Config 的配置类。如果你喜欢基于 Java 的配置而不是基于 XML 的配置,这一点就特别重要。
@ComponentScan
该注解使组件扫描成为可能,这样你创建的 Web 控制器类和其他组件将被自动发现,并在 Spring 应用上下文中注册为 Bean。你编写的所有
@Controller
类将被该注解发现。
@EnableAutoConfiguration
这个注解可以启用
Spring Boot
自动配置功能。
如果你仔细的话会发现和前面讲的不一样, @SpringBootConfiguration
是从那里冒出来的,不是应该是 @Configuration
吗?下面就告诉你答案。
@SpringBootConfiguration
从源码可以看出,@SpringBootConfiguration
继承自 @Configuration
,二者功能也一致,标注当前类是配置类,不过 @SpringBootConfiguration
是一个特殊的标记类,在项目中只能使用一次。
@ComponentScan
@ComponentScan
不做过多的解释了,使用过 Spring 的朋友都懂的。其他的朋友我就啰嗦一句吧, 可以通过该注解指定扫描某些包下包含如下注解的均自动注册为 Spring beans
:@Component
、@Service
、 @Repository
、 @Controller
等等注释的类。Spring Boot
除了可以使用 @ComponentScan 注解来加载我们的bean,还可以使用 @Import 指定该类。
@EnableAutoConfiguration
@EnableAutoConfiguration
的作用启动自动的配置,意思就是 Spring Boot
根据你添加的 jar 包来配置你项目的默认配置,比如根据 spring-boot-starter-web
,来判断你的项目是否需要添加了 web mvc
和 tomcat
,就会自动的帮你配置 web 项目中所需要的默认配置。简单点说就是它会根据定义在 classpath 下的类,自动的给你生成一些 Bean,并加载到 Spring 的上下文中。
从上述源码中可以看到 @Import
引入了 AutoConfigurationImportSelector
类。AutoConfigurationImportSelector
使用了 Spring Core
包的 SpringFactoriesLoader#loadFactoryNames()
方法。AutoConfigurationImportSelector
类实现了 DeferredImportSelector
接口,并实现了 selectImports
方法,用来导出 Configuration
类。
导出的类是通过 SpringFactoriesLoader#loadFactoryNames()
读取了 classpath
下面的 META-INF/spring.factories
文件。
META-INF/spring.factories
文件中一部分自动配置的内容:
如果你发现自动装配的 Bean 不是你想要的,你也可以 disable 它。比如说,我不想要自动装配 Database 的那些Bean:
这也是一种为 Spring Boot
项目瘦身的方法。你可以看到网上一些为项目瘦身的方法都是通过这个注解来操作的。
@AutoConfigurationPackage
@EnableAutoConfiguration
又继承了 @AutoConfigurationPackage
,@AutoConfigurationPackage
会引导类(@SpringBootApplication
标注的类)所在的包及下面所有子包里面的所有组件扫描到Spring容器。具体怎么实现的呢,我们来看代码,原来它 import 了 AutoConfigurationPackages.Registrar.class
, 我们来看看它做了什么?
看代码就很容易理解,把注解扫描进来的 package 全部给注册到 spring bean中。这样 Spring Boot
的自动配置也就完成了。
总结
经过这样的一番折腾,相信大家已经对 @SpringBootApplication
注解,有了一定的了解。也知道了 @SpringBootApplication
怎么实现 Spring Boot
的自动配置功能。下次面试官要是再问这个问题,现在你就可以不被他吊打了。
有任何问题可以在公众号后台留言,指北君会第一时间回复大家。欢迎关注公众号【Java技术指北】,第一时间获取更多精彩内容。