Spring、Spring Boot和TestNG測試指南 - 測試@Configuration

_DangJin 發(fā)布于2019-08-16 10:44 / 2537人閱讀

Github地址

在Spring引入Java Config機(jī)制之后，我們會(huì)越來越多的使用@Configuration來注冊(cè)Bean，并且Spring Boot更廣泛地使用了這一機(jī)制，其提供的大量Auto Configuration大大簡化了配置工作。那么問題來了，如何確保@Configuration和Auto Configuration按照預(yù)期運(yùn)行呢，是否正確地注冊(cè)了Bean呢？本章舉例測試@Configuration和Auto Configuration的方法（因?yàn)锳uto Configuration也是@Configuration，所以測試方法是一樣的）。

例子1：測試@Configuration

我們先寫一個(gè)簡單的@Configuration：

@Configuration
public class FooConfiguration {

  @Bean
  public Foo foo() {
    return new Foo();
  }

}

然后看FooConfiguration是否能夠正確地注冊(cè)Bean：

public class FooConfigurationTest {

  private AnnotationConfigApplicationContext context;

  @BeforeMethod
  public void init() {
    context = new AnnotationConfigApplicationContext();
  }

  @AfterMethod(alwaysRun = true)
  public void reset() {
    context.close();
  }

  @Test
  public void testFooCreation() {
    context.register(FooConfiguration.class);
    context.refresh();
    assertNotNull(context.getBean(Foo.class));
  }

}

注意上面代碼中關(guān)于Context的代碼：

首先，我們構(gòu)造一個(gè)Context

然后，注冊(cè)FooConfiguration

然后，refresh Context

最后，在測試方法結(jié)尾close Context

如果你看Spring Boot中關(guān)于@Configuration測試的源代碼會(huì)發(fā)現(xiàn)和上面的代碼有點(diǎn)不一樣：

public class DataSourceAutoConfigurationTests {

    private final AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();

    @Before
    public void init() {
        EmbeddedDatabaseConnection.override = null;
        EnvironmentTestUtils.addEnvironment(this.context,
                "spring.datasource.initialize:false",
                "spring.datasource.url:jdbc:hsqldb:mem:testdb-" + new Random().nextInt());
    }

    @After
    public void restore() {
        EmbeddedDatabaseConnection.override = null;
        this.context.close();
    }

這是因?yàn)镾pring和Spring Boot都是用JUnit做測試的，而JUnit的特性是每次執(zhí)行測試方法前，都會(huì)new一個(gè)測試類實(shí)例，而TestNG是在共享同一個(gè)測試類實(shí)例的。

例子2：測試@Conditional

Spring Framework提供了一種可以條件控制@Configuration的機(jī)制，即只在滿足某條件的情況下才會(huì)導(dǎo)入@Configuration，這就是@Conditional。

下面我們來對(duì)@Conditional做一些測試，首先我們自定義一個(gè)Condition FooConfiguration：

@Configuration
public class FooConfiguration {

  @Bean
  @Conditional(FooCondition.class)
  public Foo foo() {
    return new Foo();
  }

  public static class FooCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
      if (context.getEnvironment() != null) {
        Boolean property = context.getEnvironment().getProperty("foo.create", Boolean.class);
        return Boolean.TRUE.equals(property);
      }
      return false;
    }

  }
}

該Condition判斷Environment中是否有foo.create=true。

如果我們要測試這個(gè)Condition，那么就必須往Environment里添加相關(guān)property才可以，在這里我們測試了三種情況：

沒有配置foo.create=true

配置foo.create=true

配置foo.create=false

FooConfigurationTest：

public class FooConfigurationTest {

  private AnnotationConfigApplicationContext context;

  @BeforeMethod
  public void init() {
    context = new AnnotationConfigApplicationContext();
  }

  @AfterMethod(alwaysRun = true)
  public void reset() {
    context.close();
  }

  @Test(expectedExceptions = NoSuchBeanDefinitionException.class)
  public void testFooCreatePropertyNull() {
    context.register(FooConfiguration.class);
    context.refresh();
    context.getBean(Foo.class);
  }

  @Test
  public void testFooCreatePropertyTrue() {
    context.getEnvironment().getPropertySources().addLast(
        new MapPropertySource("test", Collections.singletonMap("foo.create", "true"))
    );
    context.register(FooConfiguration.class);
    context.refresh();
    assertNotNull(context.getBean(Foo.class));
  }

  @Test(expectedExceptions = NoSuchBeanDefinitionException.class)
  public void testFooCreatePropertyFalse() {
    context.getEnvironment().getPropertySources().addLast(
        new MapPropertySource("test", Collections.singletonMap("foo.create", "false"))
    );
    context.register(FooConfiguration.class);
    context.refresh();
    assertNotNull(context.getBean(Foo.class));
  }

}

注意我們用以下方法來給Environment添加property：

context.getEnvironment().getPropertySources().addLast(
  new MapPropertySource("test", Collections.singletonMap("foo.create", "true"))
);

所以針對(duì)@Conditional和其對(duì)應(yīng)的Condition的測試的根本就是給它不一樣的條件，判斷其行為是否正確，在這個(gè)例子里我們的Condition比較簡單，只是判斷是否存在某個(gè)property，如果復(fù)雜Condition的話，測試思路也是一樣的。

例子3：測試@ConditionalOnProperty

Spring framework只提供了@Conditional，Spring boot對(duì)這個(gè)機(jī)制做了擴(kuò)展，提供了更為豐富的@ConditionalOn*，這里我們以@ConditionalOnProperty舉例說明。

先看FooConfiguration：

@Configuration
public class FooConfiguration {

