48

我想在带有 Kotlin 的 Spring WebFlux 上的 REST API 中集中记录请求和响应。到目前为止，我已经尝试过这种方法

@Bean
fun apiRouter() = router {
    (accept(MediaType.APPLICATION_JSON) and "/api").nest {
        "/user".nest {
            GET("/", userHandler::listUsers)
            POST("/{userId}", userHandler::updateUser)
        }
    }
}.filter { request, next ->
    logger.info { "Processing request $request with body ${request.bodyToMono<String>()}" }
    next.handle(request).doOnSuccess { logger.info { "Handling with response $it" } }
}

这里请求方法和路径日志成功但正文是Mono，那我应该如何记录呢？是否应该反过来，我必须订阅请求正文Mono并将其记录在回调中？另一个问题是ServerResponse这里的接口无法访问响应正文。我怎么能在这里得到它？

我尝试过的另一种方法是使用WebFilter

@Bean
fun loggingFilter(): WebFilter =
        WebFilter { exchange, chain ->
            val request = exchange.request
            logger.info { "Processing request method=${request.method} path=${request.path.pathWithinApplication()} params=[${request.queryParams}] body=[${request.body}]"  }

            val result = chain.filter(exchange)

            logger.info { "Handling with response ${exchange.response}" }

            return@WebFilter result
        }

同样的问题：请求正文是Flux，没有响应正文。

有没有办法访问来自某些过滤器的日志记录的完整请求和响应？我不明白什么？

4

11 回答 11

18

这或多或少类似于 Spring MVC 中的情况。

在 Spring MVC 中，您可以使用AbstractRequestLoggingFilter过滤器 ContentCachingRequestWrapper和/或ContentCachingResponseWrapper. 这里有许多权衡：

  • 如果您想访问 servlet 请求属性，您需要实际读取和解析请求正文
  • 记录请求正文意味着缓冲请求正文，这可能会占用大量内存
  • 如果您想访问响应正文，则需要包装响应并在响应正文被写入时缓冲它，以供以后检索

ContentCaching*WrapperWebFlux 中不存在类，但您可以创建类似的类。但请记住这里的其他要点：

  • 在内存中缓冲数据以某种方式违背了反应堆栈，因为我们正在尝试使用可用资源非常有效
  • 您不应该篡改实际的数据流并且刷新的频率比预期的多/少，否则您可能会破坏流式传输用例
  • 在那个级别，您只能访问DataBuffer实例，它们是（大致）内存高效的字节数组。这些属于缓冲池，并被回收用于其他交换。如果这些没有正确保留/释放，则会创建内存泄漏（并且缓冲数据以供以后使用肯定适合这种情况）
  • 再次在那个级别，它只是字节，您无权访问任何编解码器来解析 HTTP 正文。如果一开始就不是人类可读的，我会忘记缓冲内容

您的问题的其他答案：

  • 是的，这WebFilter可能是最好的方法
  • 不，您不应该订阅请求正文，否则您将使用处理程序无法读取的数据；您可以flatMap在doOn运算符中请求和缓冲数据
  • 包装响应应该使您可以在编写响应主体时访问它；不过不要忘记内存泄漏
于 2017-07-24T12:33:31.020 回答
10

我没有找到记录请求/响应主体的好方法，但是如果您只对元数据感兴趣，那么您可以按如下方式进行。

import org.springframework.http.HttpHeaders
import org.springframework.http.HttpStatus
import org.springframework.http.server.reactive.ServerHttpResponse
import org.springframework.stereotype.Component
import org.springframework.web.server.ServerWebExchange
import org.springframework.web.server.WebFilter
import org.springframework.web.server.WebFilterChain
import reactor.core.publisher.Mono

@Component
class LoggingFilter(val requestLogger: RequestLogger, val requestIdFactory: RequestIdFactory) : WebFilter {
    val logger = logger()

    override fun filter(exchange: ServerWebExchange, chain: WebFilterChain): Mono<Void> {
        logger.info(requestLogger.getRequestMessage(exchange))
        val filter = chain.filter(exchange)
        exchange.response.beforeCommit {
            logger.info(requestLogger.getResponseMessage(exchange))
            Mono.empty()
        }
        return filter
    }
}

