RestSharp 打印原始请求和响应标头

Question

我正在使用RestSharp调用网络服务。 一切都很好，但我想知道是否可以打印发出的原始请求标头和正文以及返回的原始响应标头和响应正文。

这是我创建请求并获得响应的代码

public static TResponse ExecutePostCall<TResponse, TRequest>(String url, TRequest requestData, string token= "") where TResponse : new()
{
    RestRequest request = new RestRequest(url, Method.POST);
    if (!string.IsNullOrWhiteSpace(token))
    {
        request.AddHeader("TOKEN", token);
    }


    request.RequestFormat = DataFormat.Json;
    request.AddBody(requestData);

    // print raw request here

    var response = _restClient.Execute<TResponse>(request);

    // print raw response here

    return response.Data;
}

那么，是否可以打印原始请求和响应？

Answer 1

RestSharp 没有提供一种机制来实现您想要的功能，并且激活 .Net 跟踪对 IMO 来说有点矫枉过正。

对于日志记录（调试）目的（例如，我可以在 PROD 中保持开启一段时间）我发现这种方法非常有用（尽管它有一些关于如何调用它的详细信息，请阅读下面的代码）：

private void LogRequest(IRestRequest request, IRestResponse response, long durationMs)
{
        var requestToLog = new
        {
            resource = request.Resource,
            // Parameters are custom anonymous objects in order to have the parameter type as a nice string
            // otherwise it will just show the enum value
            parameters = request.Parameters.Select(parameter => new
            {
                name = parameter.Name,
                value = parameter.Value,
                type = parameter.Type.ToString()
            }),
            // ToString() here to have the method as a nice string otherwise it will just show the enum value
            method = request.Method.ToString(),
            // This will generate the actual Uri used in the request
            uri = _restClient.BuildUri(request),
        };

        var responseToLog = new
        {
            statusCode = response.StatusCode,
            content = response.Content,
            headers = response.Headers,
            // The Uri that actually responded (could be different from the requestUri if a redirection occurred)
            responseUri = response.ResponseUri,
            errorMessage = response.ErrorMessage,
        };

        Trace.Write(string.Format("Request completed in {0} ms, Request: {1}, Response: {2}",
                durationMs, 
                JsonConvert.SerializeObject(requestToLog),
                JsonConvert.SerializeObject(responseToLog)));
}

注意事项：

• Headers、Url 段、QueryString 参数、body 等都被认为是 RestSharp 的参数，都出现在请求的参数集合中，具有对应的类型。
• 必须在请求发生后调用 log 方法。 由于 RestSharp 的工作方式，Execute 方法将添加标头，运行身份验证器（如果已配置）等，因此需要这样做，所有这些都将修改请求。 因此，为了记录所有发送的真实参数，应该在记录请求之前调用 Execute 方法。
• RestSharp 本身永远不会抛出（而是将错误保存在 response.ErrorException 属性中），但我认为反序列化可能会抛出（不确定），此外我需要记录原始响应，所以我选择实现我自己的反序列化。
• 请记住，RestSharp 在转换参数值以生成 Uri 时使用其自己的格式，因此序列化参数以记录它们可能不会显示与 Uri 中放置的完全相同的内容。 这就是为什么IRestClient.BuildUri方法获取实际调用的 Uri 非常酷（包括基本 url、替换的 url 段、添加的 queryString 参数等）。
• 编辑：还要记住，RestSharp 用于主体的序列化器可能与此代码使用的不一样，所以我猜可以调整代码以使用request.JsonSerializer.Serialize()来呈现主体参数（这个我没试过）。
• 需要一些自定义代码才能在日志中对枚举值进行很好的描述。
• StopWatch使用可以移动以在测量中包括反序列化。

这是一个基本的完整基类示例，带有日志记录（使用 NLog）：

using System;
using System.Diagnostics;
using System.Linq;
using NLog;
using Newtonsoft.Json;
using RestSharp;

namespace Apis
{
    public abstract class RestApiBase
    {
        protected readonly IRestClient _restClient;
        protected readonly ILogger _logger;

        protected RestApiBase(IRestClient restClient, ILogger logger)
        {
            _restClient = restClient;
            _logger = logger;
        }

