登录
首页 >  文章 >  java教程

Java记录请求日志方法与URL示例

时间：2025-07-28 14:32:48 373浏览 收藏

本文深入探讨了在Java中记录网络请求日志的有效方法，并提供了URL示例。针对服务器端Web应用，推荐使用Servlet过滤器（Filter）拦截HTTP请求，通过`ContentCachingRequestWrapper`和`ContentCachingResponseWrapper`捕获请求和响应的详细信息，包括URL、方法、头信息、请求体和响应体。对于客户端HTTP请求，则可利用OkHttp等HTTP客户端库提供的拦截器（Interceptor）机制。文章还强调了记录网络请求日志在问题诊断、安全审计、性能分析和业务行为分析等方面的重要价值。同时，也指出了内存消耗、性能开销和敏感数据泄露等潜在问题，并提供了相应的解决方案，如限制请求体大小、实施数据脱敏策略和使用异步日志等，旨在帮助开发者构建安全且高效的日志记录系统。

在Java中记录网络请求日志最常见且有效的方式是使用Servlet过滤器（Filter）拦截HTTP请求，或利用HTTP客户端库的拦截器（Interceptor）机制捕获请求和响应数据。1. 服务器端可通过实现自定义的Servlet Filter，如结合ContentCachingRequestWrapper和ContentCachingResponseWrapper包装请求和响应对象，从而多次读取内容并记录URL、方法、头信息、请求体、响应体及耗时等信息，在过滤器链执行完毕后调用copyBodyToResponse确保响应体写回客户端。2. 客户端可通过HTTP库提供的拦截器机制实现，如OkHttp的Interceptor接口，在intercept方法中获取Request和Response对象，记录发送请求的URL、头信息、请求体及接收响应的时间、状态、响应体等，并通过addInterceptor方法将其添加到OkHttpClient实例中。记录网络请求日志的价值体现在问题诊断、安全审计、性能分析、业务行为分析和问题重现等方面，但需注意内存消耗、性能开销和敏感数据泄露等问题，应通过限制请求体响应体大小、实施数据脱敏策略、使用异步日志、优化日志级别和配置日志轮转等方式来保障安全和性能。

如何用Java记录网络请求日志 Java记录URL访问信息示例

在Java中记录网络请求日志，特别是URL访问信息，最常见且有效的方式是在服务器端使用Servlet过滤器（Filter）来拦截HTTP请求，或者在客户端HTTP请求发送前/后利用各HTTP客户端库提供的拦截器（Interceptor）机制。这两种方法都能让你在请求到达业务逻辑之前或之后，以及响应发送之前，捕获到丰富的网络交互数据。

如何用Java记录网络请求日志 Java记录URL访问信息示例

解决方案

记录网络请求日志通常涉及两个主要场景：Web应用服务器端和客户端发起HTTP请求。

1. 服务器端Web应用（如Spring Boot/Servlet应用）

如何用Java记录网络请求日志 Java记录URL访问信息示例

在Web应用中，一个通用的做法是实现一个自定义的Servlet Filter。这个过滤器会在每个HTTP请求到达Servlet之前被调用，并且在响应返回客户端之前再次被调用。这提供了绝佳的切入点来记录请求的URL、方法、头信息、参数乃至请求体，以及响应的状态码、头信息和响应体。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.util.ContentCachingRequestWrapper;
import org.springframework.web.util.ContentCachingResponseWrapper;

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.util.Enumeration;

@Component
public class RequestLoggingFilter implements Filter {

    private static final Logger log = LoggerFactory.getLogger(RequestLoggingFilter.class);

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpServletRequest = (HttpServletRequest) request;
        HttpServletResponse httpServletResponse = (HttpServletResponse) response;

        // 包装请求和响应，以便多次读取内容
        ContentCachingRequestWrapper requestWrapper = new ContentCachingRequestWrapper(httpServletRequest);
        ContentCachingResponseWrapper responseWrapper = new ContentCachingResponseWrapper(httpServletResponse);

