【Spring MVC】WebClientでGET通信（exchangeToMonoでResponseEntityを取得）

概要

exchangeToMonoメソッドを使用した、基本的なGET通信の使用方法についてまとめた。
今回は指定した型のボディを含むResponseEntityを取得する方法について紹介する。

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

あわせて読みたい

【Spring MVC】WebClientの導入

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

基本的な使い方

exchangeToMonoは、HTTPリクエストを送信してレスポンスからMonoオブジェクトを取得するためのメソッドとなる。
通常はget,post,put,deleteなどのHTTPメソッドと組み合わせて使用する。

exchangeToMonoの引数内でClientResponseを受け取り、ClientResponseオブジェクトを利用してResponseEntityを含むMonoを返却する。

実装方法

getメソッド／exchangeToMonoメソッド／ClientResponseのメソッドを、以下のようにメソッドチェーンで組み合わせて使用する。

①指定した型のボディを含むResponseEntityを取得する場合

②指定した型のリストをボディに含むResponseEntityを取得する場合

このようにexchangeToMonoはリクエスト送信後、レスポンスをClientResponseとして引数で受け取り、その中でボディの処理などを扱うことができる。

使用例

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

APIアクセスクラス

get + exchangeToMono + ClientResponse#toEntityまたは#toEntityListを使用して、GET通信を行う以下のメソッドを追加する。

WebApiClient.java

package com.example.webclient_prototype.biz;

import java.net.URI;
import java.util.List;

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;

/**
 * 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 -> res.toEntity(responseType))
				.block();
	}

	/**
	 * 指定した型のリストをボディに含むResponseEntityを取得する
	 * @param uri
	 * @param responseType
	 * @return
	 */
	public <T> ResponseEntity<List<T>> getEntityList(URI uri, Class<T> responseType) {
		return webClient.get()
				.uri(uri)
				.exchangeToMono(res -> res.toEntityList(responseType))
				.block();
	}
}

ClientResponseをexchangeToMonoの引数内で取得し、ClientResponse#toEntityを呼び出してResponseEntityを含むMonoを取得する。

ClientResponseをexchangeToMonoの引数内で取得し、ClientResponse#toEntityListを呼び出してResponseEntityを含むMonoを取得する。

動作確認

動作確認を行う。

指定した型のボディを含むResponseEntityの取得

シンプルな型のボディを含むResponseEntityを取得する。

動作確認用クラス

// GETリクエスト
ResponseEntity<Resource> resEntity = client
		.getEntity(URI.create("http://localhost:8080/rest_prototype/rest01/1"), Resource.class);

// 動作確認
System.out.println(resEntity.getStatusCode());
System.out.println(resEntity.getHeaders());
System.out.println(resEntity.getBody());

指定したURIに対してGET通信を行い、レスポンスをResponseEntityで取得している。
ResponseEntityのボディ部には、Resourceクラスを指定している。

コンソール

200 OK
[Content-Type:"application/json;charset=UTF-8", Transfer-Encoding:"chunked", Date:"Thu, 19 Jun 2025 23:55:12 GMT"]
Resource(id=1, name=りんご, hogeDate=2025-02-01)

指定した型のリストをボディに含むResponseEntityの取得

リストをボディに含むResponseEntityを取得する。

動作確認用クラス

// GETリクエスト
ResponseEntity<List<Resource>> resEntity = client
		.getEntityList(URI.create("http://localhost:8080/rest_prototype/rest05/"), Resource.class);

// 動作確認
System.out.println(resEntity.getStatusCode());
System.out.println(resEntity.getHeaders());
System.out.println(resEntity.getBody());

指定したURIに対してGET通信を行い、レスポンスをResponseEntityで取得している。
ResponseEntityのボディ部には、リスト<Resource>を指定している。

コンソール

200 OK
[Content-Type:"application/json;charset=UTF-8", Transfer-Encoding:"chunked", Date:"Fri, 20 Jun 2025 00:01:04 GMT"]
[Resource(id=1, name=りんご, hogeDate=2025-02-01), Resource(id=2, name=ごりら, hogeDate=2024-06-05), Resource(id=3, name=らっぱ, hogeDate=2023-05-10)]

まとめ