Add Exception handler for Spring Web Client
Asked Answered
L

1

18

I use this code for REST API requests.

WebClient.Builder builder = WebClient.builder().baseUrl(gatewayUrl);
ClientHttpConnector httpConnector = new ReactorClientHttpConnector(opt -> opt.sslContext(sslContext));
builder.clientConnector(httpConnector);

How I can add connection exception handler? I would like to implement some custom logic? Is this feature easy to implement?

Lorikeet answered 2/7, 2018 at 15:21 Comment(1)
Possible duplicate of Set connection timeout using Spring Webflux Reactive WebClientBlakely
S
27

If I understand your question in the context of failing the connection because of SSL credentials, then you should see the connection exception manifest itself on the REST response. You can take care of that exception via the Flux result you get on WebClient.ResponseSpec#onStatus. The docs for #onStatus says:

Register a custom error function that gets invoked when the given HttpStatus predicate applies. The exception returned from the function will be returned from bodyToMono(Class) and bodyToFlux(Class). By default, an error handler is register that throws a WebClientResponseException when the response status code is 4xx or 5xx.

Take a look at this example:

Mono<Person> result = client.get()
            .uri("/persons/{id}", id).accept(MediaType.APPLICATION_JSON)
            .retrieve()
            .onStatus(HttpStatus::is4xxServerError, response -> ...) // This is in the docs there but is wrong/fatfingered, should be is4xxClientError
            .onStatus(HttpStatus::is5xxServerError, response -> ...)
            .bodyToMono(Person.class);

Similarly for your question, the connection error should manifest itself after the call gets made and you can customize how it gets propogated in the reactive pipeline:

Mono<Person> result = client.get()
            .uri("/persons/{id}", id).accept(MediaType.APPLICATION_JSON)
            .retrieve()
            .onStatus(HttpStatus::is4xxClientError, response -> {
                 ... Code that looks at the response more closely...
                 return Mono.error(new MyCustomConnectionException());
             })
            .bodyToMono(Person.class);

Hope that helps.

Synod answered 6/7, 2018 at 3:39 Comment(2)
How can we log the response also here?Along with exception?Spear
@Spear , I think you either need to use .exchange() or instead of .retrieve() or to implement a global error handler to catch the exceptions and log them, before re-throwing them if wanted.Grot

© 2022 - 2024 — McMap. All rights reserved.