spring boot测试_测试Spring Boot有条件的合理方式

偏执的太偏执、 2023-02-25 07:01 11阅读 0赞

spring boot测试

如果您或多或少有经验的[Spring Boot][]用户，那么很幸运，在某些时候您可能需要遇到必须[有条件][Link 1]地注入特定bean或配置的[情况][Link 1] 。 它的机制是很好[理解的][Link 2] ，但有时这样的测试条件下（以及它们的组合）可能会导致混乱。 在这篇文章中，我们将讨论一些可行的方法（可以说是理智的）。

由于[Spring Boot 1.5.x][]仍被广泛使用（不过，它将在[今年8月][8]向[EOL][8]迈进），因此我们会将其与[Spring Boot 2.1.x][]一起包括在[JUnit 4.x][]和[JUnit 5.x中][JUnit 5.x] 。 我们将要介绍的技术同样适用于常规配置类和[自动配置][Link 2]类。

我们将使用的示例与我们的自制日志记录有关。 让我们假设我们的[Spring Boot][]应用程序需要一些名称为**“ sample”的**专用记录器bean。 但是，在某些情况下，必须禁用此记录器（或实际上使其成为noop），因此在这里，属性**logging.enabled**就像一个kill开关。 在此示例中，我们使用[Slf4j][]和[Logback][] ，但这并不是很重要。 下面的**LoggingConfiguration**片段反映了这个想法。

@Configuration  public class LoggingConfiguration { 
         @Configuration 
         @ConditionalOnProperty (name = "logging.enabled" , matchIfMissing = true ) 
         public static class Slf4jConfiguration { 
             @Bean 
             Logger logger() { 
                 return LoggerFactory.getLogger( "sample" ); 
             } 
         }     
         @Bean 
         @ConditionalOnMissingBean 
         Logger logger() { 
             return new NOPLoggerFactory().getLogger( "sample" ); 
         }  }

那么我们将如何测试呢？ [Spring Boot][] （通常是[Spring Framework][] ）一直提供[出色的测试脚手架支持][Link 3] 。 **@SpringBootTest**和**@TestPropertySource**批注允许使用自定义属性快速引导应用程序上下文。 但是，有一个问题：它们是按测试类级别而不是每种测试方法应用的。 这当然是有道理的，但基本上需要您为每个条件组合创建一个测试类。

如果您仍然使用[JUnit 4.x][] ，则可能会发现一个有用的技巧，它可以利用框架的隐藏的宝石**EnclosedRunner** 。