        long startTime = System.currentTimeMillis();
        try {
            chain.doFilter(requestWrapper, responseWrapper);
        } finally {
            long duration = System.currentTimeMillis() - startTime;
            logRequestAndResponse(requestWrapper, responseWrapper, duration);
            responseWrapper.copyBodyToResponse(); // 确保响应体被写入到原始响应中
        }
    }

    private void logRequestAndResponse(ContentCachingRequestWrapper requestWrapper,
                                       ContentCachingResponseWrapper responseWrapper,
                                       long duration) throws UnsupportedEncodingException {
        String requestUri = requestWrapper.getRequestURI();
        String method = requestWrapper.getMethod();
        String queryString = requestWrapper.getQueryString();
        String fullUrl = requestUri + (queryString != null ? "?" + queryString : "");

        StringBuilder requestLog = new StringBuilder();
        requestLog.append("\n--- HTTP Request ---\n");
        requestLog.append("URL: ").append(method).append(" ").append(fullUrl).append("\n");
        requestLog.append("Client IP: ").append(requestWrapper.getRemoteAddr()).append("\n");
        requestLog.append("Headers:\n");
        Enumeration headerNames = requestWrapper.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String headerName = headerNames.nextElement();
            requestLog.append("  ").append(headerName).append(": ").append(requestWrapper.getHeader(headerName)).append("\n");
        }

        byte[] requestBody = requestWrapper.getContentAsByteArray();
        if (requestBody.length > 0) {
            String bodyContent = new String(requestBody, requestWrapper.getCharacterEncoding());
            requestLog.append("Body: ").append(bodyContent.length() > 2000 ? bodyContent.substring(0, 2000) + "..." : bodyContent).append("\n"); // 限制长度
        }
        log.info(requestLog.toString());

        StringBuilder responseLog = new StringBuilder();
        responseLog.append("\n--- HTTP Response ---\n");
        responseLog.append("URL: ").append(method).append(" ").append(fullUrl).append("\n");
        responseLog.append("Status: ").append(responseWrapper.getStatus()).append("\n");
        responseLog.append("Duration: ").append(duration).append(" ms\n");
        responseLog.append("Headers:\n");
        responseWrapper.getHeaderNames().forEach(headerName ->
            responseLog.append("  ").append(headerName).append(": ").append(responseWrapper.getHeader(headerName)).append("\n")
        );

        byte[] responseBody = responseWrapper.getContentAsByteArray();
        if (responseBody.length > 0) {
            String bodyContent = new String(responseBody, responseWrapper.getCharacterEncoding());
            responseLog.append("Body: ").append(bodyContent.length() > 2000 ? bodyContent.substring(0, 2000) + "..." : bodyContent).append("\n"); // 限制长度
        }
        log.info(responseLog.toString());
    }
}

2. 客户端HTTP请求（如使用OkHttp、RestTemplate等）

如何用Java记录网络请求日志 Java记录URL访问信息示例

当你的Java应用作为客户端发起HTTP请求时，大多数现代HTTP客户端库都提供了拦截器机制。你可以在请求发送前修改请求，或在接收响应后处理响应。

以OkHttp为例：

import okhttp3.Interceptor;
import okhttp3.Request;
import okhttp3.Response;
import okhttp3.ResponseBody;
import okhttp3.MediaType;
import okio.Buffer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.TimeUnit;

public class OkHttpLoggingInterceptor implements Interceptor {

    private static final Logger log = LoggerFactory.getLogger(OkHttpLoggingInterceptor.class);

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        long t1 = System.nanoTime();

        StringBuilder requestLog = new StringBuilder();
        requestLog.append("\n--- OkHttp Request ---\n");
        requestLog.append(String.format("Sending request %s on %s%n%s",
                request.url(), chain.connection(), request.headers()));

        if (request.body() != null) {
            Buffer buffer = new Buffer();
            request.body().writeTo(buffer);
            Charset charset = StandardCharsets.UTF_8;
            MediaType contentType = request.body().contentType();
            if (contentType != null) {
                charset = contentType.charset(StandardCharsets.UTF_8);
            }
            requestLog.append("Request Body: ").append(buffer.clone().readString(charset)).append("\n");
        }
        log.info(requestLog.toString());

