WebClientでXML＋APIエラー時の特定条件でのRetryを定義する

はじめに

WebClient基礎

WebClient (Spring Framework 6.0.7 API) - Javadoc

Spring Boot の概要から各機能の詳細までが網羅された公式リファレンスドキュメントです。開発者が最初に読むべきドキュメントです。

https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/function/client/WebClient.html

【WebClient】コピペで使える実装集

WebClientを使ったアプリケーションを本番運用するために意識しておきたい設定とその設定方法をまとめてみました。 自分の現場で意識していることが中心になりますが、コピペでそのまま本番アプリケーションに使うようなコード ...

https://hirabay.net/?p=214

@Bean
public WebClient webClient(MetricsWebClientCustomizer metricsWebClientCustomizer) {
    var connectionProvider = ConnectionProvider.builder("sample")
            .maxConnections(100) // コネクションプール数
            .maxIdleTime(Duration.ofSeconds(59))  // keep aliveタイムアウト
            .metrics(true) // コネクション数のメトリクスを有効化
            .build();

    var httpClient = HttpClient.create(connectionProvider)
            .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 1_000) // connection timeout
            .responseTimeout(Duration.ofMillis(500)); // read timeout

    return WebClient.builder()
            .clientConnector(new ReactorClientHttpConnector(httpClient))
            .baseUrl("http://localhost:8080")
            .apply(metricsWebClientCustomizer::customize)  // http clientのメトリクスを収集
            .build();
}

XMLのレスポンスをDecodeしたいときはどうすれば良い？

return WebClient.builder()
                .baseUrl("http://localhost:8080")
                // xmlのエンコード・デコーダをセット
                .exchangeStrategies(ExchangeStrategies.builder()
                        .codecs((conf) -> {
                            conf.defaultCodecs().jaxb2Encoder(new Jaxb2XmlEncoder());
                            conf.defaultCodecs().jaxb2Decoder(new Jaxb2XmlDecoder());
                        })
                        .build())

Jaxb2XmlEncoder (Spring Framework 6.0.7 API) - Javadoc

Spring Boot の概要から各機能の詳細までが網羅された公式リファレンスドキュメントです。開発者が最初に読むべきドキュメントです。

https://spring.pleiades.io/spring-framework/docs/current/javadoc-api/org/springframework/http/codec/xml/Jaxb2XmlEncoder.html

エラー時の挙動設定

XMLをParseする対象のObject class

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "Error")
public class APIErrorResponse {

    @XmlElement(name = "Code")
    private String code;
    @XmlElement(name = "Message")
    private String message;
}

onStatusで特定の場合にオリジナルなExceptionを起こす

StatusRetryExceptionは適当に用意が必要です。

webClient.post()
         .uri(UriBuilder::build)
         .contentType(MediaType.APPLICATION_XML)
         .bodyValue(request)
         .retrieve()
         .retryWhen(getRetryPolicy())
         .onStatus(HttpStatus::isError, clientResponse -> clientResponse.bodyToMono(APIErrorResponse.class)
                .flatMap(error -> {
                    log.error("Error failed by errorCode={}, message={}", error.getCode(), error.getMessage());

                    // 特定コードだった場合にRetryを行うためにExceptionを引き起こす
                    if (List.of("ERR-01", "ERR-02").contains(error.getCode())) {
                        return Mono.error(StatusRetryException::new);
                    }
                    return Mono.error(Exception::new);
                }));

Retry処理の追加

public Retry getRetryPolicy() {
        return Retry
                .backoff(2, Duration.ofMillis(500))
                // 特定ステータスのときはRetryする
                .filter(error -> error instanceof StatusRetryException)
                .onRetryExhaustedThrow((spec, rs) -> rs.failure());
}

最後に