@RunWith (Enclosed. class (Enclosed. )  public class LoggingConfigurationTest { 
         @RunWith (SpringRunner. class ) 
         @SpringBootTest 
         public static class LoggerEnabledTest { 
             @Autowired private Logger logger;         
             @Test 
             public void loggerShouldBeSlf4j() { 
                 assertThat(logger).isInstanceOf(ch.qos.logback.classic.Logger. class ); 
             } 
         }     
         @RunWith (SpringRunner. class ) 
         @SpringBootTest 
         @TestPropertySource (properties = "logging.enabled=false" ) 
         public static class LoggerDisabledTest { 
             @Autowired private Logger logger;         
             @Test 
             public void loggerShouldBeNoop() { 
                 assertThat(logger).isSameAs(NOPLogger.NOP_LOGGER); 
             } 
         }  }

您仍然可以按条件获得类，但至少它们都在同一嵌套中。 使用[JUnit 5.x][] ，有些事情变得容易了，但并没有达到人们期望的水平。 不幸的是， [Spring Boot 1.5.x][]本身并不支持[JUnit 5.x][] ，因此我们必须依靠[spring-test-junit5][]社区模块提供的扩展。 这是**pom.xml**中的相关更改，请注意， **spring-boot-starter-test**依赖关系图中明确排除了**junit** 。

< dependency > 
         < groupId >org.springframework.boot</ groupId > 
         < artifactId >spring-boot-starter-test</ artifactId > 
         < scope >test</ scope > 
         < exclusions > 
             < exclusion > 
                 < groupId >junit</ groupId > 
                 < artifactId >junit</ artifactId > 
             </ exclusion > 
         </ exclusions >  </ dependency >  < dependency > 
         < groupId >com.github.sbrannen</ groupId > 
         < artifactId >spring-test-junit5</ artifactId > 
         < version >1.5.0</ version > 
         < scope >test</ scope >  </ dependency >  < dependency > 
         < groupId >org.junit.jupiter</ groupId > 
         < artifactId >junit-jupiter-api</ artifactId > 
         < version >5.5.0</ version > 
         < scope >test</ scope >  </ dependency >  < dependency > 
         < groupId >org.junit.jupiter</ groupId > 
         < artifactId >junit-jupiter-engine</ artifactId > 
         < version >5.5.0</ version > 
         < scope >test</ scope >  </ dependency >

除了使用**@Nested**批注（来自[JUnit 5.x][]以支持将测试作为内部类）外，测试用例本身没有太大区别。

public class LoggingConfigurationTest { 
         @Nested 
         @ExtendWith (SpringExtension. class ) 
         @SpringBootTest 
         @DisplayName ( "Logging is enabled, expecting Slf4j logger" ) 
         public static class LoggerEnabledTest { 
             @Autowired private Logger logger;         
             @Test 
             public void loggerShouldBeSlf4j() { 
                 assertThat(logger).isInstanceOf(ch.qos.logback.classic.Logger. class ); 
             } 
         }     
         @Nested 
         @ExtendWith (SpringExtension. class ) 
         @SpringBootTest 
         @TestPropertySource (properties = "logging.enabled=false" ) 
         @DisplayName ( "Logging is disabled, expecting NOOP logger" ) 
         public static class LoggerDisabledTest { 
             @Autowired private Logger logger;         
             @Test 
             public void loggerShouldBeNoop() { 
                 assertThat(logger).isSameAs(NOPLogger.NOP_LOGGER); 
             } 
         }  }

如果您尝试使用[Apache Maven][]和[Maven Surefire插件][Maven Surefire]从命令行运行测试，则可能会惊讶地发现在构建过程中没有执行任何测试。 问题是… [排除了所有嵌套类][Link 4] …因此我们需要采用[另一种解决方法][Link 5] 。

< plugin > 
         < groupId >org.apache.maven.plugins</ groupId > 
         < artifactId >maven-surefire-plugin</ artifactId > 
         < version >2.22.2</ version > 
         < configuration > 
             < excludes > 
                 < exclude /> 
             </ excludes > 
         </ configuration >  </ plugin >

这样，事情应该顺利进行。 但是关于[传统的][8]足够多， [Spring Boot 2.1.x][]可以作为完整的游戏改变者。 上下文运行**程序**家族**ApplicationContextRunner** ， **ReactiveWebApplicationContextRunner**和**WebApplicationContextRunner**提供了一种简单明了的方法来按每个测试方法级别定制上下文，从而使测试的执行速度非常快。

public class LoggingConfigurationTest { 
         private final ApplicationContextRunner runner = new ApplicationContextRunner() 
             .withConfiguration(UserConfigurations.of(LoggingConfiguration. class ));     
         @Test 
         public void loggerShouldBeSlf4j() { 
             runner 
                 .run(ctx -> 
                     assertThat(ctx.getBean(Logger. class )).isInstanceOf(Logger. class ) 
                 ); 
         }     
         @Test 
         public void loggerShouldBeNoop() { 
             runner 
                 .withPropertyValues( "logging.enabled=false" ) 
                 .run(ctx -> 
                     assertThat(ctx.getBean(Logger. class )).isSameAs(NOPLogger.NOP_LOGGER) 
                 ); 
         }  }

看起来真的很棒。 [Spring Boot 2.1.x][]对[JUnit 5.x的][JUnit 5.x]支持要好得多，并且即将推出的**2.2**  发布时， [JUnit 5.x][]将是[默认引擎][Link 6] （不用担心，仍将支持旧的[JUnit 4.x][] ）。 到目前为止，切换到[JUnit 5.x][]需要在依赖项方面进行一些工作。

< dependency > 
         < groupId >org.springframework.boot</ groupId > 
         < artifactId >spring-boot-starter-test</ artifactId > 
         < scope >test</ scope > 
         < exclusions > 
             < exclusion > 
                 < groupId >junit</ groupId > 
                 < artifactId >junit</ artifactId > 
             </ exclusion > 
         </ exclusions >  </ dependency >  < dependency > 
         < groupId >org.junit.jupiter</ groupId > 
         < artifactId >junit-jupiter-api</ artifactId > 
         < scope >test</ scope >  </ dependency >  < dependency > 
         < groupId >org.junit.jupiter</ groupId > 
         < artifactId >junit-jupiter-engine</ artifactId > 
         < scope >test</ scope >  </ dependency >

作为附加步骤，您可能需要使用最新的[Maven Surefire插件][Maven Surefire] （ **2.22.0**或更高版本）以及现成的[JUnit 5.x][]支持。 下面的代码段说明了这一点。

< plugin > 
         < groupId >org.apache.maven.plugins</ groupId > 
         < artifactId >maven-surefire-plugin</ artifactId > 
         < version >2.22.2</ version >  </ plugin >

我们使用的示例配置非常幼稚，许多实际应用程序最终将具有由许多条件构建而成的非常复杂的上下文。 上下文赛跑者带来的灵活性和巨大的机会， [Spring Boot 2.x][Spring Boot 2.1.x]测试脚手架的宝贵补充，只是活泼的救星，请紧记它们。

完整的项目资源可在[Github上找到][Github] 。

> 翻译自: [https://www.javacodegeeks.com/2019/08/testing-spring-boot-conditionals-sane-way.html][https_www.javacodegeeks.com_2019_08_testing-spring-boot-conditionals-sane-way.html]

spring boot测试

[Spring Boot]: https://spring.io/projects/spring-boot
[Link 1]: https://reflectoring.io/spring-boot-conditionals/
[Link 2]: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-developing-auto-configuration.html
[Spring Boot 1.5.x]: https://docs.spring.io/spring-boot/docs/1.5.21.RELEASE/reference/html/
[8]: https://spring.io/blog/2018/07/30/spring-boot-1-x-eol-aug-1st-2019
[Spring Boot 2.1.x]: https://docs.spring.io/spring-boot/docs/2.1.6.RELEASE/reference/html/
[JUnit 4.x]: https://junit.org/junit4/
[JUnit 5.x]: https://junit.org/
[Slf4j]: https://www.slf4j.org/
[Logback]: https://logback.qos.ch/
[Spring Framework]: https://spring.io/projects/spring-framework
[Link 3]: https://docs.spring.io/spring-boot/docs/1.5.21.RELEASE/reference/html/boot-features-testing.html
[spring-test-junit5]: https://github.com/sbrannen/spring-test-junit5
[Apache Maven]: https://maven.apache.org/
[Maven Surefire]: https://maven.apache.org/surefire/maven-surefire-plugin
[Link 4]: https://maven.apache.org/surefire/maven-surefire-plugin/examples/junit-platform.html
[Link 5]: https://junit.org/junit5/docs/current/user-guide/#running-tests-build-maven-filter-test-class-names
[Link 6]: https://github.com/spring-projects/spring-boot/issues/14736
[Github]: https://github.com/reta/spring-boot-testing-conditional
[https_www.javacodegeeks.com_2019_08_testing-spring-boot-conditionals-sane-way.html]: https://www.javacodegeeks.com/2019/08/testing-spring-boot-conditionals-sane-way.html