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


114

我有一个方法可以像下面这样进行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进行序列化就可以了。

Answers:


196

有关如何执行此操作的示例:

一些注意事项:

  • LoggingHandler在处理请求之前截取该请求HttpClientHandler,最后将请求写入连接。

  • PostAsJsonAsync扩展程序在内部创建一个ObjectContentand当在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!"

3
如果您需要请求详细信息,但它无法将准确的请求发送到服务器,则很好。如果您恰好需要所有发送到服务器的字节,它将无法以这种方式工作。
mathk 2014年

1
为什么new HttpClientHandler()呢?它在官方文档中不存在:docs.microsoft.com/zh-cn/aspnet/web-api/overview/advanced/…– Zero3
2015年

1
嗯,显然需要不要让内部处理程序为null出现异常...
Zero3

3
您还可以重写MessageProcessingHandler,该方法基本上在调用之前和之后都为您调用ProcessRequestand ProcessResponse方法SendAsync
IllusiveBrian

1
@RamiA在下面的答案更好,因为它不需要更改代码。一旦完成调试,就可以从配置中删除跟踪,仅此而已。无需重新构建。
Tsahi Asher '18

50

看到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>

2
这是一个很好的解决方案,感谢您进行一些研究和分享。
Piwaf

它是如何工作的 ?我复制<system.diagnostics>app.config下面,<configuration>但是在bin文件夹中没有日志文件,控制台输出也未显示任何内容,我缺少什么?
Muflix

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

11

网络跟踪也可用于下一个对象(请参阅msdn上的文章)

  • System.Net.Sockets Socket,TcpListener,TcpClient和Dns类的一些公共方法
  • 系统网 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>  

-14

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


9
想象一个世界,其中大多数此类连接实际上是HTTPS。
2016年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.