RestSharpは、未加工の要求および応答ヘッダーを出力します
RestSharp を使用して、Webサービスを呼び出しています。すべては順調ですが、送信された生の要求ヘッダーと本文、および生の応答ヘッダーと返された応答本文を印刷できるかどうか疑問に思いました。
これは、リクエストを作成してレスポンスを返すコードです
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;
}
だから、生の要求と応答を印刷することは可能でしょうか？
既に知っているように、RestSharpは、あなたが望むものを正確に実現するメカニズムを提供していません。
ロギング（デバッグ）の目的（たとえば、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)));
}
注意事項：
- ヘッダー、Urlセグメント、QueryStringパラメーター、本文などはすべて、RestSharpのパラメーターと見なされます。これらはすべて、要求のパラメーターコレクションに、対応するタイプとともに表示されます。
- ログメソッドは、要求が発生した後に呼び出す必要があります。これは、RestSharpの動作方法、Executeメソッドがヘッダーを追加し、オーセンティケーター（構成されている場合）を実行するなどのために必要であり、これらすべてが要求を変更します。したがって、送信されたすべての実際のパラメーターをログに記録するには、リクエストをログに記録する前にExecuteメソッドを呼び出す必要があります。
- RestSharp自体は決してスローしません（代わりにエラーがresponse.ErrorExceptionプロパティに保存されます）が、デシリアライゼーションはスローする可能性がある（確信できない）と思うので、生の応答をログに記録する必要があるため、独自のデシリアライゼーションを実装することにしました。
- RestSharpは、パラメーター値を変換してUriを生成するときに独自の書式設定を使用するため、パラメーターをシリアル化してそれらを記録すると、Uriに入力されたものとまったく同じものが表示されないことに注意してください。
IRestClient.BuildUriメソッド実際に呼び出されるUri（ベースURL、置換されたURLセグメント、追加されたqueryStringパラメーターなどを含む）を取得するのは非常にクールです。 - 編集：また、RestSharpが本体に使用しているシリアライザーが、このコードが使用しているものと同じではない可能性があることを念頭に置いて、コードを調整して
request.JsonSerializer.Serialize()bodyパラメーターのレンダリング（これは試していません）。 - 列挙値のログでニースの説明を実現するには、いくつかのカスタムコードが必要でした。
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
}
これがあなたの役に立つことを願っています！
.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>
RestSharpの例で次のコードを見つけました。生の応答を出力できます。
client.ExecuteAsync(request, response =>
{
Console.WriteLine(response.Content);
});
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パラメーター列挙型があります。
HTTP要求をキャプチャするために Fiddler を使用できます。
オプションは、独自の認証システムを使用することです。 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のwikiから
これは、Authenticateメソッドよりもリクエストを記録できることを意味します。
部分的な解決策として、RestClientのBuildUriメソッドを使用できます。
var response = client.Execute(request);
if (response.StatusCode != HttpStatusCode.OK)
throw new Exception($"Failed to send request: {client.BuildUri(request)}");