關(guān)于@SpringBootApplication與@SpringBootTest的區(qū)別及用法

更新時(shí)間：2022年01月19日 08:48:03 作者：開心小蝸牛

這篇文章主要介紹了關(guān)于@SpringBootApplication與@SpringBootTest的區(qū)別及用法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

@SpringBootApplication與@SpringBootTest區(qū)別用法

1 @SpringBootApplication 注解的應(yīng)用

一般情況我們使用 @SpringBootApplication 注解來啟動(dòng) SpringBoot 項(xiàng)目

它其實(shí)只相當(dāng)于 @Configuration、@EnableAutoConfiguration、@ComponentScan(包含了兩個(gè)filter)

@SpringBootApplication
public class FrameworkUnitRealTestApp {
? ? public static void main(String[] args) {
? ? ? ? SpringApplication.run(FrameworkUnitRealTestApp.class, args);
? ? }
}

2 @SpringBootTest 注解的應(yīng)用

一般情況我們使用 @SpringBootTest 和 @RunWith(SpringRunner.class) 注解來啟動(dòng) SpringBoot 測(cè)試項(xiàng)目

@RunWith(SpringRunner.class)?
@SpringBootTest
public class FrameworkUnitRealTestApp {
? ? @Test
? ? public void test() {}
}

3 @SpringBootApplication 和 @SpringBootTest 的區(qū)別

這兩個(gè)注解的區(qū)別的核心在于兩個(gè)注解：@EnableAutoConfiguration、@ComponentScan(包含了兩個(gè)filter)

@EnableAutoConfiguration 啟動(dòng)了所有的自動(dòng)配置類

@ComponentScan(包含了兩個(gè)filter)：在掃描階段過濾掉 @TestComponent 等專屬于測(cè)試的類和過濾掉被 @Configuration 注解的自動(dòng)配置類（使得自動(dòng)配置類不會(huì)在掃描階段就被注冊(cè) beanDefinition，因?yàn)?自動(dòng)配置類的優(yōu)先級(jí)應(yīng)該是最低的）

可以看出 @SpringBootTest 并沒有啟用任何自動(dòng)配置類，所以就不需要加 AutoConfigurationExcludeFilter 了

springboot 通過引入 @Test** 注解來在測(cè)試環(huán)境下引入不同的自動(dòng)配置類！

4 @ComponentScan(包含了兩個(gè)filter) 解析

詳細(xì)的代碼如下：添加了 TypeExcludeFilter 和 AutoConfigurationExcludeFilter 兩個(gè) excludeFilter

作用：掃描包的時(shí)候過濾掉被這兩個(gè) Filter 匹配的類！