        protected virtual IRestResponse Execute(IRestRequest request)
        {
            IRestResponse response = null;
            var stopWatch = new Stopwatch();

            try
            {
                stopWatch.Start();
                response = _restClient.Execute(request);
                stopWatch.Stop();

                // CUSTOM CODE: Do more stuff here if you need to...

                return response;
            }
            catch (Exception e)
            {
                // Handle exceptions in your CUSTOM CODE (restSharp will never throw itself)
            }
            finally
            {
                LogRequest(request, response, stopWatch.ElapsedMilliseconds);
            }

            return null;
        }

        protected virtual T Execute<T>(IRestRequest request) where T : new()
        {
            IRestResponse response = null;
            var stopWatch = new Stopwatch();

            try
            {
                stopWatch.Start();
                response = _restClient.Execute(request);
                stopWatch.Stop();

                // CUSTOM CODE: Do more stuff here if you need to...

                // We can't use RestSharp deserialization because it could throw, and we need a clean response
                // We need to implement our own deserialization.
                var returnType = JsonConvert.DeserializeObject<T>(response.Content);
                return returnType;
            }
            catch (Exception e)
            {
                // Handle exceptions in your CUSTOM CODE (restSharp will never throw itself)
                // Handle exceptions in deserialization
            }
            finally
            {
                LogRequest(request, response, stopWatch.ElapsedMilliseconds);
            }

            return default(T);
        }

        private void LogRequest(IRestRequest request, IRestResponse response, long durationMs)
        {
            _logger.Trace(() =>
            {
                var requestToLog = new
                {
                    resource = request.Resource,
                    // Parameters are custom anonymous objects in order to have the parameter type as a nice string
                    // otherwise it will just show the enum value
                    parameters = request.Parameters.Select(parameter => new
                    {
                        name = parameter.Name,
                        value = parameter.Value,
                        type = parameter.Type.ToString()
                    }),
                    // ToString() here to have the method as a nice string otherwise it will just show the enum value
                    method = request.Method.ToString(),
                    // This will generate the actual Uri used in the request
                    uri = _restClient.BuildUri(request),
                };

                var responseToLog = new
                {
                    statusCode = response.StatusCode,
                    content = response.Content,
                    headers = response.Headers,
                    // The Uri that actually responded (could be different from the requestUri if a redirection occurred)
                    responseUri = response.ResponseUri,
                    errorMessage = response.ErrorMessage,
                };

                return string.Format("Request completed in {0} ms, Request: {1}, Response: {2}",
                    durationMs, JsonConvert.SerializeObject(requestToLog),
                    JsonConvert.SerializeObject(responseToLog));
            });
        }
    }
}

这个类将记录如下内容（格式非常适合粘贴在这里）：

Request completed in 372 ms, Request : {
    "resource" : "/Event/Create/{hostId}/{startTime}",
    "parameters" : [{
            "name" : "hostId",
            "value" : "116644",
            "type" : "UrlSegment"
        }, {
            "name" : "startTime",
            "value" : "2016-05-18T19:48:58.9744911Z",
            "type" : "UrlSegment"
        }, {
            "name" : "application/json",
            "value" : "{\"durationMinutes\":720,\"seats\":100,\"title\":\"Hello StackOverflow!\"}",
            "type" : "RequestBody"
        }, {
            "name" : "api_key",
            "value" : "123456",
            "type" : "QueryString"
        }, {
            "name" : "Accept",
            "value" : "application/json, application/xml, text/json, text/x-json, text/javascript, text/xml",
            "type" : "HttpHeader"
        }
    ],
    "method" : "POST",
    "uri" : "http://127.0.0.1:8000/Event/Create/116644/2016-05-18T19%3A48%3A58.9744911Z?api_key=123456"
}, Response : {
    "statusCode" : 200,
    "content" : "{\"eventId\":2000045,\"hostId\":116644,\"scheduledLength\":720,\"seatsReserved\":100,\"startTime\":\"2016-05-18T19:48:58.973Z\"",
    "headers" : [{
            "Name" : "Access-Control-Allow-Origin",
            "Value" : "*",
            "Type" : 3
        }, {
            "Name" : "Access-Control-Allow-Methods",
            "Value" : "POST, GET, OPTIONS, PUT, DELETE, HEAD",
            "Type" : 3
        }, {
            "Name" : "Access-Control-Allow-Headers",
            "Value" : "X-PINGOTHER, Origin, X-Requested-With, Content-Type, Accept",
            "Type" : 3
        }, {
            "Name" : "Access-Control-Max-Age",
            "Value" : "1728000",
            "Type" : 3
        }, {
            "Name" : "Content-Length",
            "Value" : "1001",
            "Type" : 3
        }, {
            "Name" : "Content-Type",
            "Value" : "application/json",
            "Type" : 3
        }, {
            "Name" : "Date",
            "Value" : "Wed, 18 May 2016 17:44:16 GMT",
            "Type" : 3
        }
    ],
    "responseUri" : "http://127.0.0.1:8000/Event/Create/116644/2016-05-18T19%3A48%3A58.9744911Z?api_key=123456",
    "errorMessage" : null
}

