【Spring MVC】WebClientでGET通信（exchangeToMonoでハンドリング）

概要

exchangeToMonoメソッドを使用した、基本的なGET通信の使用方法についてまとめた。
今回はリクエスト送信後に意図しないレスポンスを受け取った際のハンドリング方法について紹介する。

尚、動作確認を行うための事前準備については、以下に記載している。

あわせて読みたい

【Spring MVC】WebClientの導入

概要 RESTなAPIにアクセスするのはRestTemplateではなくWebClientが今後推奨となるため、WebClientの概要についてまとめた。 WebClientを使用するための準備と、どんなメソッドがあるのかを紹介している[…]

基本的な使い方

WebClient#retrieveにてリクエスト送信した際には、都度ResponseSpec#onStatusを呼び出してステータスハンドリングを行っていた。
WebClient#exchangeToMonoでは、引数でClientResponseを取得できるため、ステータス以外にも用途に応じて柔軟なエラー判定を実装できる。

ClientResponse

exchangeToMonoでリクエスト送信後、ClientResponseを使用して以下のような情報を取得できる。

実装方法

ClientResponseを使用した、レスポンス結果の各種ハンドリング方法について紹介する。

ステータスハンドリング

4xx系と5xx系の場合はエラーとしたいとき。

ヘッダーハンドリング

レスポンスのコンテンツがJSONではない場合にエラーとしたいとき。

ボディハンドリング

レスポンスボディに”error”を含む場合にエラーとしたいとき。
※その他の場所の解説は割愛

使用例

APIアクセスクラスにメソッドを追加して動作確認を行う。

APIアクセスクラス

get + exchangeToMono + ClientResponseを使用して、ステータスハンドリング付きのGET通信を行うメソッドを追加する。
処理の流れとしては2xx系以外のステータスが返却された場合、例外をスローする。

WebApiClient.java

package com.example.webclient_prototype.biz;

import java.net.URI;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.reactive.function.client.WebClient;

import com.example.webclient_prototype.exception.ClientErrorException;
import com.example.webclient_prototype.exception.ServerErrorException;
import com.example.webclient_prototype.exception.UnknownErrorException;
import com.example.webclient_prototype.resource.error.ApiErrorInfo;

import reactor.core.publisher.Mono;

/**
 * WebClientを使用したAPI疎通クラス
 */
@Component
public class WebApiClient {

	@Autowired
	private WebClient webClient;

	/**
	 * 指定した型のボディを含むResponseEntityを取得する
	 * 
	 * @param uri
	 * @param responseType
	 * @return
	 */
	public <T> ResponseEntity<T> getEntity(URI uri, Class<T> responseType) {
		return webClient.get().uri(uri).exchangeToMono(res -> {
			if (res.statusCode().is4xxClientError()) {
				// 4xx系ステータス
				return res.bodyToMono(ApiErrorInfo.class).flatMap(body -> Mono
						.error(new ClientErrorException(body.getErrorTitle(), body.getErrorMsg(), body.getStatus())));
			} else if (res.statusCode().is5xxServerError()) {
				// 5xx系ステータス
				return res.bodyToMono(ApiErrorInfo.class)
						.flatMap(body -> Mono.error(new ServerErrorException(body.getErrorMsg())));
			} else if (!res.statusCode().is2xxSuccessful()) {
				// 2xx, 4xx, 5xx以外の想定外ステータス
				return Mono.error(new UnknownErrorException("想定外エラー"));
			}
			// 2xx系の処理
			return res.toEntity(responseType);
		}).block();
	}
}

exchangeToMonoの引数に取得したClientResponseを用いて、任意のステータスハンドリングを行っている。

ClientResponseが保持するレスポンスボディ情報を、APIエラー情報クラスにバインドしている。

「Mono.error( … )」とすることで、例外オブジェクトを保持するMonoクラスを生成し、block()が呼ばれたタイミングでMonoが保持する例外がスローされる。
上記は、ClientResponseから必要な情報を取得して自作例外オブジェクトを生成している。

動作確認

動作確認を行う。

動作確認用クラス

try {
	// GETリクエスト（400エラー発生）
	client.getEntity(URI.create("http://localhost:8080/rest_prototype/rest06/?hogeDate=2025-02-01"), Resource.class);

} catch (ClientErrorException e) {
	// 動作確認
	System.out.println(e);
}

APIアクセスクラスに定義したメソッドにより、4xx系ステータスが返却された場合はClientErrorExceptionがスローされる。

コンソール

ClientErrorException(status=400, title=入力エラー, detailMessage=入力に誤りあり)

まとめ