WebClient와 WebTestClient

WebClient

Spring 5 에서 Non-blocking 방식을 지원하기 위해 제공되었다.
기존 AsyncRestTemplate과 콜백 헬을 벗어나기 위한 CompletableFuture와 다르게 편리하게 구현이 가능하다.
요청자를 Consumer, 제공자를 Producer 로 요청자의 request에 대해 제공자가 API를 제공할 때 HttpClient를 많이 사용한다.
- WebClient 도 HttpClient에 일종
RestTemplate vs WebClient
- 공통점: 둘다 HttpClient모듈
- 차이점: 통신방법이 RestTemplate은 Blocking방식이고, WebClient는 Non-Blocking방식
- RestTemplate
  - Multi-Thread + Blocking 방식
  - 이미지 출처: https://happycloud-lee.tistory.com/220
  - 요청 당 Thread를 할당하여 사용
    - 사용 가능한 Thread가 없는 경우 Queue에서 요청은 대기하게 된다.
- WebClient
  - Single Thread + Non-Blocking 방식
  - Client의 Request는 Event Loop에 등록하고, 이에 대한 결과를 기다리지 않고 다른 작업을 처리한다.
  - Event Loop 는 제공자로부터 callback으로 응답이 오면, 그 결과를 client에게 제공한다.
Reactive Web
- Handler의 Return type이 Mono 또는 Flux이다.
- 요청하는 client가 subscriber이고, 핸들러가 publisher이다.

예시

@RestController
@Slf4j
@RequiredArgsConstructor
public class WebClientExample {
	
	static final String URI1 = "http://localhost:8081/service1?req={req}";
	static final String URI2 = "http://localhost:8081/service2?req={req}";
	
	private final WebClient webClient = WebClient.create();
	private final MyService myService;
	
	@GetMapping("/rest")
	public Mono<String> rest(@RequestParam int index) {
//		Mono<String> body = webClient.get().uri(URI1, index).exchange() // Mono<ClientResponse>
//				.flatMap(clientResponse -> clientResponse.bodyToMono(String.class)) // Mono<String>
//				.flatMap(res1 -> webClient.get().uri(URI2, res1).exchange()) // Mono<ClientResponse>
//				.flatMap(clientResponse -> clientResponse.bodyToMono(String.class)) // Mono<String>
// 				.flatMap(res2 -> Mono.fromCompletionStage(myService.work(res2))); // CompletableFuture<String> -> Mono<String>
		
                // exchange()가 deprecated 되어 다시 작성
		Mono<String> body = webClient.get().uri(URI1, index)
				.exchangeToMono(clientResponse -> clientResponse.bodyToMono(String.class))
				.flatMap(res1 -> webClient.get().uri(URI2, res1)
						.exchangeToMono(clientResponse -> clientResponse.bodyToMono(String.class)))
				.flatMap(res2 -> Mono.fromCompletionStage(myService.work(res2)));  
		
		return body;
	}
	
	@Service
	public static class MyService {
		@Async
		public CompletableFuture<String> work(String req) {
			return CompletableFuture.completedFuture(req + "/asyncValue");
		}
	}
}

@SpringBootApplication
public class AnotherServiceApplication {
	
	@RestController
	public static class anotherController {
		
		@GetMapping("/service1")
		public String service1(@RequestParam String req) {
			return "service1 : " + req;
		}
		
		@GetMapping("/service2")
		public String service2(@RequestParam String req) {
			return "service2 : " + req;
		}
	}
	
	public static void main(String[] args) {
		System.setProperty("server.port", "8081");
		System.setProperty("server.tomcat.threads.max", "1");
		
		SpringApplication.run(AnotherServiceApplication.class, args);
	}

}

WebTestClient