        Response response = chain.proceed(request);
        long t2 = System.nanoTime();

        StringBuilder responseLog = new StringBuilder();
        responseLog.append("\n--- OkHttp Response ---\n");
        responseLog.append(String.format("Received response for %s in %.1fms%n%s",
                response.request().url(), (t2 - t1) / 1e6d, response.headers()));

        ResponseBody responseBody = response.peekBody(1024 * 1024); // 限制读取大小
        if (responseBody != null) {
            Charset charset = StandardCharsets.UTF_8;
            MediaType contentType = responseBody.contentType();
            if (contentType != null) {
                charset = contentType.charset(StandardCharsets.UTF_8);
            }
            responseLog.append("Response Body: ").append(responseBody.string()).append("\n");
        }
        log.info(responseLog.toString());

        return response;
    }
}

然后将这个拦截器添加到你的OkHttpClient中：

// OkHttpClient client = new OkHttpClient.Builder()
//     .addInterceptor(new OkHttpLoggingInterceptor())
//     .build();

为什么记录网络请求日志如此重要？

在我看来，网络请求日志就像是应用程序的“黑匣子”，它记录了系统与外部世界（或其他内部服务）交互的每一个细节。没有它，很多问题排查都将是盲人摸象。我个人经历过太多次，在没有详细请求日志的情况下，团队成员为了一个偶现的接口问题彻夜难眠。

记录这些日志的核心价值体现在几个方面：

  • 问题诊断与排查： 这是最直接的用途。当用户抱怨某个功能不工作，或者服务间调用出现异常时，请求日志能立即告诉你具体是哪个请求出了问题，参数是什么，响应是什么，状态码是多少。这比单纯的错误堆栈信息要直观得多。
  • 安全审计与合规： 对于金融、医疗等行业，记录谁在何时访问了什么资源，以及访问结果如何，是满足合规性要求（如GDPR、HIPAA）的关键。它能帮助我们追踪潜在的恶意行为或数据泄露。
  • 性能分析： 通过记录请求的耗时，可以发现哪些接口是性能瓶颈，哪些服务响应缓慢。这对于优化系统性能至关重要。
  • 业务行为分析： 虽然这不是日志的主要目的，但通过分析请求的URL和参数，有时也能洞察用户行为模式，为产品改进提供数据支持。
  • 重现问题： 详细的请求和响应日志能够帮助开发人员在开发或测试环境中精准地重现生产环境中的问题。

所以，这不仅仅是一个“锦上添花”的功能，它简直是现代复杂分布式系统不可或缺的基础设施。

如何在日志中有效捕获请求体和响应体？

捕获请求体和响应体是网络请求日志的难点之一，因为标准的HttpServletRequest和HttpServletResponse的输入流和输出流通常只能读取一次。如果你直接尝试在过滤器中读取，那么后续的Servlet或Controller就无法再次读取了。

解决方案通常是使用内容缓存包装器（Content Caching Wrappers）。

  • 请求体： 对于HttpServletRequest，你可以使用jakarta.servlet.http.HttpServletRequestWrapper（或javax版本）的子类，或者Spring框架提供的ContentCachingRequestWrapper。这些包装器会在第一次读取请求体时将其内容缓存起来，这样你就可以多次读取。在上面的示例代码中，ContentCachingRequestWrapper就是做这个事情的。它把输入流的内容读到内存中的一个字节数组里，之后你可以通过getContentAsByteArray()方法获取。
  • 响应体： 类似地，对于HttpServletResponse，可以使用jakarta.servlet.http.HttpServletResponseWrapper的子类或Spring的ContentCachingResponseWrapper。这个包装器会把所有写入响应输出流的内容先缓存起来，而不是直接发送给客户端。在过滤器链执行完毕后，你需要手动调用responseWrapper.copyBodyToResponse()方法，将缓存的内容复制回原始的响应输出流，这样客户端才能收到响应。

