java - 如何记录 Spring 5 WebClient 调用

Question

我正在尝试使用 Spring 5 WebClient 记录请求。你知道我怎么能做到这一点吗？

(我使用的是 Spring 5 和 Spring Boot 2)

现在的代码是这样的:

try {
    return webClient.get().uri(url, urlParams).exchange().flatMap(response -> response.bodyToMono(Test.class))
            .map(test -> xxx.set(test));
} catch (RestClientException e) {
    log.error("Cannot get counter from opus", e);
    throw e;
}

Answer 1

您可以使用 ExchangeFilterFunction 轻松做到这一点

当您使用 WebClient.Builder 创建 WebClient 时，只需添加自定义 logRequest 过滤器。

这里是这种过滤器的示例以及如何将其添加到 WebClient。

@Slf4j
@Component
public class MyClient {

    private final WebClient webClient;

    // Create WebClient instance using builder.
    // If you use spring-boot 2.0, the builder will be autoconfigured for you
    // with the "prototype" scope, meaning each injection point will receive
    // a newly cloned instance of the builder.
    public MyClient(WebClient.Builder webClientBuilder) {
        webClient = webClientBuilder // you can also just use WebClient.builder()
                .baseUrl("https://httpbin.org")
                .filter(logRequest()) // here is the magic
                .build();
    }

    // Just example of sending request. This method is NOT part of the answer
    public void send(String path) {
        ClientResponse clientResponse = webClient
                .get().uri(uriBuilder -> uriBuilder.path(path)
                        .queryParam("param", "value")
                        .build())
                .exchange()
                .block();
        log.info("Response: {}", clientResponse.toEntity(String.class).block());
    }

    // This method returns filter function which will log request data
    private static ExchangeFilterFunction logRequest() {
        return ExchangeFilterFunction.ofRequestProcessor(clientRequest -> {
            log.info("Request: {} {}", clientRequest.method(), clientRequest.url());
            clientRequest.headers().forEach((name, values) -> values.forEach(value -> log.info("{}={}", name, value)));
            return Mono.just(clientRequest);
        });
    }

}

然后只需调用 myClient.send("get"); 并且日志消息应该在那里。

输出示例:

Request: GET https://httpbin.org/get?param=value
header1=value1
header2=value2

编辑

有些人在评论中指出 block() 是不好的做法等。我想澄清一下:block() 在这里调用只是用于演示目的。请求日志过滤器无论如何都会起作用。您无需将 block() 添加到代码中即可使 ExchangeFilterFunction 工作。您可以使用 WebClient 以通常的方式执行 http 调用，链接方法并在堆栈中返回 Mono 直到有人订阅它。答案中唯一相关的部分是 logRequest() 过滤器。您可以完全忽略 send() 方法 - 它不是解决方案的一部分 - 它只是演示过滤器的工作原理。

有些人还问如何记录响应。要记录响应，您可以编写另一个 ExchangeFilterFunction 并将其添加到 WebClient。您可以使用ExchangeFilterFunction.ofResponseProcessor用于此目的的 helper 与使用 ExchangeFilterFunction.ofRequestProcessor 的方式相同。您可以使用ClientResponse的方法获取 header /cookie 等。

    // This method returns filter function which will log response data
    private static ExchangeFilterFunction logResponse() {
        return ExchangeFilterFunction.ofResponseProcessor(clientResponse -> {
            log.info("Response status: {}", clientResponse.statusCode());
            clientResponse.headers().asHttpHeaders().forEach((name, values) -> values.forEach(value -> log.info("{}={}", name, value)));
            return Mono.just(clientResponse);
        });
    }

别忘了把它添加到你的WebClient:

.filter(logResponse())

但要小心，不要试图在过滤器中读取响应正文。由于它的流性质，主体只能被消耗一次，而无需某种缓冲包装器。因此，如果您将在过滤器中阅读它，您将无法在订阅者中阅读它。

如果你真的需要记录body，你可以让底层(Netty)来做这个。见 Matthew Buckett's answer得到这个想法。