  @Bean
  @ConditionalOnProperty(prefix = "foo", name = "create", havingValue = "true")
  public Foo foo() {
    return new Foo();
  }

}

FooConfigurationTest：

public class FooConfigurationTest {

  private AnnotationConfigApplicationContext context;

  @BeforeMethod
  public void init() {
    context = new AnnotationConfigApplicationContext();
  }

  @AfterMethod(alwaysRun = true)
  public void reset() {
    context.close();
  }

  @Test(expectedExceptions = NoSuchBeanDefinitionException.class)
  public void testFooCreatePropertyNull() {
    context.register(FooConfiguration.class);
    context.refresh();
    context.getBean(Foo.class);
  }

  @Test
  public void testFooCreatePropertyTrue() {
    EnvironmentTestUtils.addEnvironment(context, "foo.create=true");
    context.register(FooConfiguration.class);
    context.refresh();
    assertNotNull(context.getBean(Foo.class));
  }

  @Test(expectedExceptions = NoSuchBeanDefinitionException.class)
  public void testFooCreatePropertyFalse() {
    EnvironmentTestUtils.addEnvironment(context, "foo.create=false");
    context.register(FooConfiguration.class);
    context.refresh();
    assertNotNull(context.getBean(Foo.class));
  }

}

這段測試代碼和例子2的邏輯差不多，只不過例子2里使用了我們自己寫的Condition，這里使用了Spring Boot提供的@ConditionalOnProperty。

并且利用了Spring Boot提供的EnvironmentTestUtils簡化了給Environment添加property的工作：

EnvironmentTestUtils.addEnvironment(context, "foo.create=false");

例子4：測試Configuration Properties

Spring Boot還提供了類型安全的Configuration Properties，下面舉例如何對(duì)其進(jìn)行測試。

BarConfiguration：

@Configuration
@EnableConfigurationProperties(BarConfiguration.BarProperties.class)
public class BarConfiguration {

  @Autowired
  private BarProperties barProperties;

  @Bean
  public Bar bar() {
    return new Bar(barProperties.getName());
  }

  @ConfigurationProperties("bar")
  public static class BarProperties {

    private String name;

    public String getName() {
      return name;
    }

    public void setName(String name) {
      this.name = name;
    }
  }

}

BarConfigurationTest：

public class BarConfigurationTest {

  private AnnotationConfigApplicationContext context;

  @BeforeMethod
  public void init() {
    context = new AnnotationConfigApplicationContext();
  }

  @AfterMethod(alwaysRun = true)
  public void reset() {
    context.close();
  }

  @Test
  public void testBarCreation() {
    EnvironmentTestUtils.addEnvironment(context, "bar.name=test");
    context.register(BarConfiguration.class, PropertyPlaceholderAutoConfiguration.class);
    context.refresh();
    assertEquals(context.getBean(Bar.class).getName(), "test");
  }

}

注意到因?yàn)槲覀兪褂昧薈onfiguration Properties機(jī)制，需要注冊(cè)PropertyPlaceholderAutoConfiguration，否則在BarConfiguration里無法注入BarProperties。

參考文檔

Conditionally include @Configuration classes or @Bean methods

Condition annotations

Type-safe Configuration Properties

Spring Framework Testing

Spring Boot Testing

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://m.hztianpu.com/yun/70351.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

_DangJin

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

離線安裝tensorflow

閱讀 2491·2023-04-25 19:27
基于javaweb+jsp的醫(yī)院信息管理系統(tǒng)

閱讀 3569·2021-11-24 09:39
ReadyDedis：印度VPS更換為NVMe硬盤，7美元/月起，支持支付寶

閱讀 3983·2021-10-08 10:17
sass的基本使用

閱讀 3459·2019-08-30 13:48
A Beginner’s Introduction to CSS Animation中文版

閱讀 2010·2019-08-29 12:26
10條簡化工作的HTML5代碼段

閱讀 3183·2019-08-28 17:52
Vue+Express+mysql(mongodb)+Vue全家桶架構(gòu)

閱讀 3596·2019-08-26 14:01
深入理解ES6筆記（五）解構(gòu)：使訪問數(shù)據(jù)更便捷

閱讀 3595·2019-08-26 12:19

成人无码视频,亚洲精品久久久久av无码,午夜精品久久久久久毛片,亚洲中文字幕日韩无码

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！

Spring、Spring Boot和TestNG測試指南 - 測試@Configuration

相關(guān)文章

Spring、Spring Boot和TestNG測試指南 - @OverrideAutoConfi

Spring、Spring Boot和TestNG測試指南 - 使用Spring Testing工具

Spring、Spring Boot和TestNG測試指南 - 使用Spring Boot Test

Spring、Spring Boot和TestNG測試指南 - 共享測試配置

Spring、Spring Boot和TestNG測試指南 - @TestConfiguration

發(fā)表評(píng)論

0條評(píng)論

_DangJin

男|高級(jí)講師

TA的文章

離線安裝tensorflow

基于javaweb+jsp的醫(yī)院信息管理系統(tǒng)

ReadyDedis：印度VPS更換為NVMe硬盤，7美元/月起，支持支付寶

sass的基本使用

A Beginner’s Introduction to CSS Animation中文版

10條簡化工作的HTML5代碼段

Vue+Express+mysql(mongodb)+Vue全家桶架構(gòu)

深入理解ES6筆記（五）解構(gòu)：使訪問數(shù)據(jù)更便捷

最新活動(dòng)

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！

Spring、Spring Boot和TestNG測試指南 - 測試@Configuration

相關(guān)文章

發(fā)表評(píng)論

0條評(píng)論

男|高級(jí)講師

TA的文章

最新活動(dòng)

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！

Spring、Spring Boot和TestNG測試指南 - 測試@Configuration