希望你觉得这个有用！

Answer 2

.net 提供了自己但强大的日志记录功能。 这可以通过配置文件打开。

我在 这里找到了这个提示。 John Sheehan 指出如何：配置网络跟踪文章。 （注意：我编辑了提供的配置，关闭了不必要的（对我而言）低级日志记录）。

  <system.diagnostics>
    <sources>
      <source name="System.Net" tracemode="protocolonly" 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>
    </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>

Answer 3

我刚刚在 RestSharp 示例中找到了下面的代码。 它允许您打印原始响应。

client.ExecuteAsync(request, response =>
                   {
                       Console.WriteLine(response.Content);
                   });

Answer 4

您必须遍历request.Parameters列表并将其格式化为您喜欢的任何格式的字符串。

var sb = new StringBuilder();
foreach(var param in request.Parameters)
{
    sb.AppendFormat("{0}: {1}\r\n", param.Name, param.Value);
}
return sb.ToString();

如果您希望输出显示请求标头，然后显示类似于 Fiddler 的正文，则只需按请求标头然后按请求正文对集合进行排序。 集合中的Parameter对象有一个Type参数枚举。

Answer 5

您可以使用Fiddler来捕获 HTTP 请求。

Answer 6

一个选项是使用您自己的身份验证器。 RestSharp 允许注入身份验证器：

var client = new RestClient();
client.Authenticator = new YourAuthenticator(); // implements IAuthenticator

public interface IAuthenticator
{
    void Authenticate(IRestClient client, IRestRequest request);
}

internal class YourAuthenticator: IAuthenticator
{
  public void Authenticate(IRestClient client, IRestRequest request)
  {
    // log request
  }
}

身份验证器的 Authenticate 方法是在调用 RestClient.Execute 或 RestClient.Execute 时首先调用的方法。 将 Authenticate 方法传递给当前正在执行的 RestRequest，让您可以访问来自 RestSharp 维基的请求数据的每一部分（标头、参数等）

这意味着您可以在 Authenticate 方法中记录请求。

Answer 7

作为部分解决方案，您可以使用 RestClient 的BuildUri方法：

var response = client.Execute(request);
if (response.StatusCode != HttpStatusCode.OK)
    throw new Exception($"Failed to send request: {client.BuildUri(request)}");

Answer 8

如果您只想查看原始响应，请尝试覆盖反序列化器（大部分内容是从restsharp 107.3.0复制粘贴的）：

using RestSharp.Serializers;
// …
public class StupidLogSerialiser  : IRestSerializer, ISerializer, IDeserializer {
    public string Serialize(object obj) => null;
    public string Serialize(Parameter bodyParameter) => Serialize(null);
    public T Deserialize<T>(RestResponse response) {
        Console.WriteLine(response.Content);
        return default(T);
    }
    public string ContentType { get; set; } = "application/json";
    public ISerializer         Serializer           => this;
    public IDeserializer       Deserializer         => this;
    public DataFormat          DataFormat           => DataFormat.Json;
    public string[]            AcceptedContentTypes => RestSharp.Serializers.ContentType.JsonAccept;
    public SupportsContentType SupportsContentType  => contentType => contentType.EndsWith("json", StringComparison.InvariantCultureIgnoreCase);
}
// …
client.UseSerializer(() => new StupidLogSerialiser());

Answer 9

我知道这篇文章已经有将近 10 年的历史了，对此感到抱歉。 您现在可以在发送请求之前和收到响应之后指定委托。

这就是我实现这一特殊需求的方式。

public class TraceRequest : RestRequest
{

    #region Properties

    private bool TraceStreamContent { get; set; }

    #endregion

    #region Constructor

    public TraceRequest(string pResource, bool pTraceStreamContent)
        : base(pResource)
    {
        this.TraceStreamContent = pTraceStreamContent;
        this.InitializeLogs();
    }

    #endregion

    #region Methods

    private void InitializeLogs()
    {
        this.OnBeforeRequest = this.OnBeforeRequestMethod;
        this.OnAfterRequest = this.OnAfterRequestMethod;
    }

