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

本文关键字：响应 消息 请求 记录 HttpClient 使用 | 更新日期: 2023-09-27 18:32:08

我有一个方法可以像下面这样进行 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。我想记录发布 JSON，所以拥有它会很好，而不必我自己进行 json 序列化。

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

如何执行此操作的示例：

一些注意事项：

  • LoggingHandler在将请求处理到最终写入线路HttpClientHandler之前截获请求。

  • PostAsJsonAsync扩展在内部创建一个ObjectContent，当ReadAsStringAsync()在LoggingHandler中调用时，它会导致格式化程序内部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!"

注意：这仅适用于 .NET Framework！

可能正在使用 .NET 7+ （https://github.com/dotnet/runtime/issues/23937）

<小时 />

请参阅 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>

网络跟踪也可用于下一个对象（请参阅有关 msdn 的文章）

  • 系统.网络.套接字套接字、TcpListener、TcpClient 和 Dns 类的一些公共方法
  • System.NetHttpWebRequest、HttpWebResponse、FtpWebRequest 和 FtpWebResponse 类的一些公共方法，以及 SSL 调试信息（无效证书、缺少颁发者列表和客户端证书错误）。
  • System.Net.HttpListenerHttpListener、HttpListenerRequest 和 HttpListenerResponse 类的一些公共方法。
  • 系统.网络.缓存System.Net.Cache中的一些私有和内部方法。
  • System.Net.HttpHttpClient、DelegatingHandler、HttpClientHandler、HttpMessageHandler、MessageProcessingHandler 和 WebRequestHandler 类的一些公共方法。
  • System.Net.WebSockets.WebSocketClientWebSocket 和 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>

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

相关文章：