如何在 Spring Boot REST API 中有效记录请求、响应和异常？

在 Spring Boot 中记录请求和响应

使用 Spring Boot 开发 REST API 时，记录请求和响应对于调试目的和深入了解应用程序行为。这不仅包括记录成功的请求，还包括记录遇到的异常。

使用 Spring Boot Actuator

Spring Boot Actuator 模块提供内置的 HTTP 请求日志记录功能。要启用请求日志记录，请按照以下步骤操作：

1. 将 spring-boot-starter-actuator 依赖项添加到您的项目中。
2. 配置要公开的端点（例如，management）。 endpoints.web.base-path=/actuator).
3. 访问 /trace（对于 Spring Boot 1.x）或/actuator/httptrace （对于 Spring Boot 2.0 ）端点用于查看最近 100 个 HTTP 请求。

自定义请求日志记录

自定义请求日志记录行为可以是通过实现 WebFilter 来实现。这允许您在应用程序的控制器处理请求之前拦截和操作请求。以下是记录请求和响应的自定义 Web 过滤器的示例：

public class RequestResponseLoggingFilter implements WebFilter {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        // Log the request
        logRequest(exchange);

        // Log the response
        return chain.filter(exchange).then(logResponse(exchange));
    }

    private void logRequest(ServerWebExchange exchange) {
        String path = exchange.getRequest().getPath().toString();
        String method = exchange.getRequest().getMethodValue();
        String clientIp = exchange.getRequest().getRemoteAddress().getAddress().getHostAddress();
        String queryString = exchange.getRequest().getQueryParams().toString();
        // ... (additional request information)
    }

    private Mono<Void> logResponse(ServerWebExchange exchange) {
        return exchange.getResponse().writeWith(processor -> {
            // ... (read the response, log the status code, response headers, etc.)
        });
    }
}

使用 WebFilterRegistrationBean 在 Spring Boot 应用程序中注册过滤器：

@Bean
public WebFilterRegistrationBean<RequestResponseLoggingFilter> requestResponseLoggingFilter() {
    return new WebFilterRegistrationBean<>(new RequestResponseLoggingFilter());
}

处理异常

为了统一处理和记录异常，可以使用@ExceptionHandler注解控制器或服务类。例如：

@RestController
public class MyController {

    @ExceptionHandler(Exception.class)
    public ResponseEntity<Error> handleException(Exception e) {
        // Log the exception
        // ...
        
        // Return the error response
        Error error = new Error();
        error.setMessage(e.getMessage());
        error.setErrorCode(101); // Custom error code
        
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(error);
    }
}

通过将自定义 Web 过滤器与异常处理程序相结合，您可以以一致的方式记录所有请求、响应和异常。

以上是如何在 Spring Boot REST API 中有效记录请求、响应和异常？的详细内容。更多信息请关注PHP中文网其他相关文章！