@Component
class RequestLogger {

    fun getRequestMessage(exchange: ServerWebExchange): String {
        val request = exchange.request
        val method = request.method
        val path = request.uri.path
        val acceptableMediaTypes = request.headers.accept
        val contentType = request.headers.contentType
        return ">>> $method $path ${HttpHeaders.ACCEPT}: $acceptableMediaTypes ${HttpHeaders.CONTENT_TYPE}: $contentType"
    }

    fun getResponseMessage(exchange: ServerWebExchange): String {
        val request = exchange.request
        val response = exchange.response
        val method = request.method
        val path = request.uri.path
        val statusCode = getStatus(response)
        val contentType = response.headers.contentType
        return "<<< $method $path HTTP${statusCode.value()} ${statusCode.reasonPhrase} ${HttpHeaders.CONTENT_TYPE}: $contentType"
    }

    private fun getStatus(response: ServerHttpResponse): HttpStatus =
        try {
            response.statusCode
        } catch (ex: Exception) {
            HttpStatus.CONTINUE
        }
}
于 2017-08-25T08:54:30.893 回答
9

这就是我想出的java。

public class RequestResponseLoggingFilter implements WebFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        ServerHttpRequest httpRequest = exchange.getRequest();
        final String httpUrl = httpRequest.getURI().toString();

        ServerHttpRequestDecorator loggingServerHttpRequestDecorator = new ServerHttpRequestDecorator(exchange.getRequest()) {
            String requestBody = "";

            @Override
            public Flux<DataBuffer> getBody() {
                return super.getBody().doOnNext(dataBuffer -> {
                    try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
                        Channels.newChannel(byteArrayOutputStream).write(dataBuffer.asByteBuffer().asReadOnlyBuffer());
                        requestBody = IOUtils.toString(byteArrayOutputStream.toByteArray(), "UTF-8");
                        commonLogger.info(LogMessage.builder()
                                .step(httpUrl)
                                .message("log incoming http request")
                                .stringPayload(requestBody)
                                .build());
                    } catch (IOException e) {
                        commonLogger.error(LogMessage.builder()
                                .step("log incoming request for " + httpUrl)
                                .message("fail to log incoming http request")
                                .errorType("IO exception")
                                .stringPayload(requestBody)
                                .build(), e);
                    }
                });
            }
        };

        ServerHttpResponseDecorator loggingServerHttpResponseDecorator = new ServerHttpResponseDecorator(exchange.getResponse()) {
            String responseBody = "";
            @Override
            public Mono<Void> writeWith(Publisher<? extends DataBuffer> body) {
                Mono<DataBuffer> buffer = Mono.from(body);
                return super.writeWith(buffer.doOnNext(dataBuffer -> {
                    try (ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream()) {
                        Channels.newChannel(byteArrayOutputStream).write(dataBuffer.asByteBuffer().asReadOnlyBuffer());
                        responseBody = IOUtils.toString(byteArrayOutputStream.toByteArray(), "UTF-8");
                        commonLogger.info(LogMessage.builder()
                                .step("log outgoing response for " + httpUrl)
                                .message("incoming http request")
                                .stringPayload(responseBody)
                                .build());
                    } catch (Exception e) {
                        commonLogger.error(LogMessage.builder()
                                .step("log outgoing response for " + httpUrl)
                                .message("fail to log http response")
                                .errorType("IO exception")
                                .stringPayload(responseBody)
                                .build(), e);
                    }
                }));
            }
        };
        return chain.filter(exchange.mutate().request(loggingServerHttpRequestDecorator).response(loggingServerHttpResponseDecorator).build());
    }

}
于 2020-06-09T01:05:21.733 回答
5

从 Spring Boot 2.2.x 开始，Spring Webflux 支持Kotlin 协程。使用协程，您可以拥有非阻塞调用的优势，而无需处理 Mono 和 Flux 包装的对象。它为ServerRequest和ServerResponse添加了扩展，添加了类似ServerRequest#awaitBody()和的方法ServerResponse.BodyBuilder.bodyValueAndAwait(body: Any)。所以你可以像这样重写你的代码：