@ComponentScan(excludeFilters = {
?? ??? ?@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
?? ??? ?@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

4.1 TypeExcludeFilter 解析

主要移除測(cè)試相關(guān)的類

public class TypeExcludeFilter implements TypeFilter, BeanFactoryAware {
? ?@Override
? ?public boolean match(MetadataReader metadataReader,
? ? ? ? ?MetadataReaderFactory metadataReaderFactory) throws IOException {
? ? ? if (this.beanFactory instanceof ListableBeanFactory
? ? ? ? ? ? && getClass() == TypeExcludeFilter.class) {
? ? ? ? ?Collection<TypeExcludeFilter> delegates = ((ListableBeanFactory) this.beanFactory)
? ? ? ? ? ? ? ?.getBeansOfType(TypeExcludeFilter.class).values();
? ? ? ? ?for (TypeExcludeFilter delegate : delegates) {
? ? ? ? ? ? if (delegate.match(metadataReader, metadataReaderFactory)) {
? ? ? ? ? ? ? ?return true;
? ? ? ? ? ? }
? ? ? ? ?}
? ? ? }
? ? ? return false;
? ?}
}
//delegate.match 走這個(gè)類的 match 方法
class TestTypeExcludeFilter extends TypeExcludeFilter {
?? ?private static final String[] CLASS_ANNOTATIONS = { "org.junit.runner.RunWith",
?? ??? ??? ?"org.junit.jupiter.api.extension.ExtendWith" };
?? ?private static final String[] METHOD_ANNOTATIONS = { "org.junit.Test",
?? ??? ??? ?"org.junit.platform.commons.annotation.Testable" };

?? ?@Override
?? ?public boolean match(MetadataReader metadataReader,
?? ??? ??? ?MetadataReaderFactory metadataReaderFactory) throws IOException {
? ? ? ? //是否被 @TestComponent 及其父注解注釋
?? ??? ?if (isTestConfiguration(metadataReader)) {return true;}
? ? ? ? //類上或類中方法上有沒有 CLASS_ANNOTATIONS、METHOD_ANNOTATIONS 中的注解
?? ??? ?if (isTestClass(metadataReader)) {return true;}
?? ??? ?String enclosing = metadataReader.getClassMetadata().getEnclosingClassName();
?? ??? ?if (enclosing != null) {
? ? ? ? ? ? //遞歸內(nèi)部類、父類
? ? ? ? ? ? if (match(metadataReaderFactory.getMetadataReader(enclosing),
? ? ? ? ? ? ? ? ? ? ? metadataReaderFactory)) {
? ? ? ? ? ? ? ? return true;
? ? ? ? ? ? }
?? ??? ?}
?? ??? ?return false;
?? ?}
}

4.2 AutoConfigurationExcludeFilter 解析

主要移除被 @Configuration 修飾的自動(dòng)配置類

public class AutoConfigurationExcludeFilter implements TypeFilter, BeanClassLoaderAware {
?? ?@Override
?? ?public boolean match(MetadataReader metadataReader,
?? ??? ??? ?MetadataReaderFactory metadataReaderFactory) throws IOException {
? ? ? ? //如果被 @Configuration 注解，并且是 自動(dòng)配置類就返回 true，即匹配成功?
? ? ? ? //注：被 @Component 等注解并不匹配
?? ??? ?return isConfiguration(metadataReader) && isAutoConfiguration(metadataReader);
?? ?}
}

5 @EnableAutoConfiguration 注解解析

作用：啟用自動(dòng)配置類

@AutoConfigurationPackage
//啟用 AutoConfigurationImportSelector 配置類：掃描得到所有自動(dòng)配置類
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
? ?String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
? ?//定義不啟用的 自動(dòng)配置類
? ?Class<?>[] exclude() default {};
? ?//同上
? ?String[] excludeName() default {};
}
//這個(gè)注解主要是向容器中注冊(cè) AutoConfigurationPackages.Registrar 類用來存儲(chǔ)自動(dòng)配置包
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {}
//關(guān)鍵：這個(gè)類繼承了 DeferredImportSelector 接口，所以是到最后才解析的??！
public class AutoConfigurationImportSelector implements DeferredImportSelector{
? ? @Override
? ? public String[] selectImports(AnnotationMetadata annotationMetadata) {
? ? ? ? if (!isEnabled(annotationMetadata)) {
? ? ? ? ? ? return NO_IMPORTS;
? ? ? ? }
? ? ? ? AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
? ? ? ? ? ? .loadMetadata(this.beanClassLoader);
? ? ? ? AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(
? ? ? ? ? ? autoConfigurationMetadata, annotationMetadata);
? ? ? ? return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
? ? }
}

6 @…Test 注解

Spring Boot 中文文檔對(duì)每個(gè) @…Test 注解導(dǎo)入的自動(dòng)配置類做了詳細(xì)的說明

SpringBootTest對(duì)比SpringBootApplication

SpringBootTest 是測(cè)試使用類的注解，標(biāo)志這個(gè)類是測(cè)試用例。

具體看下源碼分析

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@BootstrapWith(SpringBootTestContextBootstrapper.class)
@ExtendWith({SpringExtension.class})
public @interface SpringBootTest {

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {

對(duì)比顯示都是復(fù)合注解，并且前四個(gè)注解是一樣的，后面區(qū)分BootstrapWith和ExtendWith這兩個(gè)是測(cè)試中包含的

BootstrapWith這個(gè)注解中有一個(gè)參數(shù)為SpringBootTestContextBootstrapper