    private ValueTask OnBeforeRequestMethod(HttpRequestMessage pMessage)
    {
        var builder = new StringBuilder();

        builder.AppendLine("------------------------------");
        builder.AppendLine("REQUEST [{0}] {1}", pMessage.Method, pMessage.RequestUri);

        foreach (var header in pMessage.Headers)
        {
            builder.AppendLine("  {0}: {1}", header.Key, string.Join(';', header.Value));
        }

        if (this.TraceStreamContent)
        {
            var stream = pMessage.Content.ReadAsStream();

            this.ReadStream(stream, builder);
        }
        else
        {
            this.ReadContent(pMessage.Content, builder);
        }

        builder.AppendLine("------------------------------");

        var content = builder.ToString();

        Console.WriteLine(content);

        return ValueTask.CompletedTask;
    }

    private void ReadContent(HttpContent pContent, StringBuilder pBuilder)
    {
        foreach (var header in pContent.Headers)
        {
            pBuilder.AppendLine("  {0}: {1}", header.Key, string.Join(';', header.Value));
        }

        this.ReadContent(pContent as StreamContent, pBuilder);
        this.ReadContent(pContent as StringContent, pBuilder);
        this.ReadContent(pContent as MultipartFormDataContent, pBuilder);

        Console.WriteLine();
    }

    private void ReadContent(MultipartFormDataContent pContent, StringBuilder pBuilder)
    {
        if (pContent != null)
        {
            foreach (var content in pContent)
            {
                pBuilder.AppendLine();
                this.ReadContent(content, pBuilder);
            }
        }
    }

    private void ReadContent(StreamContent pContent, StringBuilder pBuilder)
    {
        if (pContent != null)
        {
            var stream = pContent.ReadAsStream();
            pBuilder.AppendLine("  contains {0} bytes", stream.Length);
        }
    }

    private void ReadContent(StringContent pContent, StringBuilder pBuilder)
    {
        if (pContent != null)
        {
            var stream = pContent.ReadAsStream();
            pBuilder.Append("  ");
            this.ReadStream(stream, pBuilder);
        }
    }

    private void ReadStream(Stream pStream, StringBuilder pBuilder)
    {
        var index = 0L;
        var length = pStream.Length;
        var buffer = new byte[1024];

        while (index < length - 1)
        {
            var read = pStream.Read(buffer, 0, 1024);
            var result = Encoding.UTF8.GetString(buffer, 0, read);

            pBuilder.Append(result);

            index += read;
        }

        pBuilder.AppendLine();

        pStream.Seek(0L, SeekOrigin.Begin);
    }

    private ValueTask OnAfterRequestMethod(HttpResponseMessage pMessage)
    {
        var builder = new StringBuilder();

        builder.AppendLine("------------------------------");
        builder.AppendLine("RESPONSE {2} [{0}] {1}", pMessage.RequestMessage.Method, pMessage.RequestMessage.RequestUri, pMessage.StatusCode);

        foreach (var header in pMessage.Headers)
        {
            builder.AppendLine("  {0}: {1}", header.Key, string.Join(';', header.Value));
        }

        if (this.TraceStreamContent)
        {
            var stream = pMessage.Content.ReadAsStream();

            this.ReadStream(stream, builder);
        }
        else
        {
            this.ReadContent(pMessage.Content, builder);
        }

        builder.AppendLine("------------------------------");

        var content = builder.ToString();

        Console.WriteLine(content);

        return ValueTask.CompletedTask;
    }

    #endregion
}

您现在可以像这样使用 class TraceRequest，boolean TraceStreamContent 将启用完整的 HTTP 跟踪。 发送附件中的文件时可能太大。

        var client = new RestClient("https://dev.test.cloud:4511")
        {
            Authenticator = new HttpBasicAuthenticator("user", "password")
        };
        var request = new TraceRequest("test", true)
            .AddJsonBody(fax)
            .AddFile("first", new byte[] { 65, 66, 67, 68 }, "first.txt")
            .AddFile("second", new byte[] { 69, 70, 71, 72 }, "second.txt");

        var response = client.Post(request);

希望这会帮助别人！

Answer 10

你可以尝试使用

Trace.WriteLine(request.JsonSerializer.Serialize(request));

获取请求和

response.Content(); // as Luo have suggested

request 不一样，如 Fiddler 所示，但它包含所有数据并且是可读的（最后有一些 RestSharp 垃圾）。