@Bean
fun apiRouter() = coRouter {
    (accept(MediaType.APPLICATION_JSON) and "/api").nest {
        "/user".nest {
            /* the handler methods now use ServerRequest and ServerResponse directly
             you just need to add suspend before your function declaration:
             suspend fun listUsers(ServerRequest req, ServerResponse res) */ 
            GET("/", userHandler::listUsers)
            POST("/{userId}", userHandler::updateUser)
        }
    }

    // this filter will be applied to all routes built by this coRouter
    filter { request, next ->
      // using non-blocking request.awayBody<T>()
      logger.info("Processing $request with body ${request.awaitBody<String>()}")
        val res = next(request)
        logger.info("Handling with Content-Type ${res.headers().contentType} and status code ${res.rawStatusCode()}")
        res 
    }
}

为了创建一个带有coroutines的WebFilter Bean，我想你可以使用这个CoroutineWebFilter接口（我没有测试过，不知道它是否有效）。

于 2021-02-04T03:36:24.833 回答
4

您实际上可以为 Netty 和 Reactor-Netty 相关的调试日志启用以查看正在发生的事情的全貌。你可以玩下面的，看看你想要什么，不要什么。那是我能做的最好的了。

reactor.ipc.netty.channel.ChannelOperationsHandler: DEBUG
reactor.ipc.netty.http.server.HttpServer: DEBUG
reactor.ipc.netty.http.client: DEBUG
io.reactivex.netty.protocol.http.client: DEBUG
io.netty.handler: DEBUG
io.netty.handler.proxy.HttpProxyHandler: DEBUG
io.netty.handler.proxy.ProxyHandler: DEBUG
org.springframework.web.reactive.function.client: DEBUG
reactor.ipc.netty.channel: DEBUG
于 2018-02-26T09:13:53.490 回答
4

我对 Spring WebFlux 很陌生，我不知道如何在 Kotlin 中做到这一点，但应该与使用 WebFilter 的 Java 相同：

public class PayloadLoggingWebFilter implements WebFilter {

    public static final ByteArrayOutputStream EMPTY_BYTE_ARRAY_OUTPUT_STREAM = new ByteArrayOutputStream(0);

    private final Logger logger;
    private final boolean encodeBytes;

    public PayloadLoggingWebFilter(Logger logger) {
        this(logger, false);
    }

    public PayloadLoggingWebFilter(Logger logger, boolean encodeBytes) {
        this.logger = logger;
        this.encodeBytes = encodeBytes;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        if (logger.isInfoEnabled()) {
            return chain.filter(decorate(exchange));
        } else {
            return chain.filter(exchange);
        }
    }

    private ServerWebExchange decorate(ServerWebExchange exchange) {
        final ServerHttpRequest decorated = new ServerHttpRequestDecorator(exchange.getRequest()) {

            @Override
            public Flux<DataBuffer> getBody() {

                if (logger.isDebugEnabled()) {
                    final ByteArrayOutputStream baos = new ByteArrayOutputStream();
                    return super.getBody().map(dataBuffer -> {
                        try {
                            Channels.newChannel(baos).write(dataBuffer.asByteBuffer().asReadOnlyBuffer());
                        } catch (IOException e) {
                            logger.error("Unable to log input request due to an error", e);
                        }
                        return dataBuffer;
                    }).doOnComplete(() -> flushLog(baos));

                } else {
                    return super.getBody().doOnComplete(() -> flushLog(EMPTY_BYTE_ARRAY_OUTPUT_STREAM));
                }
            }

        };

        return new ServerWebExchangeDecorator(exchange) {

            @Override
            public ServerHttpRequest getRequest() {
                return decorated;
            }

            private void flushLog(ByteArrayOutputStream baos) {
                ServerHttpRequest request = super.getRequest();
                if (logger.isInfoEnabled()) {
                    StringBuffer data = new StringBuffer();
                    data.append('[').append(request.getMethodValue())
                        .append("] '").append(String.valueOf(request.getURI()))
                        .append("' from ")
                            .append(
                                Optional.ofNullable(request.getRemoteAddress())
                                            .map(addr -> addr.getHostString())
                                        .orElse("null")
                            );
                    if (logger.isDebugEnabled()) {
                        data.append(" with payload [\n");
                        if (encodeBytes) {
                            data.append(new HexBinaryAdapter().marshal(baos.toByteArray()));
                        } else {
                            data.append(baos.toString());
                        }
                        data.append("\n]");
                        logger.debug(data.toString());
                    } else {
                        logger.info(data.toString());
                    }

                }
            }
        };
    }

}