需要注意的点：

  1. 内存消耗： 缓存请求体和响应体意味着这些数据会暂时存储在内存中。如果请求体或响应体非常大（例如上传大文件或下载大文件），这可能会导致显著的内存消耗，甚至OOM（内存溢出）错误。
  2. 性能开销： 复制和缓存数据本身也需要CPU和I/O开销。
  3. 敏感数据： 捕获请求体和响应体时，务必警惕敏感信息泄露。密码、个人身份信息（PII）、银行卡号等绝不能以明文形式记录到日志中。

因此，在捕获请求体和响应体时，通常会结合使用长度限制（如示例中bodyContent.length() > 2000 ? ...），以及敏感数据脱敏或加密的策略。

记录日志时需要注意哪些安全和性能问题？

记录网络请求日志虽然价值巨大，但若处理不当，也可能带来一系列安全和性能上的隐患。我亲眼见过因为日志策略不当导致生产环境崩溃，或者敏感数据泄露的案例，这简直是噩梦。

安全问题：

  • 敏感数据泄露： 这是最严重的问题。请求参数、请求头、响应体中可能包含用户的密码、身份证号、银行卡信息、API密钥、Session ID、Authorization Token等敏感数据。如果这些信息被明文记录到日志文件中，一旦日志文件被未授权访问，将造成灾难性的数据泄露。
    • 对策： 必须实施严格的数据脱敏（Data Masking/Redaction）策略。识别出所有可能包含敏感信息的字段，在写入日志前将其替换为星号（***）、哈希值或预定义的占位符。例如，password字段可以记录为password=******。
  • 日志文件访问控制： 日志文件本身就是敏感资源。确保日志文件存储在受保护的目录中，并且只有授权的用户或服务才能访问。遵循最小权限原则，限制对日志目录的读写权限。
  • 日志篡改： 恶意攻击者可能会尝试修改日志文件以掩盖其行踪。虽然这不是Java日志库直接解决的问题，但应考虑使用日志审计工具或将日志发送到安全的、不可篡改的集中式日志系统（如ELK Stack配合适当的安全配置）。

性能问题：

  • I/O开销： 频繁地写入磁盘是日志记录最主要的性能瓶颈。每个请求都生成大量日志，会产生巨大的磁盘I/O压力，尤其是在高并发场景下。
    • 对策： 使用异步日志（如Logback的AsyncAppender或Log4j2的AsyncLogger）。异步日志将日志事件写入一个队列，然后由独立的线程批量写入磁盘，从而减少对主业务线程的影响。
  • CPU开销： 日志内容的格式化、字符串拼接、敏感数据脱敏等操作都会消耗CPU资源。
    • 对策： 优化日志格式，避免不必要的复杂计算。对于高并发路径，考虑只记录关键信息，或根据配置动态调整日志详细程度。
  • 内存消耗： 前面提到的内容缓存包装器会临时占用内存。如果请求/响应体过大，或者并发量极高，可能导致内存溢出。
    • 对策： 严格限制捕获的请求体和响应体大小，对于超出的部分进行截断。对于非常大的文件上传/下载，可以考虑不记录其完整内容，只记录文件大小和元数据。
  • 日志量过大： 即使性能不是问题，过大的日志量也会迅速填满磁盘空间，并且使得日志分析变得困难。
    • 对策：
      • 日志级别管理： 在生产环境中，将日志级别设置为INFO或WARN，只在需要详细调试时临时切换到DEBUG。
      • 采样（Sampling）： 对于非关键或高频接口，可以考虑只记录一部分请求的日志，例如每100个请求只记录一个。
      • 按需开启： 提供配置开关，可以在不重启应用的情况下动态开启或关闭详细的请求日志。
      • 日志轮转与归档： 配置日志框架进行日志文件按大小或时间自动轮转，并定期归档或删除旧的日志文件。

总之，一套完善的网络请求日志策略，需要仔细权衡其带来的价值与潜在的风险和开销。这绝不是一个“一劳永逸”的配置，而是需要根据业务需求、系统负载和安全要求持续迭代和优化的过程。

文中关于java,数据脱敏,拦截器,网络请求日志,Servlet过滤器的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Java记录请求日志方法与URL示例》文章吧，也可关注golang学习网公众号了解相关技术文章。

java 数据脱敏 拦截器 网络请求日志 Servlet过滤器
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>