关于@SpringBootApplication与@SpringBootTest的区别及用法

@springbootapplication与@springboottest区别用法

1 @springbootapplication 注解的应用

一般情况我们使用 @springbootapplication 注解来启动 springboot 项目

它其实只相当于 @configuration、@enableautoconfiguration、@componentscan(包含了两个filter)

@springbootapplication
public class frameworkunitrealtestapp {
    public static void main(string[] args) {
        springapplication.run(frameworkunitrealtestapp.class, args);
    }
}

2 @springboottest 注解的应用

一般情况我们使用 @springboottest 和 @runwith(springrunner.class) 注解来启动 springboot 测试项目

@runwith(springrunner.class) 
@springboottest
public class frameworkunitrealtestapp {
    @test
    public void test() {}
}

3 @springbootapplication 和 @springboottest 的区别

这两个注解的区别的核心在于两个注解：@enableautoconfiguration、@componentscan(包含了两个filter)

@enableautoconfiguration 启动了所有的自动配置类

@componentscan(包含了两个filter)：在扫描阶段过滤掉 @testcomponent 等专属于测试的类和过滤掉被 @configuration 注解的自动配置类（使得自动配置类不会在扫描阶段就被注册 beandefinition，因为 自动配置类的优先级应该是最低的）

可以看出 @springboottest 并没有启用任何自动配置类，所以就不需要加 autoconfigurationexcludefilter 了

springboot 通过引入 @test** 注解来在 测试环境下 引入不同的自动配置类！

4 @componentscan(包含了两个filter) 解析

详细的代码如下：添加了 typeexcludefilter 和 autoconfigurationexcludefilter 两个 excludefilter

作用：扫描包的时候过滤掉被这两个 filter 匹配的类！

@componentscan(excludefilters = {
        @filter(type = filtertype.custom, classes = typeexcludefilter.class),
        @filter(type = filtertype.custom, classes = autoconfigurationexcludefilter.class) })

4.1 typeexcludefilter 解析

主要移除测试相关的类

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 走这个类的 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) {
            //递归内部类、父类
            if (match(metadatareaderfactory.getmetadatareader(enclosing),
                      metadatareaderfactory)) {
                return true;
            }
        }
        return false;
    }
}

4.2 autoconfigurationexcludefilter 解析

主要移除被 @configuration 修饰的 自动配置类

public class autoconfigurationexcludefilter implements typefilter, beanclassloaderaware {
    @override
    public boolean match(metadatareader metadatareader,
            metadatareaderfactory metadatareaderfactory) throws ioexception {
        //如果被 @configuration 注解，并且是 自动配置类就返回 true，即匹配成功 
        //注：被 @component 等注解并不匹配
        return isconfiguration(metadatareader) && isautoconfiguration(metadatareader);
    }
}

5 @enableautoconfiguration 注解解析

作用：启用自动配置类

@autoconfigurationpackage
//启用 autoconfigurationimportselector 配置类：扫描得到所有自动配置类
@import(autoconfigurationimportselector.class)
public @interface enableautoconfiguration {
   string enabled_override_property = "spring.boot.enableautoconfiguration";
   //定义不启用的 自动配置类
   class<?>[] exclude() default {};
   //同上
   string[] excludename() default {};
}
//这个注解主要是向容器中注册 autoconfigurationpackages.registrar 类用来存储自动配置包
@import(autoconfigurationpackages.registrar.class)
public @interface autoconfigurationpackage {}
//关键：这个类继承了 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 中文文档 对每个 @…test 注解导入的自动配置类做了详细的说明

springboottest对比springbootapplication

springboottest 是测试使用类的注解，标志这个类是测试用例。

具体看下源码分析

@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 {

对比显示都是复合注解，并且前四个注解是一样的，后面区分bootstrapwith和extendwith这两个是测试中包含的

bootstrapwith这个注解中有一个参数为springboottestcontextbootstrapper

具体可以看下里面是什么

这里面申明了一些程序运行所在包的路径，在去查看继承的*类可以追溯到testcontextbootstrapper 这个接口 ：

从里面的方法可以看到是在运行的时候设置上下文 以及如何获取上下文，来提供测试启动的必须值。

接下来看下 extendwith 这个注解类

这个主要看里面的springextension这个参数

可以看出这个实现了很多接口，来处理测试需要的各种通知处理，以及在测试接口时可以提前处理请求参数。

springbootapplication中的复合注解则是扫描一些包和配置。虽然测试也是项目启动的一种，可以看到里面实现还是有些区别的。

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。