这里有一些测试：github

我认为这就是Brian Clozel (@brian-clozel) 的意思。

于 2017-12-21T19:24:29.100 回答
2

这是具有完整实现的GitHub存储库，用于记录请求和响应正文以及基于 webflux/java 的应用程序的 http 标头...

于 2020-06-12T05:56:06.270 回答
1

假设我们正在处理一个简单的 JSON 或 XML 响应，如果debug相应记录器的级别由于某种原因不够，可以在将其转换为对象之前使用字符串表示：

Mono<Response> mono = WebClient.create()
                               .post()
                               .body(Mono.just(request), Request.class)
                               .retrieve()
                               .bodyToMono(String.class)
                               .doOnNext(this::sideEffectWithResponseAsString)
                               .map(this::transformToResponse);

以下是副作用和转换方法：

private void sideEffectWithResponseAsString(String response) { ... }
private Response transformToResponse(String response) { /*use Jackson or JAXB*/ }
于 2018-12-27T14:41:42.967 回答
0

我认为这里要做的适当的事情是以异步方式（java.nio）将每个请求的内容写入文件，并设置一个间隔来异步读取这些请求正文文件并将它们写入内存使用日志感知方式（一次至少一个文件，但一次最多 100 mb），并在记录它们后从磁盘中删除文件。

于 2022-02-05T08:10:53.857 回答
0

布赖恩说的。此外，记录请求/响应主体对于反应式流媒体没有意义。如果您将通过管道的数据想象为流，那么除非您缓冲它，否则您在任何时候都不会拥有完整的内容，这会破坏整个观点。对于小的请求/响应，您可以摆脱缓冲，但是为什么要使用反应模型（除了给您的同事留下深刻印象:-)）？

我能想到的记录请求/响应的唯一原因是调试，但是对于反应式编程模型，调试方法也必须修改。Project Reactor 文档有一个很好的调试部分，您可以参考：http ://projectreactor.io/docs/core/snapshot/reference/#debugging

于 2018-01-01T21:50:44.630 回答
0

如果您使用控制器而不是处理程序最好的方法是使用 @Log 注释对控制器类进行注释的 aop。仅供参考，这将纯 json 对象作为请求而不是单声道。

@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
annotation class Log

@Aspect
@Component
class LogAspect {
    companion object {
        val log = KLogging().logger
    }

    @Around("@annotation(Log)")
    @Throws(Throwable::class)
    fun logAround(joinPoint: ProceedingJoinPoint): Any? {
        val start = System.currentTimeMillis()
        val result = joinPoint.proceed()
        return if (result is Mono<*>) result.doOnSuccess(getConsumer(joinPoint, start)) else result
    }

    fun getConsumer(joinPoint: ProceedingJoinPoint, start: Long): Consumer<Any>? {
        return Consumer {
            var response = ""
            if (Objects.nonNull(it)) response = it.toString()
            log.info(
                "Enter: {}.{}() with argument[s] = {}",
                joinPoint.signature.declaringTypeName, joinPoint.signature.name,
                joinPoint.args
            )
            log.info(
                "Exit: {}.{}() had arguments = {}, with result = {}, Execution time = {} ms",
                joinPoint.signature.declaringTypeName, joinPoint.signature.name,
                joinPoint.args[0],
                response, System.currentTimeMillis() - start
            )
        }
    }
}
于 2020-10-06T01:03:26.810 回答