Spring boot Webflux에서 block 찾기

Webflux로 개발하는 경우 block가 있으면 성능이 현저하게 낮아 집니다.

따라서 개발 후에 개발한 코드에 Block을 발생 시키는 코드가 있는지 확인하는 것은 중요합니다.

이것을 도와 주는 라이브러리가 Blockhound 입니다.

1. 의존성 추가

testImplementation('org.springframework.boot:spring-boot-starter-test')
testImplementation 'io.projectreactor:reactor-test'
testImplementation 'io.projectreactor.tools:blockhound:1.0.6.RELEASE'
testImplementation 'io.projectreactor.tools:blockhound-junit-platform:1.0.6.RELEASE'

Blockhound를 사용하면 Block을 발생시키는 곳에서 에러를 발생시킵니다. 따라서 운영 환경에서는 사용을 피해야 합니다. 테스트 환경에서 사용하는 것을 추천 드립니다.

2. 샘플 라우터 작성

@Configuration
public class BlockingRouter {

   @Bean
   public RouterFunction<ServerResponse> blockRouter() {
      return RouterFunctions.route(RequestPredicates.GET("/nonBlock").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), request -> {
         return ServerResponse.ok().body(Mono.just("nonblock response"), String.class);
      }).andRoute(RequestPredicates.GET("/block").and(RequestPredicates.accept(MediaType.APPLICATION_JSON)), request -> {
         block();   // 직접 block
         return ServerResponse.ok().body(Mono.just("block response"), String.class);
      });
   }

   private void block() {
      try {
         Thread.sleep(1000);
      } catch (InterruptedException e) {
         Thread.currentThread().interrupt();
      }
   }
}

3. 테스트 코드 작성

@SpringBootTest
@AutoConfigureWebTestClient
@Slf4j
public class BlockHoundTest {

   @Autowired
   private WebTestClient webTestClient;

   @Test
   public void nonBlockCallTest() {
      webTestClient.get().uri("/nonBlock").exchange().expectStatus().isOk();
      log.info("Calling nonblock request  is succeeded");
   }

   /**
    *
    * blockhound 라이브러리에서 block이 있는 경우에 에러를 발생시킴
    */
   @Test
   public void blockCallTest() {
      webTestClient.get().uri("/block").exchange().expectStatus().isOk();
   }
}

의존성이 추가 된 경우 추가 설정을 하지 않아도 Blockhound가 자동으로 동작합니다.

4. 테스트 수행 결과

blockCallTest의 경우 thread.sleep에서 block가 발생하므로 테스트 코드가 실패합니다.

샘플 코드

https://github.com/withccm/spring-webflux-study/tree/feature/blockhound-test

참조

https://devahea.github.io/2019/04/21/Spring-WebFlux%EB%8A%94-%EC%96%B4%EB%96%BB%EA%B2%8C-%EC%A0%81%EC%9D%80-%EB%A6%AC%EC%86%8C%EC%8A%A4%EB%A1%9C-%EB%A7%8E%EC%9D%80-%ED%8A%B8%EB%9E%98%ED%94%BD%EC%9D%84-%EA%B0%90%EB%8B%B9%ED%95%A0%EA%B9%8C/