使用 HttpClient 时记录请求/响应消息

Posted 2023-03-09

【中文标题】使用 HttpClient 时记录请求/响应消息

【英文标题】：Logging request/response messages when using HttpClient

【发布时间】：2013-09-26 07:51:27

【问题描述】：

我有一个方法可以像下面这样进行 POST

var response = await client.PostAsJsonAsync(url, entity);

if (response.IsSuccessStatusCode)

        // read the response as strongly typed object
        return await response.Content.ReadAsAsync<T>();

我的问题是如何获取从实体对象发布的实际 JSON。我想记录得到 POSTED 的 JSON，所以不用我自己进行 json 序列化就可以了。

【参考方案1】：

如何做到这一点的示例：

一些注意事项：

LoggingHandler 在将请求处理给最终写入线路的HttpClientHandler 之前拦截请求。

PostAsJsonAsync 扩展在内部创建一个ObjectContent，当在LoggingHandler 中调用ReadAsStringAsync() 时，它会导致格式化程序 在ObjectContent 中序列化对象，这就是您在 json 中看到内容的原因。

日志处理程序：

public class LoggingHandler : DelegatingHandler

    public LoggingHandler(HttpMessageHandler innerHandler)
        : base(innerHandler)
    
    

    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    
        Console.WriteLine("Request:");
        Console.WriteLine(request.ToString());
        if (request.Content != null)
        
            Console.WriteLine(await request.Content.ReadAsStringAsync());
        
        Console.WriteLine();

        HttpResponseMessage response = await base.SendAsync(request, cancellationToken);

        Console.WriteLine("Response:");
        Console.WriteLine(response.ToString());
        if (response.Content != null)
        
            Console.WriteLine(await response.Content.ReadAsStringAsync());
        
        Console.WriteLine();

        return response;
    

将上面的 LoggingHandler 与 HttpClient 链接起来：

HttpClient client = new HttpClient(new LoggingHandler(new HttpClientHandler()));
HttpResponseMessage response = client.PostAsJsonAsync(baseAddress + "/api/values", "Hello, World!").Result;

输出：

Request:
Method: POST, RequestUri: 'http://kirandesktop:9095/api/values', Version: 1.1, Content: System.Net.Http.ObjectContent`1[
[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], Headers:

  Content-Type: application/json; charset=utf-8

"Hello, World!"

Response:
StatusCode: 200, ReasonPhrase: 'OK', Version: 1.1, Content: System.Net.Http.StreamContent, Headers:

  Date: Fri, 20 Sep 2013 20:21:26 GMT
  Server: Microsoft-HTTPAPI/2.0
  Content-Length: 15
  Content-Type: application/json; charset=utf-8

"Hello, World!"

【讨论】：

如果您需要请求详细信息，但它无法将确切的请求发送到服务器，这很好。如果您需要准确地将所有字节发送到服务器，那么它不会以这种方式工作。

为什么是new HttpClientHandler()？它不在官方文档中：docs.microsoft.com/en-us/aspnet/web-api/overview/advanced/…

啊，显然需要不让内部处理程序为空的异常...

您还可以覆盖MessageProcessingHandler，它在SendAsync 调用之前和之后基本上为您调用ProcessRequest 和ProcessResponse 方法。

@RamiA 下面的答案更好，因为它不需要更改代码。完成调试后，从配置中删除跟踪，就是这样。无需重新构建。

【参考方案2】：

见http://mikehadlow.blogspot.com/2012/07/tracing-systemnet-to-debug-http-clients.html

要将 System.Net 侦听器配置为同时输出到控制台和日志文件，请将以下内容添加到您的程序集配置文件中：

<system.diagnostics>
  <trace autoflush="true" />
  <sources>
    <source name="System.Net">
      <listeners>
        <add name="MyTraceFile"/>
        <add name="MyConsole"/>
      </listeners>
    </source>
  </sources>
  <sharedListeners>
    <add
      name="MyTraceFile"
      type="System.Diagnostics.TextWriterTraceListener"
      initializeData="System.Net.trace.log" />
    <add name="MyConsole" type="System.Diagnostics.ConsoleTraceListener" />
  </sharedListeners>
  <switches>
    <add name="System.Net" value="Verbose" />
  </switches>
</system.diagnostics>

【讨论】：

它是如何工作的？我将<system.diagnostics> 复制到app.config 下<configuration> 下，但在bin 文件夹中没有日志文件，控制台输出也不显示任何内容，我错过了什么？

@Muflix，您可以阅读我的答案顶部引用的页面中链接的文档。我认为initializeData 属性中指定的文件名将在您正在运行的可执行文件的当前工作目录中创建，因此您可能需要检查您的环境中的路径。

@Rami A. 没有人会认真地将链接的博客文章称为“文档”。它没有比你的答案解释更多。对我来说它不起作用，但也许对于插件 dll，我必须做更多的事情......或者像 Kiran Challa 那样自己编写有趣的东西来归档。

@TheincredibleJan 博文中有一个链接：docs.microsoft.com/en-us/dotnet/framework/network-programming/… 您可以通过在页面底部提供反馈来为文档做出贡献。这是官方文档，包含比我的答案更多的技术信息。你为什么不认为这是“严肃的”文档？

【参考方案3】：

网络跟踪也可用于下一个对象（参见msdn 上的文章）

System.Net.Sockets

Socket、TcpListener、TcpClient 和 Dns 类的一些公共方法

System.Net

HttpWebRequest、HttpWebResponse、FtpWebRequest 和 FtpWebResponse 类的一些公共方法，以及 SSL 调试信息（无效证书、缺少颁发者列表和客户端证书错误。）

System.Net.HttpListener

HttpListener、HttpListenerRequest 和 HttpListenerResponse 类的一些公共方法。

System.Net.Cache

System.Net.Cache 中的一些私有和内部方法。

System.Net.Http

HttpClient、DelegatingHandler、HttpClientHandler、HttpMessageHandler、MessageProcessingHandler 和 WebRequestHandler 类的一些公共方法。

System.Net.WebSockets.WebSocket

ClientWebSocket 和 WebSocket 类的一些公共方法。

将下一行代码放入配置文件

<configuration>  
  <system.diagnostics>  
    <sources>  
      <source name="System.Net" tracemode="includehex" maxdatasize="1024">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.Cache">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.Http">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.Sockets">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
      <source name="System.Net.WebSockets">  
        <listeners>  
          <add name="System.Net"/>  
        </listeners>  
      </source>  
    </sources>  
    <switches>  
      <add name="System.Net" value="Verbose"/>  
      <add name="System.Net.Cache" value="Verbose"/>  
      <add name="System.Net.Http" value="Verbose"/>  
      <add name="System.Net.Sockets" value="Verbose"/>  
      <add name="System.Net.WebSockets" value="Verbose"/>  
    </switches>  
    <sharedListeners>  
      <add name="System.Net"  
        type="System.Diagnostics.TextWriterTraceListener"  
        initializeData="network.log"  
      />  
    </sharedListeners>  
    <trace autoflush="true"/>  
  </system.diagnostics>  
</configuration>  

【讨论】：

配置文件在哪里，找不到了。

根据您的项目类型，web.config、app.config 甚至可能是 appsettings.json，在这种情况下，您必须在 json 中找出这些选项。

【参考方案4】：

最简单的解决方案是使用 Wireshark 并跟踪 HTTP tcp 流。

【讨论】：

想象一个大多数此类连接实际上都是 HTTPS 的世界。