WebTestClient
- 여러 API 를 호출하는 WebClient를 사용하는 서버를 테스트할 때 사용한다
- HTTP 서버를 연결하거나 WebFlux 를 사용하는 어플리케이션에 대하여 mock request, response를 테스트할 때 사용한다.
WEBTESTCLIENT_REQUEST_ID
- WebTestClient를 통해 수행하는 모든 아이디에 대하여 unique id가 할당되어야 한다.
- 이는 요청 처리의 모든 단계(예: 서버 측 구성 요소에서)에서 해당 ID로 컨텍스트 정보를 저장하고 나중에 ExchangeResult를 사용할 수 있게 되면 해당 정보를 조회하는 데 유용하다.
bindToXxx Method
- bindToController: @Controller 애노테이션에 컨트롤러를 테스트하는 WebTestClient를 생성할 수 있다. HTTP 서버 없이 테스트할 수 있다.
```
WebTestClient testClient = WebTestClient.bindToController(new TestController()).build();
```
- bindToServer: 실행중인 Server 연결하여 테스트할 수 있다.
```
WebTestClient testClient = WebTestClient.bindToServer().baseUrl("http://localhost:8080").build();
```

Writing Tests

요청에 대한 세팅 후 exchange() 메소드를 통해 응답에 대한 테스트를 진행한다.

예제

client.get().uri("/persons/1")
	.accept(MediaType.APPLICATION_JSON)
	.exchange()
	.expectStatus().isOk()
	.expectHeader().contentTyp(MediaType.APPLICATION_JSON);

Response Body 확인
- expectBody(Class): single object
- expectBodyList(Class): list와 같은 컬렉션 객체
- expectBody(): byte[] 또는 empty body
```
client.get().uri("/persons")
	.exchange()
	.expectBodyList(Person.class).hasSize(3).contains(person);
```
- returnResult(): 조회한 객체를 받아올 수 있다.
- Viod.class 를 통해 빈 객체를 확인할 수 있다.

Json

expectBody() 를 통해 byte[]를 받아온다.

json(), jsonPath()를 활용한다

client.get().uri("/persons/1")
	.exchange()
  .expectStatus().isOk()
  .expectBody()
  .json("{\"name\":\"Jane\"}");
      
client.get().uri("/persons")
	.exchange()
	.expectStatus().isOk()
 	.expectBody()
	.jsonPath("$[0].name").isEqualTo("Jane")
	.jsonPath("$[1].name").isEqualTo("Jason");

Spring Boot Test

Mock Test

@ExtendWith(SpringExtension.class)
@WebFluxTest(controllers = ItemFluxController.class)
@Import({ItemFluxService.class, ItemFluxRepository.class})
class ItemFluxControllerMockTest {  
	@MockBean ItemFluxRepository itemFluxRepository;
	@MockBean ItemFluxService itemFluxService;
	@Autowired WebTestClient webTestClient;
}

Test 하는 ItemFluxController에 대하여 Mock으로 사용하는 Service, Repository를 @MockBean으로 등록하여 사용가능

Mockito 등을 활용하여 MockBean에 대한 값들을 세팅할 수 있다.

Mockito.when(itemFluxService.findAll()).thenReturn(Flux.fromIterable(items));
webTestClient.get()
	.uri("/webflux/items")
	.accept(MediaType.valueOf(MediaType.APPLICATION_JSON_VALUE))
	.exchange()
	.expectStatus().isOk()
	.expectBody()
	.jsonPath("$[0].name").isEqualTo("test1");

Random Port Test

@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@AutoConfigureWebFlux
public class ItemFluxControllerUnitTest {
	@Autowired WebTestClient webTestClient;
	@Autowired ItemFluxRepository itemFluxRepository;
	// ...
}

출처

토비의 봄 TV 12회 스프링 리액티프 프로그래밍(8) - WebFlux
https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/test/web/reactive/server/WebTestClient.html
https://happycloud-lee.tistory.com/220
https://spring.getdocs.org/en-US/spring-framework-docs/docs/testing/integration-testing/webtestclient.html