Spring RestTemplate のリクエストとレスポンスをトレースする方法: 包括的なガイド

Spring RestTemplate のリクエストとレスポンスのトレース: 総合ガイド

Spring RestTemplate のリクエストとレスポンスのデバッグは、複雑な作業となる場合があります。この記事では、この課題を克服するための効果的なソリューションを検討し、完全なロギングとデバッグ機能を有効にする包括的なアプローチを提供します。

強化されたロギングの必要性

「冗長」でカールを使用するのとは対照的にSpring RestTemplate オプションでは、多くの場合、リクエストとレスポンスの詳細について限定的な洞察が提供されます。この可視性の欠如により、効率的なデバッグとトラブルシューティングが妨げられます。

ClientHttpRequestInterceptor によるカスタマイズ

この問題に対処するために、Spring Web Client と RestTemplate は ClientHttpRequestInterceptor インターフェイスを提供します。このインターフェイスを実装することで、開発者は送信リクエストと受信レスポンスの両方をトレースする機能など、RestTemplate インスタンスの動作をカスタマイズできます。

実際的な実装

ClientHttpRequestInterceptor を実装するには、次の点を考慮してください。例:

import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.ClientHttpResponse;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LoggingRequestInterceptor implements ClientHttpRequestInterceptor {

    final static Logger log = LoggerFactory.getLogger(LoggingRequestInterceptor.class);

    @Override
    public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) throws IOException {
        traceRequest(request, body);
        ClientHttpResponse response = execution.execute(request, body);
        traceResponse(response);
        return response;
    }

    private void traceRequest(HttpRequest request, byte[] body) throws IOException {
        log.info("===========================request begin================================================");
        log.debug("URI         : {}", request.getURI());
        log.debug("Method      : {}", request.getMethod());
        log.debug("Headers     : {}", request.getHeaders() );
        log.debug("Request body: {}", new String(body, "UTF-8"));
        log.info("==========================request end================================================");
    }

    private void traceResponse(ClientHttpResponse response) throws IOException {
        StringBuilder inputStringBuilder = new StringBuilder();
        BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(response.getBody(), "UTF-8"));
        String line = bufferedReader.readLine();
        while (line != null) {
            inputStringBuilder.append(line);
            inputStringBuilder.append('\n');
            line = bufferedReader.readLine();
        }
        log.info("============================response begin==========================================");
        log.debug("Status code  : {}", response.getStatusCode());
        log.debug("Status text  : {}", response.getStatusText());
        log.debug("Headers      : {}", response.getHeaders());
        log.debug("Response body: {}", inputStringBuilder.toString());
        log.info("=======================response end=================================================");
    }

}

インターセプターの使用とBuffering

インターセプターを利用するには、BufferingClientHttpRequestFactory を使用して RestTemplate をインスタンス化し、次のように LoggingRequestInterceptor を登録します。

RestTemplate restTemplate = new RestTemplate(new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory()));
List<ClientHttpRequestInterceptor> interceptors = new ArrayList<>();
interceptors.add(new LoggingRequestInterceptor());
restTemplate.setInterceptors(interceptors);

応答の複数の読み取りを有効にするために BufferingClientHttpRequestFactory が必要です。 body.

結論

ClientHttpRequestInterceptor を実装することで、Spring RestTemplate のデバッグ機能を強化できます。この記事で説明する例では、リクエストとレスポンスの両方を追跡する方法を示し、通信プロセスについての包括的な洞察を提供します。このアプローチにより、トラブルシューティングが簡素化され、開発および保守タスクの効率が向上します。

以上がSpring RestTemplate のリクエストとレスポンスをトレースする方法: 包括的なガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。